Lightmesh GraphQL API documentation
This is the GraphQL API documentation for Tidal Lightmesh.
API Endpoints
http://next.lightmesh.com/graphqlVersion
1.0.0
Lightmesh guides
Need more information? Visit the Lightmesh guides for additional help.
Queries
activities
Response
Returns an ActivityList
Example
Query
query Activities(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String
) {
activities(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir
) {
count
total
results {
userId
timestamp
operation
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "xyz789"
}
Response
{
"data": {
"activities": {
"count": 987,
"total": 123,
"results": [Activity]
}
}
}
address
Example
Query
query Address($id: Int!) {
address(id: $id) {
id
line1
line2
line3
line4
municipality
province
country
postalCode
}
}
Variables
{"id": 123}
Response
{
"data": {
"address": {
"id": 123,
"line1": "xyz789",
"line2": "xyz789",
"line3": "abc123",
"line4": "xyz789",
"municipality": "xyz789",
"province": "abc123",
"country": "abc123",
"postalCode": "abc123"
}
}
}
addresses
Response
Returns an AddressList
Example
Query
query Addresses(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String
) {
addresses(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type
) {
count
results {
id
line1
line2
line3
line4
municipality
province
country
postalCode
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"type": "xyz789"
}
Response
{
"data": {
"addresses": {"count": 987, "results": [Address]}
}
}
alert
Example
Query
query Alert($id: Int!) {
alert(id: $id) {
id
SubnetId
UserId
AlertRuleId
status
type
name
Subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
description
message
clearNotification
}
}
Variables
{"id": 987}
Response
{
"data": {
"alert": {
"id": 123,
"SubnetId": 123,
"UserId": 123,
"AlertRuleId": 987,
"status": "abc123",
"type": "xyz789",
"name": "xyz789",
"Subnet": Subnet,
"description": "xyz789",
"message": "abc123",
"clearNotification": false
}
}
}
alertDestination
Response
Returns an AlertDestination
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query AlertDestination($id: Int!) {
alertDestination(id: $id) {
name
id
type
URL
slackChannel
email
status
verificationCode
options
createdAt
}
}
Variables
{"id": 987}
Response
{
"data": {
"alertDestination": {
"name": "xyz789",
"id": 123,
"type": "abc123",
"URL": "xyz789",
"slackChannel": "xyz789",
"email": "abc123",
"status": "abc123",
"verificationCode": "xyz789",
"options": {},
"createdAt": "abc123"
}
}
}
alertDestinations
Response
Returns an AlertDestinationList
Example
Query
query AlertDestinations(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$filter: AlertDestinationFilter
) {
alertDestinations(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
filter: $filter
) {
count
total
results {
name
id
type
URL
slackChannel
email
status
verificationCode
options
createdAt
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "abc123",
"filter": AlertDestinationFilter
}
Response
{
"data": {
"alertDestinations": {
"count": 987,
"total": 987,
"results": [AlertDestination]
}
}
}
alertRecipient
Response
Returns an AlertRecipient
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query AlertRecipient($id: Int!) {
alertRecipient(id: $id) {
id
UserId
userName
AlertRuleId
rules {
id
SubnetId
ZoneId
networkAddress
status
type
name
description
conditions
subnet {
...SubnetFragment
}
AlertDestinations {
...AlertDestinationFragment
}
AlertRecipientId
AlertRecipients {
...AlertRecipientFragment
}
recipients {
...AlertRecipientFragment
}
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"alertRecipient": {
"id": 123,
"UserId": 123,
"userName": "abc123",
"AlertRuleId": 987,
"rules": [AlertRule]
}
}
}
alertRecipients
Response
Returns an AlertRecipientList
Example
Query
query AlertRecipients(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String
) {
alertRecipients(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type
) {
count
results {
id
UserId
userName
AlertRuleId
rules {
...AlertRuleFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"type": "xyz789"
}
Response
{
"data": {
"alertRecipients": {
"count": 987,
"results": [AlertRecipient]
}
}
}
alertRule
Example
Query
query AlertRule($id: Int!) {
alertRule(id: $id) {
id
SubnetId
ZoneId
networkAddress
status
type
name
description
conditions
subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
AlertDestinations {
name
id
type
URL
slackChannel
email
status
verificationCode
options
createdAt
}
AlertRecipientId
AlertRecipients {
id
UserId
userName
AlertRuleId
rules {
...AlertRuleFragment
}
}
recipients {
id
UserId
userName
AlertRuleId
rules {
...AlertRuleFragment
}
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"alertRule": {
"id": 123,
"SubnetId": 987,
"ZoneId": 123,
"networkAddress": "abc123",
"status": "abc123",
"type": "xyz789",
"name": "xyz789",
"description": "xyz789",
"conditions": {},
"subnet": Subnet,
"AlertDestinations": [AlertDestination],
"AlertRecipientId": 987,
"AlertRecipients": [AlertRecipient],
"recipients": [AlertRecipient]
}
}
}
alertRules
Response
Returns an AlertRuleList
Example
Query
query AlertRules(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String,
$SubnetId: Int
) {
alertRules(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type,
SubnetId: $SubnetId
) {
count
total
results {
id
SubnetId
ZoneId
networkAddress
status
type
name
description
conditions
subnet {
...SubnetFragment
}
AlertDestinations {
...AlertDestinationFragment
}
AlertRecipientId
AlertRecipients {
...AlertRecipientFragment
}
recipients {
...AlertRecipientFragment
}
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"type": "xyz789",
"SubnetId": 987
}
Response
{
"data": {
"alertRules": {
"count": 123,
"total": 987,
"results": [AlertRule]
}
}
}
alerts
Response
Returns an AlertList
Example
Query
query Alerts(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String,
$SubnetId: Int,
$filter: AlertFilter
) {
alerts(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type,
SubnetId: $SubnetId,
filter: $filter
) {
count
total
results {
id
SubnetId
UserId
AlertRuleId
status
type
name
Subnet {
...SubnetFragment
}
description
message
clearNotification
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"type": "xyz789",
"SubnetId": 987,
"filter": AlertFilter
}
Response
{
"data": {
"alerts": {
"count": 123,
"total": 123,
"results": [Alert]
}
}
}
apiKey
Example
Query
query ApiKey($id: Int!) {
apiKey(id: $id) {
id
apiKey
apiKeyExpiry
apiKeyName
}
}
Variables
{"id": 987}
Response
{
"data": {
"apiKey": {
"id": 987,
"apiKey": "abc123",
"apiKeyExpiry": "abc123",
"apiKeyName": "abc123"
}
}
}
apiKeys
Response
Returns an ApiKeyList
Example
Query
query ApiKeys(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String
) {
apiKeys(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir
) {
count
total
results {
id
apiKey
apiKeyExpiry
apiKeyName
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789"
}
Response
{
"data": {
"apiKeys": {
"count": 987,
"total": 987,
"results": [ApiKey]
}
}
}
availableIPAssignments
Response
Returns an IPAssignmentList
Example
Query
query AvailableIPAssignments(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnet_id: Int
) {
availableIPAssignments(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnet_id: $subnet_id
) {
count
total
results {
id
subnetId
networkAddress
description
ipAddressType
interface {
...InterfaceFragment
}
lastSeenAt
subnet {
...SubnetFragment
}
DNSEntries {
...DNSEntryFragment
}
resource {
...ResourceFragment
}
interfaces {
...InterfaceFragment
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
...NetworkRequestItemFragment
}
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"subnet_id": 987
}
Response
{
"data": {
"availableIPAssignments": {
"count": 123,
"total": 987,
"results": [IPAssignment]
}
}
}
availableSubnets
Response
Returns a NetworkAddressList
Example
Query
query AvailableSubnets(
$search: String,
$netmask: Int,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String
) {
availableSubnets(
search: $search,
netmask: $netmask,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir
) {
count
results {
networkAddress
}
}
}
Variables
{
"search": "xyz789",
"netmask": 987,
"limit": 987,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "abc123"
}
Response
{
"data": {
"availableSubnets": {
"count": 123,
"results": [NetworkAddress]
}
}
}
contact
Example
Query
query Contact($id: Int!) {
contact(id: $id) {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
id
name
description
contacts {
...ContactFragment
}
customAttributes
}
customAttributes
}
}
Variables
{"id": 987}
Response
{
"data": {
"contact": {
"id": 123,
"firstName": "abc123",
"lastName": "abc123",
"phone": "abc123",
"cellPhone": "abc123",
"email": "abc123",
"email2": "abc123",
"importBatchId": 123,
"SupportGroupId": 987,
"supportGroup": SupportGroup,
"customAttributes": {}
}
}
}
contactIpAddresses
Response
Returns an IPAddressList
Example
Query
query ContactIpAddresses(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnet_id: Int,
$available: Boolean,
$contiguous: Boolean,
$subnetName: String,
$subnet: String,
$contactId: Int
) {
contactIpAddresses(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnet_id: $subnet_id,
available: $available,
contiguous: $contiguous,
subnetName: $subnetName,
subnet: $subnet,
contactId: $contactId
) {
count
total
results {
id
networkAddress
ipAddressType
ipAssignment {
...IPAssignmentFragment
}
expirationDate
reservation {
...ReservationFragment
}
request {
...NetworkRequestItemFragment
}
scanResults {
...ScanResultFragment
}
inUse
subnet {
...SubnetFragment
}
zone {
...ZoneFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "xyz789",
"subnet_id": 123,
"available": false,
"contiguous": true,
"subnetName": "xyz789",
"subnet": "xyz789",
"contactId": 987
}
Response
{
"data": {
"contactIpAddresses": {
"count": 123,
"total": 123,
"results": [IPAddress]
}
}
}
contactSubnets
Response
Returns a SubnetList
Example
Query
query ContactSubnets(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$contactId: Int
) {
contactSubnets(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
contactId: $contactId
) {
count
total
results {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "abc123",
"contactId": 987
}
Response
{
"data": {
"contactSubnets": {
"count": 987,
"total": 987,
"results": [Subnet]
}
}
}
contactSubnetsResources
Response
Returns a ResourceList
Example
Query
query ContactSubnetsResources(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$contactId: Int
) {
contactSubnetsResources(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
contactId: $contactId
) {
count
total
results {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "abc123",
"contactId": 987
}
Response
{
"data": {
"contactSubnetsResources": {
"count": 123,
"total": 987,
"results": [Resource]
}
}
}
contacts
Response
Returns a ContactList
Example
Query
query Contacts(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$contactableId: Int,
$contactableType: String,
$importId: Int,
$filter: ContactFilter
) {
contacts(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
contactableId: $contactableId,
contactableType: $contactableType,
importId: $importId,
filter: $filter
) {
count
total
results {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "abc123",
"contactableId": 123,
"contactableType": "xyz789",
"importId": 123,
"filter": ContactFilter
}
Response
{
"data": {
"contacts": {
"count": 123,
"total": 123,
"results": [Contact]
}
}
}
customAttribute
Response
Returns a CustomAttribute
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query CustomAttribute($id: Int!) {
customAttribute(id: $id) {
id
modelName
name
type
required
sectionId
rowIndex
rowColSpan
colIndex
colSpan
component
}
}
Variables
{"id": 987}
Response
{
"data": {
"customAttribute": {
"id": 987,
"modelName": "xyz789",
"name": "xyz789",
"type": "abc123",
"required": true,
"sectionId": 987,
"rowIndex": 987,
"rowColSpan": 123,
"colIndex": 987,
"colSpan": 123,
"component": "abc123"
}
}
}
customAttributes
Response
Returns a CustomAttributeList
Example
Query
query CustomAttributes(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$modelName: String,
$filter: CustomAttributeFilter
) {
customAttributes(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
modelName: $modelName,
filter: $filter
) {
count
results {
id
modelName
name
type
required
sectionId
rowIndex
rowColSpan
colIndex
colSpan
component
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "abc123",
"modelName": "abc123",
"filter": CustomAttributeFilter
}
Response
{
"data": {
"customAttributes": {
"count": 987,
"results": [CustomAttribute]
}
}
}
customer
Example
Query
query Customer($id: Int!) {
customer(id: $id) {
id
name
importId
importBatchId
addresses {
id
line1
line2
line3
line4
municipality
province
country
postalCode
}
sites {
id
name
importBatchId
subnetId
addresses {
...AddressFragment
}
customAttributes
}
customAttributes
}
}
Variables
{"id": 123}
Response
{
"data": {
"customer": {
"id": 123,
"name": "abc123",
"importId": 987,
"importBatchId": 123,
"addresses": [Address],
"sites": [Site],
"customAttributes": {}
}
}
}
customerIpAddresses
Response
Returns an IPAddressList
Example
Query
query CustomerIpAddresses(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnet_id: Int,
$available: Boolean,
$contiguous: Boolean,
$subnetName: String,
$subnet: String,
$customerId: Int
) {
customerIpAddresses(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnet_id: $subnet_id,
available: $available,
contiguous: $contiguous,
subnetName: $subnetName,
subnet: $subnet,
customerId: $customerId
) {
count
total
results {
id
networkAddress
ipAddressType
ipAssignment {
...IPAssignmentFragment
}
expirationDate
reservation {
...ReservationFragment
}
request {
...NetworkRequestItemFragment
}
scanResults {
...ScanResultFragment
}
inUse
subnet {
...SubnetFragment
}
zone {
...ZoneFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "xyz789",
"subnet_id": 123,
"available": false,
"contiguous": false,
"subnetName": "abc123",
"subnet": "xyz789",
"customerId": 987
}
Response
{
"data": {
"customerIpAddresses": {
"count": 987,
"total": 987,
"results": [IPAddress]
}
}
}
customerSubnets
Response
Returns a SubnetList
Example
Query
query CustomerSubnets(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$customerId: Int
) {
customerSubnets(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
customerId: $customerId
) {
count
total
results {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "abc123",
"customerId": 987
}
Response
{
"data": {
"customerSubnets": {
"count": 987,
"total": 987,
"results": [Subnet]
}
}
}
customers
Response
Returns a CustomerList
Example
Query
query Customers(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnetId: Int,
$importId: Int,
$filter: CustomerFilter
) {
customers(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnetId: $subnetId,
importId: $importId,
filter: $filter
) {
count
total
results {
id
name
importId
importBatchId
addresses {
...AddressFragment
}
sites {
...SiteFragment
}
customAttributes
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"subnetId": 123,
"importId": 123,
"filter": CustomerFilter
}
Response
{
"data": {
"customers": {
"count": 987,
"total": 987,
"results": [Customer]
}
}
}
dataCenterIpAddresses
Response
Returns an IPAddressList
Example
Query
query DataCenterIpAddresses(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnet_id: Int,
$available: Boolean,
$contiguous: Boolean,
$subnetName: String,
$subnet: String,
$dataCenterId: Int
) {
dataCenterIpAddresses(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnet_id: $subnet_id,
available: $available,
contiguous: $contiguous,
subnetName: $subnetName,
subnet: $subnet,
dataCenterId: $dataCenterId
) {
count
total
results {
id
networkAddress
ipAddressType
ipAssignment {
...IPAssignmentFragment
}
expirationDate
reservation {
...ReservationFragment
}
request {
...NetworkRequestItemFragment
}
scanResults {
...ScanResultFragment
}
inUse
subnet {
...SubnetFragment
}
zone {
...ZoneFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "abc123",
"subnet_id": 123,
"available": false,
"contiguous": true,
"subnetName": "xyz789",
"subnet": "abc123",
"dataCenterId": 987
}
Response
{
"data": {
"dataCenterIpAddresses": {
"count": 987,
"total": 123,
"results": [IPAddress]
}
}
}
dataCenterSubnets
Response
Returns a SubnetList
Example
Query
query DataCenterSubnets(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$dataCenterId: Int
) {
dataCenterSubnets(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
dataCenterId: $dataCenterId
) {
count
total
results {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"dataCenterId": 123
}
Response
{
"data": {
"dataCenterSubnets": {
"count": 987,
"total": 987,
"results": [Subnet]
}
}
}
dataCenterSubnetsResources
Response
Returns a ResourceList
Example
Query
query DataCenterSubnetsResources(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$dataCenterId: Int
) {
dataCenterSubnetsResources(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
dataCenterId: $dataCenterId
) {
count
total
results {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "abc123",
"dataCenterId": 123
}
Response
{
"data": {
"dataCenterSubnetsResources": {
"count": 123,
"total": 987,
"results": [Resource]
}
}
}
dataCenterZones
Response
Returns a ZoneList
Example
Query
query DataCenterZones(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$providerId: Int,
$importId: Int,
$dataCenterId: Int
) {
dataCenterZones(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
providerId: $providerId,
importId: $importId,
dataCenterId: $dataCenterId
) {
count
total
results {
id
name
description
VRF
providerId
provider {
...ProviderFragment
}
parentZone {
...ZoneFragment
}
cloudResourceId
importBatchId
customAttributes
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"providerId": 123,
"importId": 123,
"dataCenterId": 123
}
Response
{
"data": {
"dataCenterZones": {
"count": 123,
"total": 987,
"results": [Zone]
}
}
}
dnsEntries
Response
Returns an DNSEntryList
Example
Query
query DnsEntries(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$filter: DNSEntryFilter
) {
dnsEntries(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
filter: $filter
) {
count
total
results {
id
name
ttl
recordClass
recordType
recordData
dnsZone {
...DNSZoneFragment
}
customAttributes
networkAddress
priority
status
IPAssignment {
...IPAssignmentFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"filter": DNSEntryFilter
}
Response
{
"data": {
"dnsEntries": {
"count": 987,
"total": 987,
"results": [DNSEntry]
}
}
}
dnsEntry
Example
Query
query DnsEntry($id: Int!) {
dnsEntry(id: $id) {
id
name
ttl
recordClass
recordType
recordData
dnsZone {
name
dnsServer {
...DNSServerFragment
}
}
customAttributes
networkAddress
priority
status
IPAssignment {
id
subnetId
networkAddress
description
ipAddressType
interface {
...InterfaceFragment
}
lastSeenAt
subnet {
...SubnetFragment
}
DNSEntries {
...DNSEntryFragment
}
resource {
...ResourceFragment
}
interfaces {
...InterfaceFragment
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
...NetworkRequestItemFragment
}
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"dnsEntry": {
"id": 987,
"name": "abc123",
"ttl": 987,
"recordClass": "abc123",
"recordType": "xyz789",
"recordData": "abc123",
"dnsZone": [DNSZone],
"customAttributes": {},
"networkAddress": "abc123",
"priority": 123,
"status": "abc123",
"IPAssignment": IPAssignment
}
}
}
identities
Response
Returns an IdentityResultList
Example
Query
query Identities(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String
) {
identities(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir
) {
count
total
results {
... on UserGroup {
...UserGroupFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123"
}
Response
{
"data": {
"identities": {
"count": 123,
"total": 123,
"results": [UserGroup]
}
}
}
import
Example
Query
query Import($id: Int!) {
import(id: $id) {
id
description
customer_count
contact_count
site_count
zone_count
subnet_count
ip_assignment_count
records {
id
type
display
value
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"import": {
"id": 123,
"description": "xyz789",
"customer_count": 123,
"contact_count": 987,
"site_count": 123,
"zone_count": 987,
"subnet_count": 123,
"ip_assignment_count": 123,
"records": [ImportRecord]
}
}
}
importStats
Example
Query
query ImportStats($id: Int!) {
importStats(id: $id) {
id
description
customer_count
contact_count
site_count
zone_count
subnet_count
ip_assignment_count
records {
id
type
display
value
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"importStats": {
"id": 123,
"description": "xyz789",
"customer_count": 123,
"contact_count": 987,
"site_count": 123,
"zone_count": 123,
"subnet_count": 123,
"ip_assignment_count": 123,
"records": [ImportRecord]
}
}
}
imports
Response
Returns an ImportList
Example
Query
query Imports(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String,
$filter: ImportFilter
) {
imports(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type,
filter: $filter
) {
count
results {
id
description
customer_count
contact_count
site_count
zone_count
subnet_count
ip_assignment_count
records {
...ImportRecordFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"type": "xyz789",
"filter": ImportFilter
}
Response
{"data": {"imports": {"count": 123, "results": [Import]}}}
interface
Example
Query
query Interface($id: Int!) {
interface(id: $id) {
id
name
macAddress
resource {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
ipAssignment {
id
subnetId
networkAddress
description
ipAddressType
interface {
...InterfaceFragment
}
lastSeenAt
subnet {
...SubnetFragment
}
DNSEntries {
...DNSEntryFragment
}
resource {
...ResourceFragment
}
interfaces {
...InterfaceFragment
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
...NetworkRequestItemFragment
}
}
cloudResourceId
}
}
Variables
{"id": 987}
Response
{
"data": {
"interface": {
"id": 123,
"name": "abc123",
"macAddress": "xyz789",
"resource": Resource,
"ipAssignment": IPAssignment,
"cloudResourceId": "xyz789"
}
}
}
interfaces
Response
Returns an InterfaceList
Example
Query
query Interfaces(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$filter: InterfaceFilter
) {
interfaces(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
filter: $filter
) {
count
results {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"filter": InterfaceFilter
}
Response
{
"data": {
"interfaces": {"count": 987, "results": [Interface]}
}
}
ipAddress
Example
Query
query IpAddress(
$networkAddress: String!,
$subnetId: Int!
) {
ipAddress(
networkAddress: $networkAddress,
subnetId: $subnetId
) {
id
networkAddress
ipAddressType
ipAssignment {
id
subnetId
networkAddress
description
ipAddressType
interface {
...InterfaceFragment
}
lastSeenAt
subnet {
...SubnetFragment
}
DNSEntries {
...DNSEntryFragment
}
resource {
...ResourceFragment
}
interfaces {
...InterfaceFragment
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
...NetworkRequestItemFragment
}
}
expirationDate
reservation {
id
name
description
color
ipAddresses {
...IPAddressFragment
}
subnetId
}
request {
id
status
zoneId
ipAddress
macAddress
interface
hostname
customAttributes
description
networkRequestId
networkRequest {
...NetworkRequestFragment
}
}
scanResults {
id
subnetId
zoneId
networkAddress
hostname
resourceType
macAddress
cloudResourceId
interface
scannedAt
ScanId
customAttributes
ignore
sourceType
sourceVersion
fileName
result
ipAssignmentId
}
inUse
subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
zone {
id
name
description
VRF
providerId
provider {
...ProviderFragment
}
parentZone {
...ZoneFragment
}
cloudResourceId
importBatchId
customAttributes
}
}
}
Variables
{
"networkAddress": "xyz789",
"subnetId": 123
}
Response
{
"data": {
"ipAddress": {
"id": 987,
"networkAddress": "xyz789",
"ipAddressType": "abc123",
"ipAssignment": IPAssignment,
"expirationDate": "xyz789",
"reservation": Reservation,
"request": NetworkRequestItem,
"scanResults": [ScanResult],
"inUse": true,
"subnet": Subnet,
"zone": Zone
}
}
}
ipAddresses
Response
Returns an IPAddressList
Example
Query
query IpAddresses(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnet_id: Int,
$available: Boolean,
$contiguous: Boolean,
$subnetName: String,
$subnet: String,
$filter: IPAddressFilter
) {
ipAddresses(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnet_id: $subnet_id,
available: $available,
contiguous: $contiguous,
subnetName: $subnetName,
subnet: $subnet,
filter: $filter
) {
count
total
results {
id
networkAddress
ipAddressType
ipAssignment {
...IPAssignmentFragment
}
expirationDate
reservation {
...ReservationFragment
}
request {
...NetworkRequestItemFragment
}
scanResults {
...ScanResultFragment
}
inUse
subnet {
...SubnetFragment
}
zone {
...ZoneFragment
}
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"subnet_id": 123,
"available": false,
"contiguous": false,
"subnetName": "xyz789",
"subnet": "xyz789",
"filter": IPAddressFilter
}
Response
{
"data": {
"ipAddresses": {
"count": 123,
"total": 987,
"results": [IPAddress]
}
}
}
ipAssignment
Response
Returns an IPAssignment
Example
Query
query IpAssignment(
$id: Int,
$subnetId: Int
) {
ipAssignment(
id: $id,
subnetId: $subnetId
) {
id
subnetId
networkAddress
description
ipAddressType
interface {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
lastSeenAt
subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
DNSEntries {
id
name
ttl
recordClass
recordType
recordData
dnsZone {
...DNSZoneFragment
}
customAttributes
networkAddress
priority
status
IPAssignment {
...IPAssignmentFragment
}
}
resource {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
interfaces {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
id
status
zoneId
ipAddress
macAddress
interface
hostname
customAttributes
description
networkRequestId
networkRequest {
...NetworkRequestFragment
}
}
}
}
Variables
{"id": 123, "subnetId": 987}
Response
{
"data": {
"ipAssignment": {
"id": 987,
"subnetId": 123,
"networkAddress": "xyz789",
"description": "abc123",
"ipAddressType": "xyz789",
"interface": Interface,
"lastSeenAt": "abc123",
"subnet": Subnet,
"DNSEntries": [DNSEntry],
"resource": Resource,
"interfaces": [Interface],
"cloudResourceId": "abc123",
"createdAt": "abc123",
"importBatchId": 987,
"customAttributes": {},
"request": NetworkRequestItem
}
}
}
ipAssignments
Response
Returns an IPAssignmentList
Example
Query
query IpAssignments(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnet_id: Int,
$importId: Int,
$subnet: String,
$zoneName: String,
$filter: IPAssignmentFilter
) {
ipAssignments(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnet_id: $subnet_id,
importId: $importId,
subnet: $subnet,
zoneName: $zoneName,
filter: $filter
) {
count
total
results {
id
subnetId
networkAddress
description
ipAddressType
interface {
...InterfaceFragment
}
lastSeenAt
subnet {
...SubnetFragment
}
DNSEntries {
...DNSEntryFragment
}
resource {
...ResourceFragment
}
interfaces {
...InterfaceFragment
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
...NetworkRequestItemFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"subnet_id": 987,
"importId": 987,
"subnet": "abc123",
"zoneName": "abc123",
"filter": IPAssignmentFilter
}
Response
{
"data": {
"ipAssignments": {
"count": 987,
"total": 987,
"results": [IPAssignment]
}
}
}
location
locations
Response
Returns a LocationList
Example
Query
query Locations(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String
) {
locations(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type
) {
count
results {
id
name
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "abc123",
"type": "abc123"
}
Response
{
"data": {
"locations": {"count": 987, "results": [Location]}
}
}
nat
Example
Query
query Nat($id: Int!) {
nat(id: $id) {
id
sourceNatAddress
destinationNatAddress
natType
sourcePort
sourceNatZoneId
destinationPort
destinationNatZoneId
sourceType
destinationType
subnetId
}
}
Variables
{"id": 987}
Response
{
"data": {
"nat": {
"id": 123,
"sourceNatAddress": "xyz789",
"destinationNatAddress": ["abc123"],
"natType": "abc123",
"sourcePort": 123,
"sourceNatZoneId": 123,
"destinationPort": 987,
"destinationNatZoneId": 123,
"sourceType": "xyz789",
"destinationType": "xyz789",
"subnetId": 987
}
}
}
nats
Response
Returns a NATList
Example
Query
query Nats(
$destinationNatZoneId: Int,
$sourceNatZoneId: Int,
$subnetId: Int,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$filter: NATFilter
) {
nats(
destinationNatZoneId: $destinationNatZoneId,
sourceNatZoneId: $sourceNatZoneId,
subnetId: $subnetId,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
filter: $filter
) {
count
results {
id
sourceNatAddress
destinationNatAddress
natType
sourcePort
sourceNatZoneId
destinationPort
destinationNatZoneId
sourceType
destinationType
subnetId
}
}
}
Variables
{
"destinationNatZoneId": 123,
"sourceNatZoneId": 987,
"subnetId": 123,
"limit": 123,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"filter": NATFilter
}
Response
{"data": {"nats": {"count": 987, "results": [NAT]}}}
networkRequest
Response
Returns a NetworkRequest
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query NetworkRequest($id: Int!) {
networkRequest(id: $id) {
id
status
ipAddressCount
details
networkAddress
zoneId
subnetId
NetworkRequestItems {
id
status
zoneId
ipAddress
macAddress
interface
hostname
customAttributes
description
networkRequestId
networkRequest {
...NetworkRequestFragment
}
}
createdAt
}
}
Variables
{"id": 987}
Response
{
"data": {
"networkRequest": {
"id": 123,
"status": "xyz789",
"ipAddressCount": 987,
"details": "abc123",
"networkAddress": "abc123",
"zoneId": "abc123",
"subnetId": 123,
"NetworkRequestItems": [NetworkRequestItem],
"createdAt": "xyz789"
}
}
}
networkRequests
Response
Returns a NetworkRequestList
Example
Query
query NetworkRequests(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String,
$subnetId: Int,
$status: String,
$filter: NetworkRequestFilter
) {
networkRequests(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type,
subnetId: $subnetId,
status: $status,
filter: $filter
) {
count
results {
id
status
ipAddressCount
details
networkAddress
zoneId
subnetId
NetworkRequestItems {
...NetworkRequestItemFragment
}
createdAt
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"type": "xyz789",
"subnetId": 987,
"status": "xyz789",
"filter": NetworkRequestFilter
}
Response
{
"data": {
"networkRequests": {
"count": 987,
"results": [NetworkRequest]
}
}
}
networkSearch
Response
Returns a NetworkResultList
Example
Query
query NetworkSearch(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String
) {
networkSearch(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir
) {
count
total
results {
... on Subnet {
...SubnetFragment
}
... on IPAssignment {
...IPAssignmentFragment
}
... on Resource {
...ResourceFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "xyz789"
}
Response
{
"data": {
"networkSearch": {
"count": 987,
"total": 987,
"results": [Subnet]
}
}
}
nextAvailableSubnet
Response
Returns a NetworkAddress
Example
Query
query NextAvailableSubnet(
$subnetId: Int,
$netmask: Int
) {
nextAvailableSubnet(
subnetId: $subnetId,
netmask: $netmask
) {
networkAddress
}
}
Variables
{"subnetId": 123, "netmask": 987}
Response
{
"data": {
"nextAvailableSubnet": {
"networkAddress": "abc123"
}
}
}
provider
Example
Query
query Provider($id: Int!) {
provider(id: $id) {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
}
Variables
{"id": 123}
Response
{
"data": {
"provider": {
"id": 123,
"name": "xyz789",
"active": false,
"type": "abc123",
"azureAppId": "xyz789",
"azurePassword": "xyz789",
"azureTenantId": "abc123",
"awsAccessKeyId": "xyz789",
"awsSecretAccessKey": "abc123",
"awsSessionToken": "abc123",
"lastSynchronizedAt": "abc123",
"syncStatus": "abc123",
"syncError": "xyz789",
"subnetCount": 987,
"ipCount": 123,
"resourceCount": 123,
"createdAt": "xyz789",
"customAttributes": {}
}
}
}
providers
Response
Returns a ProviderList
Example
Query
query Providers(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String,
$filter: ProviderFilter
) {
providers(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type,
filter: $filter
) {
count
total
results {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"type": "abc123",
"filter": ProviderFilter
}
Response
{
"data": {
"providers": {
"count": 123,
"total": 987,
"results": [Provider]
}
}
}
reservation
Response
Returns a Reservation
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query Reservation($id: Int!) {
reservation(id: $id) {
id
name
description
color
ipAddresses {
id
networkAddress
ipAddressType
ipAssignment {
...IPAssignmentFragment
}
expirationDate
reservation {
...ReservationFragment
}
request {
...NetworkRequestItemFragment
}
scanResults {
...ScanResultFragment
}
inUse
subnet {
...SubnetFragment
}
zone {
...ZoneFragment
}
}
subnetId
}
}
Variables
{"id": 123}
Response
{
"data": {
"reservation": {
"id": 987,
"name": "xyz789",
"description": "xyz789",
"color": "abc123",
"ipAddresses": [IPAddress],
"subnetId": 987
}
}
}
reservations
Response
Returns a ReservationList
Example
Query
query Reservations(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnet_id: Int,
$filter: ReservationFilter
) {
reservations(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnet_id: $subnet_id,
filter: $filter
) {
count
results {
id
name
description
color
ipAddresses {
...IPAddressFragment
}
subnetId
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "abc123",
"subnet_id": 987,
"filter": ReservationFilter
}
Response
{
"data": {
"reservations": {
"count": 987,
"results": [Reservation]
}
}
}
resource
Example
Query
query Resource($id: Int!) {
resource(id: $id) {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
lastSeenAt
ResourceStatus {
id
name
}
resourceType {
id
name
}
interfaces {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
createdAt
}
}
Variables
{"id": 123}
Response
{
"data": {
"resource": {
"id": 123,
"hostname": "xyz789",
"OS": "abc123",
"OSVersion": "xyz789",
"macAddress": "abc123",
"cloudResourceId": "xyz789",
"resourceGroupId": "xyz789",
"resourceTypeId": 123,
"provider": Provider,
"lastSeenAt": "xyz789",
"ResourceStatus": ResourceStatus,
"resourceType": ResourceType,
"interfaces": [Interface],
"createdAt": "abc123"
}
}
}
resourceStatus
Response
Returns a ResourceStatus
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query ResourceStatus($id: Int!) {
resourceStatus(id: $id) {
id
name
}
}
Variables
{"id": 123}
Response
{
"data": {
"resourceStatus": {
"id": 123,
"name": "abc123"
}
}
}
resourceStatuses
Response
Returns a ResourceStatusList
Example
Query
query ResourceStatuses(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String,
$filter: ResourceStatusFilter
) {
resourceStatuses(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type,
filter: $filter
) {
count
results {
id
name
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "abc123",
"type": "xyz789",
"filter": ResourceStatusFilter
}
Response
{
"data": {
"resourceStatuses": {
"count": 987,
"results": [ResourceStatus]
}
}
}
resourceType
Response
Returns a ResourceType
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query ResourceType($id: Int!) {
resourceType(id: $id) {
id
name
}
}
Variables
{"id": 987}
Response
{
"data": {
"resourceType": {
"id": 123,
"name": "xyz789"
}
}
}
resourceTypes
Response
Returns a ResourceTypeList
Example
Query
query ResourceTypes(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String,
$filter: ResourceTypeFilter
) {
resourceTypes(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type,
filter: $filter
) {
count
results {
id
name
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"type": "xyz789",
"filter": ResourceTypeFilter
}
Response
{
"data": {
"resourceTypes": {
"count": 987,
"results": [ResourceType]
}
}
}
resources
Response
Returns a ResourceList
Example
Query
query Resources(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnetId: Int,
$filter: ResourceFilter
) {
resources(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnetId: $subnetId,
filter: $filter
) {
count
total
results {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"subnetId": 987,
"filter": ResourceFilter
}
Response
{
"data": {
"resources": {
"count": 987,
"total": 123,
"results": [Resource]
}
}
}
returningUsersByMonth
Response
Returns [ReturningUsersByMonth]
Example
Query
query ReturningUsersByMonth {
returningUsersByMonth {
value
label
}
}
Response
{
"data": {
"returningUsersByMonth": [
{"value": 987, "label": "abc123"}
]
}
}
role
Example
Query
query Role($id: Int!) {
role(id: $id) {
id
name
description
plans {
id
name
projectId
description
subnets {
...SubnetFragment
}
plannedChanges {
...PlannedChangeFragment
}
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"role": {
"id": 123,
"name": "abc123",
"description": "abc123",
"plans": [Plan]
}
}
}
roleAssignment
Response
Returns a RoleAssignment
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query RoleAssignment($id: Int!) {
roleAssignment(id: $id) {
id
subjectId
subjectType
recordId
recordType
networkAddress
zoneId
userGroup {
id
name
description
}
role {
id
name
description
plans {
...PlanFragment
}
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"roleAssignment": {
"id": 987,
"subjectId": 987,
"subjectType": "abc123",
"recordId": "abc123",
"recordType": "abc123",
"networkAddress": "abc123",
"zoneId": 123,
"userGroup": UserGroup,
"role": Role
}
}
}
roleAssignments
Response
Returns a RoleAssignmentList
Example
Query
query RoleAssignments(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$recordType: String,
$recordId: Int,
$filter: RoleAssignmentFilter
) {
roleAssignments(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
recordType: $recordType,
recordId: $recordId,
filter: $filter
) {
count
total
results {
id
subjectId
subjectType
recordId
recordType
networkAddress
zoneId
userGroup {
...UserGroupFragment
}
role {
...RoleFragment
}
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "abc123",
"recordType": "abc123",
"recordId": 123,
"filter": RoleAssignmentFilter
}
Response
{
"data": {
"roleAssignments": {
"count": 987,
"total": 123,
"results": [RoleAssignment]
}
}
}
roles
Response
Returns a RoleList
Example
Query
query Roles(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String,
$filter: RoleFilter
) {
roles(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type,
filter: $filter
) {
count
results {
id
name
description
plans {
...PlanFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"type": "xyz789",
"filter": RoleFilter
}
Response
{"data": {"roles": {"count": 123, "results": [Role]}}}
scan
Example
Query
query Scan(
$networkAddress: String!,
$zoneId: Int
) {
scan(
networkAddress: $networkAddress,
zoneId: $zoneId
) {
id
subnetId
zoneId
networkAddress
hostname
macAddress
interface
scannedAt
scanCommand
customAttributes
ignore
sourceType
sourceVersion
fileName
result
userId
}
}
Variables
{"networkAddress": "abc123", "zoneId": 987}
Response
{
"data": {
"scan": {
"id": 123,
"subnetId": 123,
"zoneId": 987,
"networkAddress": "abc123",
"hostname": "xyz789",
"macAddress": "abc123",
"interface": "abc123",
"scannedAt": "2007-12-03",
"scanCommand": "xyz789",
"customAttributes": {},
"ignore": true,
"sourceType": "abc123",
"sourceVersion": "xyz789",
"fileName": "abc123",
"result": "abc123",
"userId": 987
}
}
}
scanResult
Response
Returns a ScanResult
Example
Query
query ScanResult(
$networkAddress: String!,
$zoneId: Int
) {
scanResult(
networkAddress: $networkAddress,
zoneId: $zoneId
) {
id
subnetId
zoneId
networkAddress
hostname
resourceType
macAddress
cloudResourceId
interface
scannedAt
ScanId
customAttributes
ignore
sourceType
sourceVersion
fileName
result
ipAssignmentId
}
}
Variables
{"networkAddress": "abc123", "zoneId": 123}
Response
{
"data": {
"scanResult": {
"id": 987,
"subnetId": 123,
"zoneId": 123,
"networkAddress": "xyz789",
"hostname": "xyz789",
"resourceType": "xyz789",
"macAddress": "xyz789",
"cloudResourceId": "xyz789",
"interface": "xyz789",
"scannedAt": "2007-12-03",
"ScanId": 123,
"customAttributes": {},
"ignore": true,
"sourceType": "xyz789",
"sourceVersion": "abc123",
"fileName": "abc123",
"result": "xyz789",
"ipAssignmentId": 123
}
}
}
scanResults
Response
Returns a ScanResultList
Example
Query
query ScanResults(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$networkAddress: String,
$zoneId: Int,
$subnetId: Int,
$filter: ScanResultFilter
) {
scanResults(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
networkAddress: $networkAddress,
zoneId: $zoneId,
subnetId: $subnetId,
filter: $filter
) {
count
total
results {
id
subnetId
zoneId
networkAddress
hostname
resourceType
macAddress
cloudResourceId
interface
scannedAt
ScanId
customAttributes
ignore
sourceType
sourceVersion
fileName
result
ipAssignmentId
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "abc123",
"networkAddress": "abc123",
"zoneId": 123,
"subnetId": 123,
"filter": ScanResultFilter
}
Response
{
"data": {
"scanResults": {
"count": 123,
"total": 987,
"results": [ScanResult]
}
}
}
scans
Response
Returns a ScanList
Example
Query
query Scans(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$networkAddress: String,
$zoneId: Int,
$subnetId: Int,
$filter: ScanFilter
) {
scans(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
networkAddress: $networkAddress,
zoneId: $zoneId,
subnetId: $subnetId,
filter: $filter
) {
count
total
results {
id
subnetId
zoneId
networkAddress
hostname
macAddress
interface
scannedAt
scanCommand
customAttributes
ignore
sourceType
sourceVersion
fileName
result
userId
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"networkAddress": "xyz789",
"zoneId": 987,
"subnetId": 123,
"filter": ScanFilter
}
Response
{
"data": {
"scans": {
"count": 987,
"total": 987,
"results": [Scan]
}
}
}
site
Example
Query
query Site($id: Int!) {
site(id: $id) {
id
name
importBatchId
subnetId
addresses {
id
line1
line2
line3
line4
municipality
province
country
postalCode
}
customAttributes
}
}
Variables
{"id": 987}
Response
{
"data": {
"site": {
"id": 123,
"name": "xyz789",
"importBatchId": 123,
"subnetId": 123,
"addresses": [Address],
"customAttributes": {}
}
}
}
siteIpAddresses
Response
Returns an IPAddressList
Example
Query
query SiteIpAddresses(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnet_id: Int,
$available: Boolean,
$contiguous: Boolean,
$subnetName: String,
$subnet: String,
$siteId: Int
) {
siteIpAddresses(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnet_id: $subnet_id,
available: $available,
contiguous: $contiguous,
subnetName: $subnetName,
subnet: $subnet,
siteId: $siteId
) {
count
total
results {
id
networkAddress
ipAddressType
ipAssignment {
...IPAssignmentFragment
}
expirationDate
reservation {
...ReservationFragment
}
request {
...NetworkRequestItemFragment
}
scanResults {
...ScanResultFragment
}
inUse
subnet {
...SubnetFragment
}
zone {
...ZoneFragment
}
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"subnet_id": 123,
"available": false,
"contiguous": false,
"subnetName": "xyz789",
"subnet": "xyz789",
"siteId": 123
}
Response
{
"data": {
"siteIpAddresses": {
"count": 987,
"total": 987,
"results": [IPAddress]
}
}
}
siteSubnets
Response
Returns a SubnetList
Example
Query
query SiteSubnets(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$siteId: Int
) {
siteSubnets(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
siteId: $siteId
) {
count
total
results {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"siteId": 987
}
Response
{
"data": {
"siteSubnets": {
"count": 123,
"total": 987,
"results": [Subnet]
}
}
}
siteSubnetsResources
Response
Returns a ResourceList
Example
Query
query SiteSubnetsResources(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$siteId: Int
) {
siteSubnetsResources(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
siteId: $siteId
) {
count
total
results {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"siteId": 123
}
Response
{
"data": {
"siteSubnetsResources": {
"count": 123,
"total": 123,
"results": [Resource]
}
}
}
sites
Response
Returns a SiteList
Example
Query
query Sites(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$type: String,
$importId: Int,
$filter: SiteFilter
) {
sites(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
type: $type,
importId: $importId,
filter: $filter
) {
count
total
results {
id
name
importBatchId
subnetId
addresses {
...AddressFragment
}
customAttributes
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "abc123",
"type": "xyz789",
"importId": 987,
"filter": SiteFilter
}
Response
{
"data": {
"sites": {
"count": 123,
"total": 987,
"results": [Site]
}
}
}
subnet
Example
Query
query Subnet($id: Int!) {
subnet(id: $id) {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
id
name
description
VRF
providerId
provider {
...ProviderFragment
}
parentZone {
...ZoneFragment
}
cloudResourceId
importBatchId
customAttributes
}
provider {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
vlan {
id
number
}
pollable
broadcast
customers {
id
name
importId
importBatchId
addresses {
...AddressFragment
}
sites {
...SiteFragment
}
customAttributes
}
Contacts {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
site {
id
name
importBatchId
subnetId
addresses {
...AddressFragment
}
customAttributes
}
supportGroups {
id
name
description
contacts {
...ContactFragment
}
customAttributes
}
subnets {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
supernet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
id
sourceNatAddress
destinationNatAddress
natType
sourcePort
sourceNatZoneId
destinationPort
destinationNatZoneId
sourceType
destinationType
subnetId
}
customAttributes
inUse
}
}
Variables
{"id": 123}
Response
{
"data": {
"subnet": {
"id": 987,
"status": "abc123",
"planId": 123,
"name": "xyz789",
"description": "xyz789",
"direction": "abc123",
"networkAddress": "xyz789",
"host": "abc123",
"defaultGatewayId": 987,
"supernetId": 987,
"defaultGateway": "xyz789",
"zone": Zone,
"provider": Provider,
"vlan": VLAN,
"pollable": false,
"broadcast": "xyz789",
"customers": [Customer],
"Contacts": [Contact],
"site": Site,
"supportGroups": [SupportGroup],
"subnets": [Subnet],
"supernet": Subnet,
"syncStatus": "abc123",
"lastSynchronizedAt": "abc123",
"syncError": "abc123",
"cloudResourceId": "xyz789",
"importBatchId": 987,
"nat": [NAT],
"customAttributes": {},
"inUse": 987
}
}
}
subnetSupportGroupContacts
Response
Returns a ContactList
Example
Query
query SubnetSupportGroupContacts(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnetId: Int,
$contactableId: Int,
$contactableType: String
) {
subnetSupportGroupContacts(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnetId: $subnetId,
contactableId: $contactableId,
contactableType: $contactableType
) {
count
total
results {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"subnetId": 987,
"contactableId": 123,
"contactableType": "abc123"
}
Response
{
"data": {
"subnetSupportGroupContacts": {
"count": 987,
"total": 123,
"results": [Contact]
}
}
}
subnets
Response
Returns a SubnetList
Example
Query
query Subnets(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$supernetId: Int,
$importId: Int,
$zoneName: String,
$topLevelOnly: Boolean,
$filter: SubnetFilter
) {
subnets(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
supernetId: $supernetId,
importId: $importId,
zoneName: $zoneName,
topLevelOnly: $topLevelOnly,
filter: $filter
) {
count
total
results {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"supernetId": 123,
"importId": 123,
"zoneName": "xyz789",
"topLevelOnly": true,
"filter": SubnetFilter
}
Response
{
"data": {
"subnets": {
"count": 123,
"total": 987,
"results": [Subnet]
}
}
}
subnetsResources
Response
Returns a ResourceList
Example
Query
query SubnetsResources(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$customerId: Int
) {
subnetsResources(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
customerId: $customerId
) {
count
total
results {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"customerId": 123
}
Response
{
"data": {
"subnetsResources": {
"count": 123,
"total": 987,
"results": [Resource]
}
}
}
supportGroup
Response
Returns a SupportGroup
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query SupportGroup($id: Int!) {
supportGroup(id: $id) {
id
name
description
contacts {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
customAttributes
}
}
Variables
{"id": 987}
Response
{
"data": {
"supportGroup": {
"id": 123,
"name": "abc123",
"description": "xyz789",
"contacts": [Contact],
"customAttributes": {}
}
}
}
supportGroupContacts
Response
Returns a ContactList
Example
Query
query SupportGroupContacts(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnetId: Int,
$supportGroupId: Int
) {
supportGroupContacts(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnetId: $subnetId,
supportGroupId: $supportGroupId
) {
count
total
results {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"subnetId": 123,
"supportGroupId": 987
}
Response
{
"data": {
"supportGroupContacts": {
"count": 987,
"total": 987,
"results": [Contact]
}
}
}
supportGroupIpAddresses
Response
Returns an IPAddressList
Example
Query
query SupportGroupIpAddresses(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnet_id: Int,
$available: Boolean,
$contiguous: Boolean,
$subnetName: String,
$subnet: String,
$supportGroupId: Int
) {
supportGroupIpAddresses(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnet_id: $subnet_id,
available: $available,
contiguous: $contiguous,
subnetName: $subnetName,
subnet: $subnet,
supportGroupId: $supportGroupId
) {
count
total
results {
id
networkAddress
ipAddressType
ipAssignment {
...IPAssignmentFragment
}
expirationDate
reservation {
...ReservationFragment
}
request {
...NetworkRequestItemFragment
}
scanResults {
...ScanResultFragment
}
inUse
subnet {
...SubnetFragment
}
zone {
...ZoneFragment
}
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"subnet_id": 987,
"available": false,
"contiguous": false,
"subnetName": "xyz789",
"subnet": "xyz789",
"supportGroupId": 987
}
Response
{
"data": {
"supportGroupIpAddresses": {
"count": 123,
"total": 987,
"results": [IPAddress]
}
}
}
supportGroupSubnets
Response
Returns a SubnetList
Example
Query
query SupportGroupSubnets(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$supportGroupId: Int
) {
supportGroupSubnets(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
supportGroupId: $supportGroupId
) {
count
total
results {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"supportGroupId": 987
}
Response
{
"data": {
"supportGroupSubnets": {
"count": 987,
"total": 987,
"results": [Subnet]
}
}
}
supportGroupSubnetsResources
Response
Returns a ResourceList
Example
Query
query SupportGroupSubnetsResources(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$supportGroupId: Int
) {
supportGroupSubnetsResources(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
supportGroupId: $supportGroupId
) {
count
total
results {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"supportGroupId": 123
}
Response
{
"data": {
"supportGroupSubnetsResources": {
"count": 987,
"total": 123,
"results": [Resource]
}
}
}
supportGroups
Response
Returns a SupportGroupList
Example
Query
query SupportGroups(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnetId: Int,
$filter: SupportGroupFilter
) {
supportGroups(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnetId: $subnetId,
filter: $filter
) {
count
total
results {
id
name
description
contacts {
...ContactFragment
}
customAttributes
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "abc123",
"subnetId": 987,
"filter": SupportGroupFilter
}
Response
{
"data": {
"supportGroups": {
"count": 123,
"total": 123,
"results": [SupportGroup]
}
}
}
supportTicket
Response
Returns a SupportTicket
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query SupportTicket($id: Int!) {
supportTicket(id: $id) {
id
UserId
message
}
}
Variables
{"id": 123}
Response
{
"data": {
"supportTicket": {
"id": 123,
"UserId": 123,
"message": "xyz789"
}
}
}
supportTickets
Response
Returns a SupportTicketList
Example
Query
query SupportTickets(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$filter: SupportTicketFilter
) {
supportTickets(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
filter: $filter
) {
count
total
results {
id
UserId
message
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "abc123",
"filter": SupportTicketFilter
}
Response
{
"data": {
"supportTickets": {
"count": 123,
"total": 987,
"results": [SupportTicket]
}
}
}
userCommunicationVersions
Response
Returns a UserCommunicationVersionList
Example
Query
query UserCommunicationVersions(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$filter: UserCommunicationVersionFilter
) {
userCommunicationVersions(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
filter: $filter
) {
count
total
results {
id
UserCommunicationId
open
send
bounce
emailBody
schedule
createdAt
UserCommunication {
...UserCommunicationFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"filter": UserCommunicationVersionFilter
}
Response
{
"data": {
"userCommunicationVersions": {
"count": 123,
"total": 123,
"results": [UserCommunicationVersion]
}
}
}
userCommunications
Response
Returns a UserCommunicationList
Example
Query
query UserCommunications(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$filter: UserCommunicationFilter
) {
userCommunications(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
filter: $filter
) {
count
total
results {
id
name
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"filter": UserCommunicationFilter
}
Response
{
"data": {
"userCommunications": {
"count": 987,
"total": 987,
"results": [UserCommunication]
}
}
}
userGroup
userGroups
Response
Returns a UserGroupList
Example
Query
query UserGroups(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnetId: Int,
$filter: UserGroupFilter
) {
userGroups(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnetId: $subnetId,
filter: $filter
) {
count
total
results {
id
name
description
}
}
}
Variables
{
"search": "abc123",
"limit": 987,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "abc123",
"subnetId": 987,
"filter": UserGroupFilter
}
Response
{
"data": {
"userGroups": {
"count": 987,
"total": 987,
"results": [UserGroup]
}
}
}
userOrganizations
Response
Returns a UserOrganizationList
Example
Query
query UserOrganizations(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$filter: UserOrganizationFilter
) {
userOrganizations(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
filter: $filter
) {
count
results {
id
role
email
firstName
lastName
admin
UserId
OrganizationId
}
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"offset": 123,
"sort_by": "abc123",
"sort_dir": "abc123",
"filter": UserOrganizationFilter
}
Response
{
"data": {
"userOrganizations": {
"count": 123,
"results": [UserOrganization]
}
}
}
vlan
vlans
Response
Returns an VLANList
Example
Query
query Vlans(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$filter: VLANFilter
) {
vlans(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
filter: $filter
) {
count
results {
id
number
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "abc123",
"filter": VLANFilter
}
Response
{"data": {"vlans": {"count": 123, "results": [VLAN]}}}
zone
Example
Query
query Zone($id: Int!) {
zone(id: $id) {
id
name
description
VRF
providerId
provider {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
parentZone {
id
name
description
VRF
providerId
provider {
...ProviderFragment
}
parentZone {
...ZoneFragment
}
cloudResourceId
importBatchId
customAttributes
}
cloudResourceId
importBatchId
customAttributes
}
}
Variables
{"id": 123}
Response
{
"data": {
"zone": {
"id": 987,
"name": "abc123",
"description": "abc123",
"VRF": "xyz789",
"providerId": 123,
"provider": Provider,
"parentZone": [Zone],
"cloudResourceId": "abc123",
"importBatchId": 123,
"customAttributes": {}
}
}
}
zoneIpAddresses
Response
Returns an IPAddressList
Example
Query
query ZoneIpAddresses(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$subnet_id: Int,
$available: Boolean,
$contiguous: Boolean,
$subnetName: String,
$subnet: String,
$zoneId: Int
) {
zoneIpAddresses(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
subnet_id: $subnet_id,
available: $available,
contiguous: $contiguous,
subnetName: $subnetName,
subnet: $subnet,
zoneId: $zoneId
) {
count
total
results {
id
networkAddress
ipAddressType
ipAssignment {
...IPAssignmentFragment
}
expirationDate
reservation {
...ReservationFragment
}
request {
...NetworkRequestItemFragment
}
scanResults {
...ScanResultFragment
}
inUse
subnet {
...SubnetFragment
}
zone {
...ZoneFragment
}
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"subnet_id": 123,
"available": false,
"contiguous": true,
"subnetName": "abc123",
"subnet": "abc123",
"zoneId": 987
}
Response
{
"data": {
"zoneIpAddresses": {
"count": 987,
"total": 987,
"results": [IPAddress]
}
}
}
zoneSubnets
Response
Returns a SubnetList
Example
Query
query ZoneSubnets(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$zoneId: Int
) {
zoneSubnets(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
zoneId: $zoneId
) {
count
total
results {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
}
}
Variables
{
"search": "xyz789",
"limit": 987,
"offset": 123,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"zoneId": 123
}
Response
{
"data": {
"zoneSubnets": {
"count": 987,
"total": 123,
"results": [Subnet]
}
}
}
zoneSubnetsResources
Response
Returns a ResourceList
Example
Query
query ZoneSubnetsResources(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$zoneId: Int
) {
zoneSubnetsResources(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
zoneId: $zoneId
) {
count
total
results {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 987,
"sort_by": "xyz789",
"sort_dir": "xyz789",
"zoneId": 987
}
Response
{
"data": {
"zoneSubnetsResources": {
"count": 987,
"total": 987,
"results": [Resource]
}
}
}
zones
Response
Returns a ZoneList
Example
Query
query Zones(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: String,
$sort_dir: String,
$providerId: Int,
$importId: Int,
$filter: ZoneFilter
) {
zones(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
sort_dir: $sort_dir,
providerId: $providerId,
importId: $importId,
filter: $filter
) {
count
total
results {
id
name
description
VRF
providerId
provider {
...ProviderFragment
}
parentZone {
...ZoneFragment
}
cloudResourceId
importBatchId
customAttributes
}
}
}
Variables
{
"search": "abc123",
"limit": 123,
"offset": 987,
"sort_by": "abc123",
"sort_dir": "xyz789",
"providerId": 987,
"importId": 123,
"filter": ZoneFilter
}
Response
{
"data": {
"zones": {
"count": 987,
"total": 123,
"results": [Zone]
}
}
}
Mutations
addContactsToSubnet
Response
Returns [Contact]
Example
Query
mutation AddContactsToSubnet(
$subnetId: Int!,
$contactIds: [Int!],
$contactName: String,
$networkAddress: String,
$zoneId: Int
) {
addContactsToSubnet(
subnetId: $subnetId,
contactIds: $contactIds,
contactName: $contactName,
networkAddress: $networkAddress,
zoneId: $zoneId
) {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
id
name
description
contacts {
...ContactFragment
}
customAttributes
}
customAttributes
}
}
Variables
{
"subnetId": 987,
"contactIds": [123],
"contactName": "abc123",
"networkAddress": "abc123",
"zoneId": 987
}
Response
{
"data": {
"addContactsToSubnet": [
{
"id": 987,
"firstName": "abc123",
"lastName": "xyz789",
"phone": "xyz789",
"cellPhone": "abc123",
"email": "abc123",
"email2": "xyz789",
"importBatchId": 987,
"SupportGroupId": 123,
"supportGroup": SupportGroup,
"customAttributes": {}
}
]
}
}
addContactsToSupportGroup
Example
Query
mutation AddContactsToSupportGroup(
$id: Int!,
$contactIds: [Int]!
) {
addContactsToSupportGroup(
id: $id,
contactIds: $contactIds
) {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
id
name
description
contacts {
...ContactFragment
}
customAttributes
}
customAttributes
}
}
Variables
{"id": 123, "contactIds": [123]}
Response
{
"data": {
"addContactsToSupportGroup": [
{
"id": 123,
"firstName": "abc123",
"lastName": "abc123",
"phone": "abc123",
"cellPhone": "xyz789",
"email": "xyz789",
"email2": "xyz789",
"importBatchId": 987,
"SupportGroupId": 987,
"supportGroup": SupportGroup,
"customAttributes": {}
}
]
}
}
addCustomersToSubnet
Response
Returns [Customer]
Example
Query
mutation AddCustomersToSubnet(
$id: Int!,
$customerIds: [Int]!,
$customerName: String,
$networkAddress: String,
$zoneId: Int
) {
addCustomersToSubnet(
id: $id,
customerIds: $customerIds,
customerName: $customerName,
networkAddress: $networkAddress,
zoneId: $zoneId
) {
id
name
importId
importBatchId
addresses {
id
line1
line2
line3
line4
municipality
province
country
postalCode
}
sites {
id
name
importBatchId
subnetId
addresses {
...AddressFragment
}
customAttributes
}
customAttributes
}
}
Variables
{
"id": 123,
"customerIds": [987],
"customerName": "abc123",
"networkAddress": "xyz789",
"zoneId": 987
}
Response
{
"data": {
"addCustomersToSubnet": [
{
"id": 123,
"name": "abc123",
"importId": 123,
"importBatchId": 123,
"addresses": [Address],
"sites": [Site],
"customAttributes": {}
}
]
}
}
addSupportGroupsToSubnet
Response
Returns [SupportGroup]
Example
Query
mutation AddSupportGroupsToSubnet(
$subnetId: Int!,
$supportGroupIds: [Int]!,
$supportGroupName: String,
$networkAddress: String,
$zoneId: Int
) {
addSupportGroupsToSubnet(
subnetId: $subnetId,
supportGroupIds: $supportGroupIds,
supportGroupName: $supportGroupName,
networkAddress: $networkAddress,
zoneId: $zoneId
) {
id
name
description
contacts {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
customAttributes
}
}
Variables
{
"subnetId": 123,
"supportGroupIds": [123],
"supportGroupName": "xyz789",
"networkAddress": "abc123",
"zoneId": 123
}
Response
{
"data": {
"addSupportGroupsToSubnet": [
{
"id": 987,
"name": "abc123",
"description": "xyz789",
"contacts": [Contact],
"customAttributes": {}
}
]
}
}
adminUserUpdate
Response
Returns an AdminUser
Example
Query
mutation AdminUserUpdate(
$id: Int!,
$role: String,
$firstName: String,
$lastName: String,
$email: String,
$orgRole: String,
$hideWelcome: Boolean,
$currentPassword: String,
$password: String,
$internal: Boolean,
$config: JSON,
$UserOrganizations: [UserOrganizationInput]
) {
adminUserUpdate(
id: $id,
role: $role,
firstName: $firstName,
lastName: $lastName,
email: $email,
orgRole: $orgRole,
hideWelcome: $hideWelcome,
currentPassword: $currentPassword,
password: $password,
internal: $internal,
config: $config,
UserOrganizations: $UserOrganizations
) {
id
firstName
lastName
email
role
password
lastLogin
loginCount
hideWelcome
superUser
apiKey
localUser
passwordLoginEnabled
microsoftLoginEnabled
googleLoginEnabled
config
UserOrganizations {
id
role
email
firstName
lastName
admin
UserId
OrganizationId
}
currentOrganizationId
internal
notificationSettings
profile
createdAt
}
}
Variables
{
"id": 987,
"role": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"email": "abc123",
"orgRole": "xyz789",
"hideWelcome": false,
"currentPassword": "xyz789",
"password": "abc123",
"internal": true,
"config": {},
"UserOrganizations": [UserOrganizationInput]
}
Response
{
"data": {
"adminUserUpdate": {
"id": 123,
"firstName": "abc123",
"lastName": "abc123",
"email": "abc123",
"role": "xyz789",
"password": "abc123",
"lastLogin": "abc123",
"loginCount": 123,
"hideWelcome": true,
"superUser": false,
"apiKey": "xyz789",
"localUser": false,
"passwordLoginEnabled": false,
"microsoftLoginEnabled": true,
"googleLoginEnabled": false,
"config": {},
"UserOrganizations": [UserOrganization],
"currentOrganizationId": 987,
"internal": false,
"notificationSettings": {},
"profile": {},
"createdAt": "abc123"
}
}
}
createAddress
Response
Returns an Address
Arguments
| Name | Description |
|---|---|
id - Int
|
|
addresses - [AddressInput]
|
Example
Query
mutation CreateAddress(
$id: Int,
$addresses: [AddressInput]
) {
createAddress(
id: $id,
addresses: $addresses
) {
id
line1
line2
line3
line4
municipality
province
country
postalCode
}
}
Variables
{"id": 123, "addresses": [AddressInput]}
Response
{
"data": {
"createAddress": {
"id": 123,
"line1": "abc123",
"line2": "abc123",
"line3": "abc123",
"line4": "abc123",
"municipality": "xyz789",
"province": "abc123",
"country": "xyz789",
"postalCode": "xyz789"
}
}
}
createAlert
Response
Returns an Alert
Example
Query
mutation CreateAlert(
$SubnetId: Int,
$UserId: Int,
$AlertRuleId: Int,
$status: String,
$type: String,
$name: String,
$description: String
) {
createAlert(
SubnetId: $SubnetId,
UserId: $UserId,
AlertRuleId: $AlertRuleId,
status: $status,
type: $type,
name: $name,
description: $description
) {
id
SubnetId
UserId
AlertRuleId
status
type
name
Subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
description
message
clearNotification
}
}
Variables
{
"SubnetId": 987,
"UserId": 123,
"AlertRuleId": 123,
"status": "xyz789",
"type": "xyz789",
"name": "xyz789",
"description": "abc123"
}
Response
{
"data": {
"createAlert": {
"id": 987,
"SubnetId": 123,
"UserId": 987,
"AlertRuleId": 123,
"status": "abc123",
"type": "xyz789",
"name": "xyz789",
"Subnet": Subnet,
"description": "xyz789",
"message": "xyz789",
"clearNotification": true
}
}
}
createAlertDestination
Response
Returns an AlertDestination
Example
Query
mutation CreateAlertDestination(
$name: String,
$type: String,
$URL: String,
$status: String,
$email: String,
$verificationCode: String,
$slackChannel: String,
$options: JSON
) {
createAlertDestination(
name: $name,
type: $type,
URL: $URL,
status: $status,
email: $email,
verificationCode: $verificationCode,
slackChannel: $slackChannel,
options: $options
) {
name
id
type
URL
slackChannel
email
status
verificationCode
options
createdAt
}
}
Variables
{
"name": "abc123",
"type": "abc123",
"URL": "xyz789",
"status": "abc123",
"email": "abc123",
"verificationCode": "abc123",
"slackChannel": "xyz789",
"options": {}
}
Response
{
"data": {
"createAlertDestination": {
"name": "abc123",
"id": 123,
"type": "xyz789",
"URL": "abc123",
"slackChannel": "abc123",
"email": "xyz789",
"status": "xyz789",
"verificationCode": "abc123",
"options": {},
"createdAt": "abc123"
}
}
}
createAlertRecipient
Response
Returns an AlertRecipient
Arguments
| Name | Description |
|---|---|
alertRecipient - [AlertRecipientInput]
|
Example
Query
mutation CreateAlertRecipient($alertRecipient: [AlertRecipientInput]) {
createAlertRecipient(alertRecipient: $alertRecipient) {
id
UserId
userName
AlertRuleId
rules {
id
SubnetId
ZoneId
networkAddress
status
type
name
description
conditions
subnet {
...SubnetFragment
}
AlertDestinations {
...AlertDestinationFragment
}
AlertRecipientId
AlertRecipients {
...AlertRecipientFragment
}
recipients {
...AlertRecipientFragment
}
}
}
}
Variables
{"alertRecipient": [AlertRecipientInput]}
Response
{
"data": {
"createAlertRecipient": {
"id": 123,
"UserId": 987,
"userName": "abc123",
"AlertRuleId": 987,
"rules": [AlertRule]
}
}
}
createAlertRule
Response
Returns an AlertRule
Arguments
| Name | Description |
|---|---|
alerts - [AlertRuleInput]
|
|
alertDestinationIds - [Int]
|
|
alertRecipientIds - [Int]
|
Example
Query
mutation CreateAlertRule(
$alerts: [AlertRuleInput],
$alertDestinationIds: [Int],
$alertRecipientIds: [Int]
) {
createAlertRule(
alerts: $alerts,
alertDestinationIds: $alertDestinationIds,
alertRecipientIds: $alertRecipientIds
) {
id
SubnetId
ZoneId
networkAddress
status
type
name
description
conditions
subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
AlertDestinations {
name
id
type
URL
slackChannel
email
status
verificationCode
options
createdAt
}
AlertRecipientId
AlertRecipients {
id
UserId
userName
AlertRuleId
rules {
...AlertRuleFragment
}
}
recipients {
id
UserId
userName
AlertRuleId
rules {
...AlertRuleFragment
}
}
}
}
Variables
{
"alerts": [AlertRuleInput],
"alertDestinationIds": [987],
"alertRecipientIds": [123]
}
Response
{
"data": {
"createAlertRule": {
"id": 987,
"SubnetId": 123,
"ZoneId": 987,
"networkAddress": "abc123",
"status": "abc123",
"type": "abc123",
"name": "abc123",
"description": "abc123",
"conditions": {},
"subnet": Subnet,
"AlertDestinations": [AlertDestination],
"AlertRecipientId": 123,
"AlertRecipients": [AlertRecipient],
"recipients": [AlertRecipient]
}
}
}
createContact
Response
Returns a Contact
Example
Query
mutation CreateContact(
$firstName: String,
$lastName: String,
$phone: String,
$cellPhone: String,
$email: String,
$email2: String,
$SupportGroupId: Int,
$customAttributes: JSON
) {
createContact(
firstName: $firstName,
lastName: $lastName,
phone: $phone,
cellPhone: $cellPhone,
email: $email,
email2: $email2,
SupportGroupId: $SupportGroupId,
customAttributes: $customAttributes
) {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
id
name
description
contacts {
...ContactFragment
}
customAttributes
}
customAttributes
}
}
Variables
{
"firstName": "abc123",
"lastName": "abc123",
"phone": "xyz789",
"cellPhone": "xyz789",
"email": "abc123",
"email2": "abc123",
"SupportGroupId": 123,
"customAttributes": {}
}
Response
{
"data": {
"createContact": {
"id": 987,
"firstName": "xyz789",
"lastName": "abc123",
"phone": "abc123",
"cellPhone": "xyz789",
"email": "xyz789",
"email2": "abc123",
"importBatchId": 987,
"SupportGroupId": 987,
"supportGroup": SupportGroup,
"customAttributes": {}
}
}
}
createCustomAttribute
Response
Returns a CustomAttribute
Example
Query
mutation CreateCustomAttribute(
$modelName: String,
$name: String,
$type: String,
$required: Boolean,
$sectionId: Int,
$rowIndex: Int,
$rowColSpan: Int,
$colIndex: Int,
$colSpan: Int,
$component: String
) {
createCustomAttribute(
modelName: $modelName,
name: $name,
type: $type,
required: $required,
sectionId: $sectionId,
rowIndex: $rowIndex,
rowColSpan: $rowColSpan,
colIndex: $colIndex,
colSpan: $colSpan,
component: $component
) {
id
modelName
name
type
required
sectionId
rowIndex
rowColSpan
colIndex
colSpan
component
}
}
Variables
{
"modelName": "abc123",
"name": "xyz789",
"type": "xyz789",
"required": false,
"sectionId": 123,
"rowIndex": 123,
"rowColSpan": 123,
"colIndex": 987,
"colSpan": 987,
"component": "abc123"
}
Response
{
"data": {
"createCustomAttribute": {
"id": 987,
"modelName": "abc123",
"name": "abc123",
"type": "abc123",
"required": true,
"sectionId": 123,
"rowIndex": 123,
"rowColSpan": 987,
"colIndex": 987,
"colSpan": 123,
"component": "abc123"
}
}
}
createCustomer
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
name - String!
|
|
customAttributes - JSON
|
|
addresses - [AddressInput]
|
Example
Query
mutation CreateCustomer(
$name: String!,
$customAttributes: JSON,
$addresses: [AddressInput]
) {
createCustomer(
name: $name,
customAttributes: $customAttributes,
addresses: $addresses
) {
id
name
importId
importBatchId
addresses {
id
line1
line2
line3
line4
municipality
province
country
postalCode
}
sites {
id
name
importBatchId
subnetId
addresses {
...AddressFragment
}
customAttributes
}
customAttributes
}
}
Variables
{
"name": "abc123",
"customAttributes": {},
"addresses": [AddressInput]
}
Response
{
"data": {
"createCustomer": {
"id": 123,
"name": "xyz789",
"importId": 987,
"importBatchId": 987,
"addresses": [Address],
"sites": [Site],
"customAttributes": {}
}
}
}
createDNSEntry
Response
Returns an DNSEntry
Example
Query
mutation CreateDNSEntry(
$name: String!,
$ttl: Int,
$recordClass: String,
$recordType: String,
$recordData: String,
$customAttributes: JSON,
$networkAddress: String,
$priority: Int,
$status: String
) {
createDNSEntry(
name: $name,
ttl: $ttl,
recordClass: $recordClass,
recordType: $recordType,
recordData: $recordData,
customAttributes: $customAttributes,
networkAddress: $networkAddress,
priority: $priority,
status: $status
) {
id
name
ttl
recordClass
recordType
recordData
dnsZone {
name
dnsServer {
...DNSServerFragment
}
}
customAttributes
networkAddress
priority
status
IPAssignment {
id
subnetId
networkAddress
description
ipAddressType
interface {
...InterfaceFragment
}
lastSeenAt
subnet {
...SubnetFragment
}
DNSEntries {
...DNSEntryFragment
}
resource {
...ResourceFragment
}
interfaces {
...InterfaceFragment
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
...NetworkRequestItemFragment
}
}
}
}
Variables
{
"name": "xyz789",
"ttl": 123,
"recordClass": "xyz789",
"recordType": "abc123",
"recordData": "abc123",
"customAttributes": {},
"networkAddress": "abc123",
"priority": 123,
"status": "xyz789"
}
Response
{
"data": {
"createDNSEntry": {
"id": 123,
"name": "xyz789",
"ttl": 987,
"recordClass": "abc123",
"recordType": "xyz789",
"recordData": "abc123",
"dnsZone": [DNSZone],
"customAttributes": {},
"networkAddress": "abc123",
"priority": 123,
"status": "abc123",
"IPAssignment": IPAssignment
}
}
}
createIPAssignment
Response
Returns an IPAssignment
Arguments
| Name | Description |
|---|---|
networkAddress - String!
|
|
subnetId - Int!
|
|
description - String
|
|
ipAddressType - String
|
|
dnsEntries - [DNSEntryInput]
|
|
resource - ResourceInput
|
|
interfaceId - Int
|
|
customAttributes - JSON
|
Example
Query
mutation CreateIPAssignment(
$networkAddress: String!,
$subnetId: Int!,
$description: String,
$ipAddressType: String,
$dnsEntries: [DNSEntryInput],
$resource: ResourceInput,
$interfaceId: Int,
$customAttributes: JSON
) {
createIPAssignment(
networkAddress: $networkAddress,
subnetId: $subnetId,
description: $description,
ipAddressType: $ipAddressType,
dnsEntries: $dnsEntries,
resource: $resource,
interfaceId: $interfaceId,
customAttributes: $customAttributes
) {
id
subnetId
networkAddress
description
ipAddressType
interface {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
lastSeenAt
subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
DNSEntries {
id
name
ttl
recordClass
recordType
recordData
dnsZone {
...DNSZoneFragment
}
customAttributes
networkAddress
priority
status
IPAssignment {
...IPAssignmentFragment
}
}
resource {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
interfaces {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
id
status
zoneId
ipAddress
macAddress
interface
hostname
customAttributes
description
networkRequestId
networkRequest {
...NetworkRequestFragment
}
}
}
}
Variables
{
"networkAddress": "abc123",
"subnetId": 123,
"description": "xyz789",
"ipAddressType": "abc123",
"dnsEntries": [DNSEntryInput],
"resource": ResourceInput,
"interfaceId": 987,
"customAttributes": {}
}
Response
{
"data": {
"createIPAssignment": {
"id": 123,
"subnetId": 987,
"networkAddress": "xyz789",
"description": "abc123",
"ipAddressType": "abc123",
"interface": Interface,
"lastSeenAt": "xyz789",
"subnet": Subnet,
"DNSEntries": [DNSEntry],
"resource": Resource,
"interfaces": [Interface],
"cloudResourceId": "xyz789",
"createdAt": "xyz789",
"importBatchId": 123,
"customAttributes": {},
"request": NetworkRequestItem
}
}
}
createImport
Example
Query
mutation CreateImport(
$name: String,
$description: String
) {
createImport(
name: $name,
description: $description
) {
id
description
customer_count
contact_count
site_count
zone_count
subnet_count
ip_assignment_count
records {
id
type
display
value
}
}
}
Variables
{
"name": "xyz789",
"description": "xyz789"
}
Response
{
"data": {
"createImport": {
"id": 987,
"description": "xyz789",
"customer_count": 987,
"contact_count": 123,
"site_count": 987,
"zone_count": 123,
"subnet_count": 123,
"ip_assignment_count": 123,
"records": [ImportRecord]
}
}
}
createInterface
Example
Query
mutation CreateInterface($name: String!) {
createInterface(name: $name) {
id
name
macAddress
resource {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
ipAssignment {
id
subnetId
networkAddress
description
ipAddressType
interface {
...InterfaceFragment
}
lastSeenAt
subnet {
...SubnetFragment
}
DNSEntries {
...DNSEntryFragment
}
resource {
...ResourceFragment
}
interfaces {
...InterfaceFragment
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
...NetworkRequestItemFragment
}
}
cloudResourceId
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"createInterface": {
"id": 987,
"name": "xyz789",
"macAddress": "xyz789",
"resource": Resource,
"ipAssignment": IPAssignment,
"cloudResourceId": "xyz789"
}
}
}
createNat
Response
Returns an NAT
Example
Query
mutation CreateNat(
$sourceNatAddress: String!,
$destinationNatAddress: [String]!,
$subnetId: Int!,
$natType: String!,
$sourcePort: Int,
$sourceNatZoneId: Int,
$destinationPort: Int,
$destinationNatZoneId: Int,
$sourceType: String,
$destinationType: String
) {
createNat(
sourceNatAddress: $sourceNatAddress,
destinationNatAddress: $destinationNatAddress,
subnetId: $subnetId,
natType: $natType,
sourcePort: $sourcePort,
sourceNatZoneId: $sourceNatZoneId,
destinationPort: $destinationPort,
destinationNatZoneId: $destinationNatZoneId,
sourceType: $sourceType,
destinationType: $destinationType
) {
id
sourceNatAddress
destinationNatAddress
natType
sourcePort
sourceNatZoneId
destinationPort
destinationNatZoneId
sourceType
destinationType
subnetId
}
}
Variables
{
"sourceNatAddress": "xyz789",
"destinationNatAddress": ["abc123"],
"subnetId": 987,
"natType": "xyz789",
"sourcePort": 987,
"sourceNatZoneId": 987,
"destinationPort": 987,
"destinationNatZoneId": 987,
"sourceType": "xyz789",
"destinationType": "xyz789"
}
Response
{
"data": {
"createNat": {
"id": 987,
"sourceNatAddress": "abc123",
"destinationNatAddress": ["xyz789"],
"natType": "abc123",
"sourcePort": 987,
"sourceNatZoneId": 987,
"destinationPort": 987,
"destinationNatZoneId": 123,
"sourceType": "xyz789",
"destinationType": "abc123",
"subnetId": 123
}
}
}
createNetworkRequest
Response
Returns a NetworkRequest
Arguments
| Name | Description |
|---|---|
status - String!
|
|
ipAddressCount - Int
|
|
details - String
|
|
subnetId - Int
|
|
NetworkRequestItems - [NetworkRequestItemInput]
|
Example
Query
mutation CreateNetworkRequest(
$status: String!,
$ipAddressCount: Int,
$details: String,
$subnetId: Int,
$NetworkRequestItems: [NetworkRequestItemInput]
) {
createNetworkRequest(
status: $status,
ipAddressCount: $ipAddressCount,
details: $details,
subnetId: $subnetId,
NetworkRequestItems: $NetworkRequestItems
) {
id
status
ipAddressCount
details
networkAddress
zoneId
subnetId
NetworkRequestItems {
id
status
zoneId
ipAddress
macAddress
interface
hostname
customAttributes
description
networkRequestId
networkRequest {
...NetworkRequestFragment
}
}
createdAt
}
}
Variables
{
"status": "xyz789",
"ipAddressCount": 123,
"details": "abc123",
"subnetId": 987,
"NetworkRequestItems": [NetworkRequestItemInput]
}
Response
{
"data": {
"createNetworkRequest": {
"id": 123,
"status": "xyz789",
"ipAddressCount": 987,
"details": "abc123",
"networkAddress": "xyz789",
"zoneId": "xyz789",
"subnetId": 123,
"NetworkRequestItems": [NetworkRequestItem],
"createdAt": "xyz789"
}
}
}
createProvider
Response
Returns a Provider
Example
Query
mutation CreateProvider(
$name: String,
$type: String,
$active: Boolean,
$azureAppId: String,
$azurePassword: String,
$azureTenantId: String,
$awsAccessKeyId: String,
$awsSecretAccessKey: String,
$awsSessionToken: String,
$customAttributes: JSON
) {
createProvider(
name: $name,
type: $type,
active: $active,
azureAppId: $azureAppId,
azurePassword: $azurePassword,
azureTenantId: $azureTenantId,
awsAccessKeyId: $awsAccessKeyId,
awsSecretAccessKey: $awsSecretAccessKey,
awsSessionToken: $awsSessionToken,
customAttributes: $customAttributes
) {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
}
Variables
{
"name": "abc123",
"type": "abc123",
"active": false,
"azureAppId": "xyz789",
"azurePassword": "xyz789",
"azureTenantId": "abc123",
"awsAccessKeyId": "abc123",
"awsSecretAccessKey": "abc123",
"awsSessionToken": "abc123",
"customAttributes": {}
}
Response
{
"data": {
"createProvider": {
"id": 987,
"name": "abc123",
"active": false,
"type": "abc123",
"azureAppId": "abc123",
"azurePassword": "xyz789",
"azureTenantId": "abc123",
"awsAccessKeyId": "xyz789",
"awsSecretAccessKey": "xyz789",
"awsSessionToken": "xyz789",
"lastSynchronizedAt": "xyz789",
"syncStatus": "abc123",
"syncError": "abc123",
"subnetCount": 123,
"ipCount": 987,
"resourceCount": 987,
"createdAt": "abc123",
"customAttributes": {}
}
}
}
createReservation
Response
Returns a Reservation
Example
Query
mutation CreateReservation(
$name: String!,
$description: String,
$subnetId: Int!,
$color: String,
$ipAddresses: [IPAddressInput],
$networkAddresses: [String],
$zoneId: Int,
$networkAddress: String
) {
createReservation(
name: $name,
description: $description,
subnetId: $subnetId,
color: $color,
ipAddresses: $ipAddresses,
networkAddresses: $networkAddresses,
zoneId: $zoneId,
networkAddress: $networkAddress
) {
id
name
description
color
ipAddresses {
id
networkAddress
ipAddressType
ipAssignment {
...IPAssignmentFragment
}
expirationDate
reservation {
...ReservationFragment
}
request {
...NetworkRequestItemFragment
}
scanResults {
...ScanResultFragment
}
inUse
subnet {
...SubnetFragment
}
zone {
...ZoneFragment
}
}
subnetId
}
}
Variables
{
"name": "abc123",
"description": "xyz789",
"subnetId": 987,
"color": "xyz789",
"ipAddresses": [IPAddressInput],
"networkAddresses": ["abc123"],
"zoneId": 987,
"networkAddress": "xyz789"
}
Response
{
"data": {
"createReservation": {
"id": 123,
"name": "xyz789",
"description": "xyz789",
"color": "abc123",
"ipAddresses": [IPAddress],
"subnetId": 987
}
}
}
createResource
Response
Returns a Resource
Arguments
| Name | Description |
|---|---|
resource - ResourceInput
|
Example
Query
mutation CreateResource($resource: ResourceInput) {
createResource(resource: $resource) {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
lastSeenAt
ResourceStatus {
id
name
}
resourceType {
id
name
}
interfaces {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
createdAt
}
}
Variables
{"resource": ResourceInput}
Response
{
"data": {
"createResource": {
"id": 123,
"hostname": "abc123",
"OS": "abc123",
"OSVersion": "abc123",
"macAddress": "xyz789",
"cloudResourceId": "xyz789",
"resourceGroupId": "abc123",
"resourceTypeId": 123,
"provider": Provider,
"lastSeenAt": "xyz789",
"ResourceStatus": ResourceStatus,
"resourceType": ResourceType,
"interfaces": [Interface],
"createdAt": "xyz789"
}
}
}
createResourceStatus
Response
Returns a ResourceStatus
Arguments
| Name | Description |
|---|---|
id - Int
|
|
resourceStatuses - [ResourceStatusInput]
|
Example
Query
mutation CreateResourceStatus(
$id: Int,
$resourceStatuses: [ResourceStatusInput]
) {
createResourceStatus(
id: $id,
resourceStatuses: $resourceStatuses
) {
id
name
}
}
Variables
{"id": 987, "resourceStatuses": [ResourceStatusInput]}
Response
{
"data": {
"createResourceStatus": {
"id": 123,
"name": "xyz789"
}
}
}
createResourceType
Response
Returns a ResourceType
Arguments
| Name | Description |
|---|---|
id - Int
|
|
resourceType - ResourceTypeInput
|
Example
Query
mutation CreateResourceType(
$id: Int,
$resourceType: ResourceTypeInput
) {
createResourceType(
id: $id,
resourceType: $resourceType
) {
id
name
}
}
Variables
{"id": 123, "resourceType": ResourceTypeInput}
Response
{
"data": {
"createResourceType": {
"id": 123,
"name": "xyz789"
}
}
}
createRole
Example
Query
mutation CreateRole($name: String) {
createRole(name: $name) {
id
name
description
plans {
id
name
projectId
description
subnets {
...SubnetFragment
}
plannedChanges {
...PlannedChangeFragment
}
}
}
}
Variables
{"name": "xyz789"}
Response
{
"data": {
"createRole": {
"id": 123,
"name": "abc123",
"description": "xyz789",
"plans": [Plan]
}
}
}
createRoleAssignment
Response
Returns a RoleAssignment
Example
Query
mutation CreateRoleAssignment(
$subjectId: Int!,
$subjectType: String!,
$roleId: Int!,
$recordId: Int,
$recordType: String,
$userName: String,
$roleName: String,
$networkAddress: String,
$zoneId: Int
) {
createRoleAssignment(
subjectId: $subjectId,
subjectType: $subjectType,
roleId: $roleId,
recordId: $recordId,
recordType: $recordType,
userName: $userName,
roleName: $roleName,
networkAddress: $networkAddress,
zoneId: $zoneId
) {
id
subjectId
subjectType
recordId
recordType
networkAddress
zoneId
userGroup {
id
name
description
}
role {
id
name
description
plans {
...PlanFragment
}
}
}
}
Variables
{
"subjectId": 987,
"subjectType": "abc123",
"roleId": 123,
"recordId": 123,
"recordType": "abc123",
"userName": "xyz789",
"roleName": "xyz789",
"networkAddress": "abc123",
"zoneId": 123
}
Response
{
"data": {
"createRoleAssignment": {
"id": 123,
"subjectId": 123,
"subjectType": "abc123",
"recordId": "abc123",
"recordType": "xyz789",
"networkAddress": "abc123",
"zoneId": 987,
"userGroup": UserGroup,
"role": Role
}
}
}
createScan
Response
Returns a Scan
Example
Query
mutation CreateScan(
$subnetId: Int,
$zoneId: Int,
$networkAddress: String!,
$hostname: String,
$resourceType: String,
$macAddress: String,
$interface: String,
$sourceType: String,
$sourceVersion: String,
$scannedAt: Date,
$scanCommand: String,
$fileName: String,
$result: String,
$customAttributes: JSON
) {
createScan(
subnetId: $subnetId,
zoneId: $zoneId,
networkAddress: $networkAddress,
hostname: $hostname,
resourceType: $resourceType,
macAddress: $macAddress,
interface: $interface,
sourceType: $sourceType,
sourceVersion: $sourceVersion,
scannedAt: $scannedAt,
scanCommand: $scanCommand,
fileName: $fileName,
result: $result,
customAttributes: $customAttributes
) {
id
subnetId
zoneId
networkAddress
hostname
macAddress
interface
scannedAt
scanCommand
customAttributes
ignore
sourceType
sourceVersion
fileName
result
userId
}
}
Variables
{
"subnetId": 123,
"zoneId": 987,
"networkAddress": "xyz789",
"hostname": "xyz789",
"resourceType": "xyz789",
"macAddress": "abc123",
"interface": "xyz789",
"sourceType": "xyz789",
"sourceVersion": "xyz789",
"scannedAt": "2007-12-03",
"scanCommand": "xyz789",
"fileName": "xyz789",
"result": "abc123",
"customAttributes": {}
}
Response
{
"data": {
"createScan": {
"id": 123,
"subnetId": 987,
"zoneId": 123,
"networkAddress": "abc123",
"hostname": "abc123",
"macAddress": "xyz789",
"interface": "abc123",
"scannedAt": "2007-12-03",
"scanCommand": "xyz789",
"customAttributes": {},
"ignore": true,
"sourceType": "abc123",
"sourceVersion": "abc123",
"fileName": "abc123",
"result": "xyz789",
"userId": 123
}
}
}
createScanResult
Response
Returns a ScanResult
Arguments
| Name | Description |
|---|---|
subnetId - Int
|
|
zoneId - Int
|
|
ipAssignmentId - Int
|
|
networkAddress - String!
|
|
hostname - String
|
|
resourceType - String
|
|
macAddress - String
|
|
interface - String
|
|
scannedAt - String
|
|
ScanId - Int
|
|
sourceType - String
|
|
sourceVersion - String
|
|
customAttributes - JSON
|
|
fileName - String
|
|
result - String
|
|
ignore - Boolean
|
Example
Query
mutation CreateScanResult(
$subnetId: Int,
$zoneId: Int,
$ipAssignmentId: Int,
$networkAddress: String!,
$hostname: String,
$resourceType: String,
$macAddress: String,
$interface: String,
$scannedAt: String,
$ScanId: Int,
$sourceType: String,
$sourceVersion: String,
$customAttributes: JSON,
$fileName: String,
$result: String,
$ignore: Boolean
) {
createScanResult(
subnetId: $subnetId,
zoneId: $zoneId,
ipAssignmentId: $ipAssignmentId,
networkAddress: $networkAddress,
hostname: $hostname,
resourceType: $resourceType,
macAddress: $macAddress,
interface: $interface,
scannedAt: $scannedAt,
ScanId: $ScanId,
sourceType: $sourceType,
sourceVersion: $sourceVersion,
customAttributes: $customAttributes,
fileName: $fileName,
result: $result,
ignore: $ignore
) {
id
subnetId
zoneId
networkAddress
hostname
resourceType
macAddress
cloudResourceId
interface
scannedAt
ScanId
customAttributes
ignore
sourceType
sourceVersion
fileName
result
ipAssignmentId
}
}
Variables
{
"subnetId": 987,
"zoneId": 123,
"ipAssignmentId": 987,
"networkAddress": "xyz789",
"hostname": "abc123",
"resourceType": "xyz789",
"macAddress": "abc123",
"interface": "xyz789",
"scannedAt": "xyz789",
"ScanId": 123,
"sourceType": "abc123",
"sourceVersion": "abc123",
"customAttributes": {},
"fileName": "abc123",
"result": "xyz789",
"ignore": true
}
Response
{
"data": {
"createScanResult": {
"id": 123,
"subnetId": 987,
"zoneId": 987,
"networkAddress": "abc123",
"hostname": "abc123",
"resourceType": "xyz789",
"macAddress": "xyz789",
"cloudResourceId": "abc123",
"interface": "xyz789",
"scannedAt": "2007-12-03",
"ScanId": 987,
"customAttributes": {},
"ignore": true,
"sourceType": "xyz789",
"sourceVersion": "abc123",
"fileName": "abc123",
"result": "xyz789",
"ipAssignmentId": 123
}
}
}
createSite
Response
Returns a Site
Arguments
| Name | Description |
|---|---|
name - String
|
|
customAttributes - JSON
|
|
addresses - [AddressInput]
|
Example
Query
mutation CreateSite(
$name: String,
$customAttributes: JSON,
$addresses: [AddressInput]
) {
createSite(
name: $name,
customAttributes: $customAttributes,
addresses: $addresses
) {
id
name
importBatchId
subnetId
addresses {
id
line1
line2
line3
line4
municipality
province
country
postalCode
}
customAttributes
}
}
Variables
{
"name": "abc123",
"customAttributes": {},
"addresses": [AddressInput]
}
Response
{
"data": {
"createSite": {
"id": 123,
"name": "abc123",
"importBatchId": 987,
"subnetId": 123,
"addresses": [Address],
"customAttributes": {}
}
}
}
createSubnet
Response
Returns a Subnet
Example
Query
mutation CreateSubnet(
$planId: Int,
$status: String,
$name: String,
$direction: String,
$description: String,
$networkAddress: String,
$defaultGatewayId: Int,
$zoneId: Int,
$zoneName: String,
$supernetId: Int,
$siteId: Int,
$defaultGateway: String,
$VLANId: Int,
$customAttributes: JSON
) {
createSubnet(
planId: $planId,
status: $status,
name: $name,
direction: $direction,
description: $description,
networkAddress: $networkAddress,
defaultGatewayId: $defaultGatewayId,
zoneId: $zoneId,
zoneName: $zoneName,
supernetId: $supernetId,
siteId: $siteId,
defaultGateway: $defaultGateway,
VLANId: $VLANId,
customAttributes: $customAttributes
) {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
id
name
description
VRF
providerId
provider {
...ProviderFragment
}
parentZone {
...ZoneFragment
}
cloudResourceId
importBatchId
customAttributes
}
provider {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
vlan {
id
number
}
pollable
broadcast
customers {
id
name
importId
importBatchId
addresses {
...AddressFragment
}
sites {
...SiteFragment
}
customAttributes
}
Contacts {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
site {
id
name
importBatchId
subnetId
addresses {
...AddressFragment
}
customAttributes
}
supportGroups {
id
name
description
contacts {
...ContactFragment
}
customAttributes
}
subnets {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
supernet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
id
sourceNatAddress
destinationNatAddress
natType
sourcePort
sourceNatZoneId
destinationPort
destinationNatZoneId
sourceType
destinationType
subnetId
}
customAttributes
inUse
}
}
Variables
{
"planId": 987,
"status": "xyz789",
"name": "xyz789",
"direction": "xyz789",
"description": "xyz789",
"networkAddress": "abc123",
"defaultGatewayId": 123,
"zoneId": 123,
"zoneName": "xyz789",
"supernetId": 123,
"siteId": 123,
"defaultGateway": "xyz789",
"VLANId": 123,
"customAttributes": {}
}
Response
{
"data": {
"createSubnet": {
"id": 987,
"status": "abc123",
"planId": 123,
"name": "xyz789",
"description": "xyz789",
"direction": "abc123",
"networkAddress": "abc123",
"host": "abc123",
"defaultGatewayId": 123,
"supernetId": 123,
"defaultGateway": "abc123",
"zone": Zone,
"provider": Provider,
"vlan": VLAN,
"pollable": true,
"broadcast": "abc123",
"customers": [Customer],
"Contacts": [Contact],
"site": Site,
"supportGroups": [SupportGroup],
"subnets": [Subnet],
"supernet": Subnet,
"syncStatus": "xyz789",
"lastSynchronizedAt": "abc123",
"syncError": "xyz789",
"cloudResourceId": "abc123",
"importBatchId": 987,
"nat": [NAT],
"customAttributes": {},
"inUse": 987
}
}
}
createSupportGroup
Response
Returns a SupportGroup
Example
Query
mutation CreateSupportGroup(
$name: String!,
$description: String,
$customAttributes: JSON
) {
createSupportGroup(
name: $name,
description: $description,
customAttributes: $customAttributes
) {
id
name
description
contacts {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
customAttributes
}
}
Variables
{
"name": "xyz789",
"description": "abc123",
"customAttributes": {}
}
Response
{
"data": {
"createSupportGroup": {
"id": 123,
"name": "xyz789",
"description": "abc123",
"contacts": [Contact],
"customAttributes": {}
}
}
}
createSupportTicket
Response
Returns a SupportTicket
Example
Query
mutation CreateSupportTicket(
$UserId: Int,
$message: String
) {
createSupportTicket(
UserId: $UserId,
message: $message
) {
id
UserId
message
}
}
Variables
{"UserId": 987, "message": "abc123"}
Response
{
"data": {
"createSupportTicket": {
"id": 987,
"UserId": 987,
"message": "xyz789"
}
}
}
createUserCommunication
Response
Returns a UserCommunication
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
mutation CreateUserCommunication($name: String!) {
createUserCommunication(name: $name) {
id
name
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"createUserCommunication": {
"id": 123,
"name": "xyz789"
}
}
}
createUserCommunicationVersion
Response
Returns a UserCommunicationVersion
Example
Query
mutation CreateUserCommunicationVersion(
$UserCommunicationId: Int,
$emailBody: String,
$schedule: JSON
) {
createUserCommunicationVersion(
UserCommunicationId: $UserCommunicationId,
emailBody: $emailBody,
schedule: $schedule
) {
id
UserCommunicationId
open
send
bounce
emailBody
schedule
createdAt
UserCommunication {
id
name
}
}
}
Variables
{
"UserCommunicationId": 123,
"emailBody": "xyz789",
"schedule": {}
}
Response
{
"data": {
"createUserCommunicationVersion": {
"id": 987,
"UserCommunicationId": 123,
"open": 987,
"send": 987,
"bounce": 123,
"emailBody": "xyz789",
"schedule": {},
"createdAt": "2007-12-03",
"UserCommunication": UserCommunication
}
}
}
createUserGroup
Example
Query
mutation CreateUserGroup($name: String!) {
createUserGroup(name: $name) {
id
name
description
}
}
Variables
{"name": "xyz789"}
Response
{
"data": {
"createUserGroup": {
"id": 123,
"name": "abc123",
"description": "xyz789"
}
}
}
createUserOrganization
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
userOrganization - UserOrganizationInput
|
Example
Query
mutation CreateUserOrganization($userOrganization: UserOrganizationInput) {
createUserOrganization(userOrganization: $userOrganization)
}
Variables
{"userOrganization": UserOrganizationInput}
Response
{"data": {"createUserOrganization": false}}
createVLAN
createZone
Response
Returns a Zone
Example
Query
mutation CreateZone(
$name: String!,
$description: String,
$providerId: Int,
$VRF: String,
$customAttributes: JSON
) {
createZone(
name: $name,
description: $description,
providerId: $providerId,
VRF: $VRF,
customAttributes: $customAttributes
) {
id
name
description
VRF
providerId
provider {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
parentZone {
id
name
description
VRF
providerId
provider {
...ProviderFragment
}
parentZone {
...ZoneFragment
}
cloudResourceId
importBatchId
customAttributes
}
cloudResourceId
importBatchId
customAttributes
}
}
Variables
{
"name": "abc123",
"description": "xyz789",
"providerId": 987,
"VRF": "xyz789",
"customAttributes": {}
}
Response
{
"data": {
"createZone": {
"id": 123,
"name": "abc123",
"description": "abc123",
"VRF": "xyz789",
"providerId": 987,
"provider": Provider,
"parentZone": [Zone],
"cloudResourceId": "xyz789",
"importBatchId": 987,
"customAttributes": {}
}
}
}
destroyAddress
destroyAlert
destroyAlertDestination
destroyAlertRecipient
destroyAlertRule
destroyContact
destroyContacts
destroyCustomAttributes
destroyCustomer
destroyCustomers
destroyDNSEntries
destroyDNSEntry
destroyDNSServer
destroyDNSZone
destroyIPAssignment
destroyIPAssignments
destroyImport
destroyInterface
destroyLocation
destroyNat
destroyNetworkRequest
destroyPlan
destroyPlannedChange
destroyProject
destroyProvider
destroyProviders
destroyReservation
Response
Returns a Boolean
Example
Query
mutation DestroyReservation(
$id: Int!,
$networkAddresses: [String],
$zoneId: Int,
$networkAddress: String
) {
destroyReservation(
id: $id,
networkAddresses: $networkAddresses,
zoneId: $zoneId,
networkAddress: $networkAddress
)
}
Variables
{
"id": 123,
"networkAddresses": ["abc123"],
"zoneId": 987,
"networkAddress": "abc123"
}
Response
{"data": {"destroyReservation": true}}
destroyResource
destroyResourceStatus
destroyResourceType
destroyResources
destroyRole
destroyRoleAssignment
destroyScan
destroyScanResult
destroySite
destroySites
destroySubnet
destroySubnets
Example
Query
mutation DestroySubnets(
$ids: [Int!],
$clearSpace: Boolean
) {
destroySubnets(
ids: $ids,
clearSpace: $clearSpace
)
}
Variables
{"ids": [123], "clearSpace": false}
Response
{"data": {"destroySubnets": true}}
destroySupportGroup
destroySupportGroups
destroySupportTicket
destroyUserCommunicationVersion
destroyUserGroup
destroyUserOrganization
Example
Query
mutation DestroyUserOrganization(
$UserId: Int!,
$OrganizationId: Int!
) {
destroyUserOrganization(
UserId: $UserId,
OrganizationId: $OrganizationId
)
}
Variables
{"UserId": 123, "OrganizationId": 987}
Response
{"data": {"destroyUserOrganization": true}}
destroyVLAN
destroyZone
destroyZones
Example
Query
mutation DestroyZones(
$ids: [Int!],
$clearSpace: Boolean
) {
destroyZones(
ids: $ids,
clearSpace: $clearSpace
)
}
Variables
{"ids": [987], "clearSpace": false}
Response
{"data": {"destroyZones": false}}
generateApiKey
Response
Returns an ApiKey
Example
Query
mutation GenerateApiKey(
$apiKeyName: String!,
$customExpiration: String,
$apiKey: String!
) {
generateApiKey(
apiKeyName: $apiKeyName,
customExpiration: $customExpiration,
apiKey: $apiKey
) {
id
apiKey
apiKeyExpiry
apiKeyName
}
}
Variables
{
"apiKeyName": "abc123",
"customExpiration": "abc123",
"apiKey": "abc123"
}
Response
{
"data": {
"generateApiKey": {
"id": 987,
"apiKey": "xyz789",
"apiKeyExpiry": "xyz789",
"apiKeyName": "abc123"
}
}
}
importContacts
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
importId - Int!
|
|
contacts - [ContactInput]!
|
Example
Query
mutation ImportContacts(
$importId: Int!,
$contacts: [ContactInput]!
) {
importContacts(
importId: $importId,
contacts: $contacts
)
}
Variables
{"importId": 123, "contacts": [ContactInput]}
Response
{"data": {"importContacts": false}}
importCustomAttributes
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
importId - Int!
|
|
contacts - [CustomAttributeInput]!
|
Example
Query
mutation ImportCustomAttributes(
$importId: Int!,
$contacts: [CustomAttributeInput]!
) {
importCustomAttributes(
importId: $importId,
contacts: $contacts
)
}
Variables
{"importId": 123, "contacts": [CustomAttributeInput]}
Response
{"data": {"importCustomAttributes": false}}
importCustomers
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
importId - Int!
|
|
customers - [CustomerInput]!
|
Example
Query
mutation ImportCustomers(
$importId: Int!,
$customers: [CustomerInput]!
) {
importCustomers(
importId: $importId,
customers: $customers
)
}
Variables
{"importId": 987, "customers": [CustomerInput]}
Response
{"data": {"importCustomers": true}}
importIPAssignments
Response
Returns an IPAssignment
Arguments
| Name | Description |
|---|---|
importId - Int
|
|
ipAssignments - [IPAssignmentInput]!
|
Example
Query
mutation ImportIPAssignments(
$importId: Int,
$ipAssignments: [IPAssignmentInput]!
) {
importIPAssignments(
importId: $importId,
ipAssignments: $ipAssignments
) {
id
subnetId
networkAddress
description
ipAddressType
interface {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
lastSeenAt
subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
DNSEntries {
id
name
ttl
recordClass
recordType
recordData
dnsZone {
...DNSZoneFragment
}
customAttributes
networkAddress
priority
status
IPAssignment {
...IPAssignmentFragment
}
}
resource {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
interfaces {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
id
status
zoneId
ipAddress
macAddress
interface
hostname
customAttributes
description
networkRequestId
networkRequest {
...NetworkRequestFragment
}
}
}
}
Variables
{"importId": 987, "ipAssignments": [IPAssignmentInput]}
Response
{
"data": {
"importIPAssignments": {
"id": 123,
"subnetId": 123,
"networkAddress": "abc123",
"description": "abc123",
"ipAddressType": "xyz789",
"interface": Interface,
"lastSeenAt": "xyz789",
"subnet": Subnet,
"DNSEntries": [DNSEntry],
"resource": Resource,
"interfaces": [Interface],
"cloudResourceId": "xyz789",
"createdAt": "xyz789",
"importBatchId": 123,
"customAttributes": {},
"request": NetworkRequestItem
}
}
}
importSites
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
importId - Int!
|
|
sites - [SiteInput]!
|
Example
Query
mutation ImportSites(
$importId: Int!,
$sites: [SiteInput]!
) {
importSites(
importId: $importId,
sites: $sites
)
}
Variables
{"importId": 987, "sites": [SiteInput]}
Response
{"data": {"importSites": true}}
importSubnets
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
importId - Int!
|
|
subnets - [SubnetInput]!
|
Example
Query
mutation ImportSubnets(
$importId: Int!,
$subnets: [SubnetInput]!
) {
importSubnets(
importId: $importId,
subnets: $subnets
)
}
Variables
{"importId": 123, "subnets": [SubnetInput]}
Response
{"data": {"importSubnets": true}}
importZones
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
importId - Int!
|
|
zones - [ZoneInput]!
|
Example
Query
mutation ImportZones(
$importId: Int!,
$zones: [ZoneInput]!
) {
importZones(
importId: $importId,
zones: $zones
)
}
Variables
{"importId": 123, "zones": [ZoneInput]}
Response
{"data": {"importZones": false}}
refreshSubnet
Example
Query
mutation RefreshSubnet($id: Int!) {
refreshSubnet(id: $id) {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
id
name
description
VRF
providerId
provider {
...ProviderFragment
}
parentZone {
...ZoneFragment
}
cloudResourceId
importBatchId
customAttributes
}
provider {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
vlan {
id
number
}
pollable
broadcast
customers {
id
name
importId
importBatchId
addresses {
...AddressFragment
}
sites {
...SiteFragment
}
customAttributes
}
Contacts {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
site {
id
name
importBatchId
subnetId
addresses {
...AddressFragment
}
customAttributes
}
supportGroups {
id
name
description
contacts {
...ContactFragment
}
customAttributes
}
subnets {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
supernet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
id
sourceNatAddress
destinationNatAddress
natType
sourcePort
sourceNatZoneId
destinationPort
destinationNatZoneId
sourceType
destinationType
subnetId
}
customAttributes
inUse
}
}
Variables
{"id": 987}
Response
{
"data": {
"refreshSubnet": {
"id": 123,
"status": "xyz789",
"planId": 987,
"name": "xyz789",
"description": "xyz789",
"direction": "abc123",
"networkAddress": "xyz789",
"host": "xyz789",
"defaultGatewayId": 123,
"supernetId": 123,
"defaultGateway": "abc123",
"zone": Zone,
"provider": Provider,
"vlan": VLAN,
"pollable": false,
"broadcast": "xyz789",
"customers": [Customer],
"Contacts": [Contact],
"site": Site,
"supportGroups": [SupportGroup],
"subnets": [Subnet],
"supernet": Subnet,
"syncStatus": "xyz789",
"lastSynchronizedAt": "xyz789",
"syncError": "xyz789",
"cloudResourceId": "xyz789",
"importBatchId": 987,
"nat": [NAT],
"customAttributes": {},
"inUse": 987
}
}
}
removeContactFromSubnet
Response
Returns a Boolean
Example
Query
mutation RemoveContactFromSubnet(
$subnetId: Int!,
$contactId: Int!,
$contactName: String,
$networkAddress: String,
$zoneId: Int
) {
removeContactFromSubnet(
subnetId: $subnetId,
contactId: $contactId,
contactName: $contactName,
networkAddress: $networkAddress,
zoneId: $zoneId
)
}
Variables
{
"subnetId": 987,
"contactId": 987,
"contactName": "xyz789",
"networkAddress": "xyz789",
"zoneId": 123
}
Response
{"data": {"removeContactFromSubnet": true}}
removeContactFromSupportGroup
Example
Query
mutation RemoveContactFromSupportGroup(
$id: Int!,
$contactId: Int!
) {
removeContactFromSupportGroup(
id: $id,
contactId: $contactId
)
}
Variables
{"id": 123, "contactId": 987}
Response
{"data": {"removeContactFromSupportGroup": true}}
removeCustomerFromSubnet
Response
Returns a Boolean
Example
Query
mutation RemoveCustomerFromSubnet(
$customerId: Int!,
$subnetId: Int!,
$customerName: String,
$networkAddress: String,
$zoneId: Int
) {
removeCustomerFromSubnet(
customerId: $customerId,
subnetId: $subnetId,
customerName: $customerName,
networkAddress: $networkAddress,
zoneId: $zoneId
)
}
Variables
{
"customerId": 987,
"subnetId": 123,
"customerName": "xyz789",
"networkAddress": "xyz789",
"zoneId": 987
}
Response
{"data": {"removeCustomerFromSubnet": false}}
removeSupportGroupFromSubnet
Response
Returns a Boolean
Example
Query
mutation RemoveSupportGroupFromSubnet(
$supportGroupId: Int!,
$subnetId: Int!,
$supportGroupName: String,
$networkAddress: String,
$zoneId: Int
) {
removeSupportGroupFromSubnet(
supportGroupId: $supportGroupId,
subnetId: $subnetId,
supportGroupName: $supportGroupName,
networkAddress: $networkAddress,
zoneId: $zoneId
)
}
Variables
{
"supportGroupId": 123,
"subnetId": 123,
"supportGroupName": "abc123",
"networkAddress": "xyz789",
"zoneId": 987
}
Response
{"data": {"removeSupportGroupFromSubnet": false}}
removeUser
removeUserFromUserGroup
removeUserGroupFromSubnet
Example
Query
mutation RemoveUserGroupFromSubnet(
$userGroupId: Int!,
$subnetId: Int!
) {
removeUserGroupFromSubnet(
userGroupId: $userGroupId,
subnetId: $subnetId
)
}
Variables
{"userGroupId": 123, "subnetId": 123}
Response
{"data": {"removeUserGroupFromSubnet": true}}
revokeApiKey
selfDestroyUser
Response
Returns a Boolean
Example
Query
mutation SelfDestroyUser {
selfDestroyUser
}
Response
{"data": {"selfDestroyUser": false}}
sendEmail
Response
Returns an EmailResponse
Example
Query
mutation SendEmail(
$userIds: [Int],
$subjectLine: String,
$body: String,
$buttonText: String,
$buttonLink: String,
$imageURL: String,
$sendAll: Boolean,
$emailType: String
) {
sendEmail(
userIds: $userIds,
subjectLine: $subjectLine,
body: $body,
buttonText: $buttonText,
buttonLink: $buttonLink,
imageURL: $imageURL,
sendAll: $sendAll,
emailType: $emailType
) {
emailSent
}
}
Variables
{
"userIds": [987],
"subjectLine": "xyz789",
"body": "abc123",
"buttonText": "xyz789",
"buttonLink": "xyz789",
"imageURL": "abc123",
"sendAll": false,
"emailType": "abc123"
}
Response
{"data": {"sendEmail": {"emailSent": 123}}}
sync
Response
Returns a Scan
Example
Query
mutation Sync(
$subnetId: Int!,
$fileName: String,
$result: String,
$sourceType: String,
$createAssignments: Boolean,
$ipData: [IPStatusInput]!
) {
sync(
subnetId: $subnetId,
fileName: $fileName,
result: $result,
sourceType: $sourceType,
createAssignments: $createAssignments,
ipData: $ipData
) {
id
subnetId
zoneId
networkAddress
hostname
macAddress
interface
scannedAt
scanCommand
customAttributes
ignore
sourceType
sourceVersion
fileName
result
userId
}
}
Variables
{
"subnetId": 987,
"fileName": "xyz789",
"result": "abc123",
"sourceType": "xyz789",
"createAssignments": true,
"ipData": [IPStatusInput]
}
Response
{
"data": {
"sync": {
"id": 123,
"subnetId": 123,
"zoneId": 123,
"networkAddress": "xyz789",
"hostname": "xyz789",
"macAddress": "abc123",
"interface": "xyz789",
"scannedAt": "2007-12-03",
"scanCommand": "xyz789",
"customAttributes": {},
"ignore": false,
"sourceType": "abc123",
"sourceVersion": "abc123",
"fileName": "abc123",
"result": "xyz789",
"userId": 123
}
}
}
syncProvider
updateAlert
Response
Returns an Alert
Example
Query
mutation UpdateAlert(
$id: Int,
$SubnetId: Int,
$UserId: Int,
$AlertRuleId: Int,
$status: String,
$type: String,
$name: String,
$description: String,
$clearNotification: Boolean
) {
updateAlert(
id: $id,
SubnetId: $SubnetId,
UserId: $UserId,
AlertRuleId: $AlertRuleId,
status: $status,
type: $type,
name: $name,
description: $description,
clearNotification: $clearNotification
) {
id
SubnetId
UserId
AlertRuleId
status
type
name
Subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
description
message
clearNotification
}
}
Variables
{
"id": 123,
"SubnetId": 987,
"UserId": 987,
"AlertRuleId": 123,
"status": "abc123",
"type": "abc123",
"name": "xyz789",
"description": "xyz789",
"clearNotification": true
}
Response
{
"data": {
"updateAlert": {
"id": 987,
"SubnetId": 123,
"UserId": 123,
"AlertRuleId": 987,
"status": "xyz789",
"type": "xyz789",
"name": "abc123",
"Subnet": Subnet,
"description": "abc123",
"message": "xyz789",
"clearNotification": true
}
}
}
updateAlertDestination
Response
Returns an AlertDestination
Example
Query
mutation UpdateAlertDestination(
$id: Int!,
$name: String,
$URL: String,
$verificationCode: String,
$slackChannel: String,
$status: String,
$email: String,
$options: JSON
) {
updateAlertDestination(
id: $id,
name: $name,
URL: $URL,
verificationCode: $verificationCode,
slackChannel: $slackChannel,
status: $status,
email: $email,
options: $options
) {
name
id
type
URL
slackChannel
email
status
verificationCode
options
createdAt
}
}
Variables
{
"id": 987,
"name": "abc123",
"URL": "xyz789",
"verificationCode": "xyz789",
"slackChannel": "abc123",
"status": "xyz789",
"email": "abc123",
"options": {}
}
Response
{
"data": {
"updateAlertDestination": {
"name": "xyz789",
"id": 123,
"type": "xyz789",
"URL": "xyz789",
"slackChannel": "xyz789",
"email": "abc123",
"status": "xyz789",
"verificationCode": "abc123",
"options": {},
"createdAt": "xyz789"
}
}
}
updateAlertRecipient
Response
Returns an AlertRecipient
Arguments
| Name | Description |
|---|---|
id - Int
|
|
alertRecipient - [AlertRecipientInput]
|
Example
Query
mutation UpdateAlertRecipient(
$id: Int,
$alertRecipient: [AlertRecipientInput]
) {
updateAlertRecipient(
id: $id,
alertRecipient: $alertRecipient
) {
id
UserId
userName
AlertRuleId
rules {
id
SubnetId
ZoneId
networkAddress
status
type
name
description
conditions
subnet {
...SubnetFragment
}
AlertDestinations {
...AlertDestinationFragment
}
AlertRecipientId
AlertRecipients {
...AlertRecipientFragment
}
recipients {
...AlertRecipientFragment
}
}
}
}
Variables
{"id": 987, "alertRecipient": [AlertRecipientInput]}
Response
{
"data": {
"updateAlertRecipient": {
"id": 987,
"UserId": 987,
"userName": "xyz789",
"AlertRuleId": 987,
"rules": [AlertRule]
}
}
}
updateAlertRule
Response
Returns an AlertRule
Arguments
| Name | Description |
|---|---|
id - Int
|
|
alerts - [AlertRuleInput]
|
|
alertRecipientIds - [Int]
|
Example
Query
mutation UpdateAlertRule(
$id: Int,
$alerts: [AlertRuleInput],
$alertRecipientIds: [Int]
) {
updateAlertRule(
id: $id,
alerts: $alerts,
alertRecipientIds: $alertRecipientIds
) {
id
SubnetId
ZoneId
networkAddress
status
type
name
description
conditions
subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
AlertDestinations {
name
id
type
URL
slackChannel
email
status
verificationCode
options
createdAt
}
AlertRecipientId
AlertRecipients {
id
UserId
userName
AlertRuleId
rules {
...AlertRuleFragment
}
}
recipients {
id
UserId
userName
AlertRuleId
rules {
...AlertRuleFragment
}
}
}
}
Variables
{
"id": 123,
"alerts": [AlertRuleInput],
"alertRecipientIds": [987]
}
Response
{
"data": {
"updateAlertRule": {
"id": 123,
"SubnetId": 987,
"ZoneId": 987,
"networkAddress": "abc123",
"status": "abc123",
"type": "abc123",
"name": "abc123",
"description": "abc123",
"conditions": {},
"subnet": Subnet,
"AlertDestinations": [AlertDestination],
"AlertRecipientId": 987,
"AlertRecipients": [AlertRecipient],
"recipients": [AlertRecipient]
}
}
}
updateContact
Response
Returns a Contact
Example
Query
mutation UpdateContact(
$id: Int!,
$firstName: String,
$lastName: String,
$phone: String,
$cellPhone: String,
$email: String,
$email2: String,
$SupportGroupId: Int,
$customAttributes: JSON
) {
updateContact(
id: $id,
firstName: $firstName,
lastName: $lastName,
phone: $phone,
cellPhone: $cellPhone,
email: $email,
email2: $email2,
SupportGroupId: $SupportGroupId,
customAttributes: $customAttributes
) {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
id
name
description
contacts {
...ContactFragment
}
customAttributes
}
customAttributes
}
}
Variables
{
"id": 987,
"firstName": "xyz789",
"lastName": "abc123",
"phone": "abc123",
"cellPhone": "xyz789",
"email": "abc123",
"email2": "xyz789",
"SupportGroupId": 987,
"customAttributes": {}
}
Response
{
"data": {
"updateContact": {
"id": 987,
"firstName": "abc123",
"lastName": "abc123",
"phone": "abc123",
"cellPhone": "xyz789",
"email": "xyz789",
"email2": "xyz789",
"importBatchId": 987,
"SupportGroupId": 987,
"supportGroup": SupportGroup,
"customAttributes": {}
}
}
}
updateCustomAttribute
Response
Returns a CustomAttribute
Example
Query
mutation UpdateCustomAttribute(
$id: Int!,
$modelName: String,
$name: String,
$type: String,
$required: Boolean,
$sectionId: Int,
$rowIndex: Int,
$rowColSpan: Int,
$colIndex: Int,
$colSpan: Int,
$component: String
) {
updateCustomAttribute(
id: $id,
modelName: $modelName,
name: $name,
type: $type,
required: $required,
sectionId: $sectionId,
rowIndex: $rowIndex,
rowColSpan: $rowColSpan,
colIndex: $colIndex,
colSpan: $colSpan,
component: $component
) {
id
modelName
name
type
required
sectionId
rowIndex
rowColSpan
colIndex
colSpan
component
}
}
Variables
{
"id": 123,
"modelName": "xyz789",
"name": "abc123",
"type": "xyz789",
"required": true,
"sectionId": 987,
"rowIndex": 123,
"rowColSpan": 987,
"colIndex": 123,
"colSpan": 987,
"component": "abc123"
}
Response
{
"data": {
"updateCustomAttribute": {
"id": 987,
"modelName": "xyz789",
"name": "xyz789",
"type": "abc123",
"required": false,
"sectionId": 987,
"rowIndex": 987,
"rowColSpan": 987,
"colIndex": 123,
"colSpan": 987,
"component": "xyz789"
}
}
}
updateCustomer
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
id - Int!
|
|
name - String!
|
|
addresses - [AddressInput]
|
|
customAttributes - JSON
|
Example
Query
mutation UpdateCustomer(
$id: Int!,
$name: String!,
$addresses: [AddressInput],
$customAttributes: JSON
) {
updateCustomer(
id: $id,
name: $name,
addresses: $addresses,
customAttributes: $customAttributes
) {
id
name
importId
importBatchId
addresses {
id
line1
line2
line3
line4
municipality
province
country
postalCode
}
sites {
id
name
importBatchId
subnetId
addresses {
...AddressFragment
}
customAttributes
}
customAttributes
}
}
Variables
{
"id": 987,
"name": "abc123",
"addresses": [AddressInput],
"customAttributes": {}
}
Response
{
"data": {
"updateCustomer": {
"id": 987,
"name": "abc123",
"importId": 123,
"importBatchId": 123,
"addresses": [Address],
"sites": [Site],
"customAttributes": {}
}
}
}
updateDNSEntry
Response
Returns an DNSEntry
Example
Query
mutation UpdateDNSEntry(
$id: Int!,
$name: String!,
$ttl: Int,
$recordClass: String,
$recordType: String,
$recordData: String,
$customAttributes: JSON,
$networkAddress: String,
$priority: Int,
$status: String
) {
updateDNSEntry(
id: $id,
name: $name,
ttl: $ttl,
recordClass: $recordClass,
recordType: $recordType,
recordData: $recordData,
customAttributes: $customAttributes,
networkAddress: $networkAddress,
priority: $priority,
status: $status
) {
id
name
ttl
recordClass
recordType
recordData
dnsZone {
name
dnsServer {
...DNSServerFragment
}
}
customAttributes
networkAddress
priority
status
IPAssignment {
id
subnetId
networkAddress
description
ipAddressType
interface {
...InterfaceFragment
}
lastSeenAt
subnet {
...SubnetFragment
}
DNSEntries {
...DNSEntryFragment
}
resource {
...ResourceFragment
}
interfaces {
...InterfaceFragment
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
...NetworkRequestItemFragment
}
}
}
}
Variables
{
"id": 123,
"name": "abc123",
"ttl": 123,
"recordClass": "abc123",
"recordType": "xyz789",
"recordData": "abc123",
"customAttributes": {},
"networkAddress": "abc123",
"priority": 987,
"status": "abc123"
}
Response
{
"data": {
"updateDNSEntry": {
"id": 123,
"name": "xyz789",
"ttl": 987,
"recordClass": "xyz789",
"recordType": "abc123",
"recordData": "xyz789",
"dnsZone": [DNSZone],
"customAttributes": {},
"networkAddress": "abc123",
"priority": 123,
"status": "xyz789",
"IPAssignment": IPAssignment
}
}
}
updateIPAssignment
Response
Returns an IPAssignment
Arguments
| Name | Description |
|---|---|
id - Int!
|
|
description - String
|
|
ipAddressType - String
|
|
dnsEntries - [DNSEntryInput]
|
|
resource - ResourceInput
|
|
interfaceId - Int
|
|
customAttributes - JSON
|
Example
Query
mutation UpdateIPAssignment(
$id: Int!,
$description: String,
$ipAddressType: String,
$dnsEntries: [DNSEntryInput],
$resource: ResourceInput,
$interfaceId: Int,
$customAttributes: JSON
) {
updateIPAssignment(
id: $id,
description: $description,
ipAddressType: $ipAddressType,
dnsEntries: $dnsEntries,
resource: $resource,
interfaceId: $interfaceId,
customAttributes: $customAttributes
) {
id
subnetId
networkAddress
description
ipAddressType
interface {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
lastSeenAt
subnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
DNSEntries {
id
name
ttl
recordClass
recordType
recordData
dnsZone {
...DNSZoneFragment
}
customAttributes
networkAddress
priority
status
IPAssignment {
...IPAssignmentFragment
}
}
resource {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
interfaces {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
id
status
zoneId
ipAddress
macAddress
interface
hostname
customAttributes
description
networkRequestId
networkRequest {
...NetworkRequestFragment
}
}
}
}
Variables
{
"id": 123,
"description": "abc123",
"ipAddressType": "abc123",
"dnsEntries": [DNSEntryInput],
"resource": ResourceInput,
"interfaceId": 987,
"customAttributes": {}
}
Response
{
"data": {
"updateIPAssignment": {
"id": 987,
"subnetId": 987,
"networkAddress": "xyz789",
"description": "abc123",
"ipAddressType": "xyz789",
"interface": Interface,
"lastSeenAt": "abc123",
"subnet": Subnet,
"DNSEntries": [DNSEntry],
"resource": Resource,
"interfaces": [Interface],
"cloudResourceId": "xyz789",
"createdAt": "xyz789",
"importBatchId": 987,
"customAttributes": {},
"request": NetworkRequestItem
}
}
}
updateImport
Example
Query
mutation UpdateImport(
$id: Int!,
$description: String
) {
updateImport(
id: $id,
description: $description
) {
id
description
customer_count
contact_count
site_count
zone_count
subnet_count
ip_assignment_count
records {
id
type
display
value
}
}
}
Variables
{"id": 123, "description": "abc123"}
Response
{
"data": {
"updateImport": {
"id": 123,
"description": "abc123",
"customer_count": 123,
"contact_count": 987,
"site_count": 987,
"zone_count": 123,
"subnet_count": 987,
"ip_assignment_count": 123,
"records": [ImportRecord]
}
}
}
updateInterface
Example
Query
mutation UpdateInterface($name: String!) {
updateInterface(name: $name) {
id
name
macAddress
resource {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
...ProviderFragment
}
lastSeenAt
ResourceStatus {
...ResourceStatusFragment
}
resourceType {
...ResourceTypeFragment
}
interfaces {
...InterfaceFragment
}
createdAt
}
ipAssignment {
id
subnetId
networkAddress
description
ipAddressType
interface {
...InterfaceFragment
}
lastSeenAt
subnet {
...SubnetFragment
}
DNSEntries {
...DNSEntryFragment
}
resource {
...ResourceFragment
}
interfaces {
...InterfaceFragment
}
cloudResourceId
createdAt
importBatchId
customAttributes
request {
...NetworkRequestItemFragment
}
}
cloudResourceId
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"updateInterface": {
"id": 123,
"name": "abc123",
"macAddress": "xyz789",
"resource": Resource,
"ipAssignment": IPAssignment,
"cloudResourceId": "xyz789"
}
}
}
updateLocation
Example
Query
mutation UpdateLocation(
$id: Int!,
$name: String
) {
updateLocation(
id: $id,
name: $name
) {
id
name
}
}
Variables
{"id": 123, "name": "abc123"}
Response
{
"data": {
"updateLocation": {
"id": 987,
"name": "abc123"
}
}
}
updateNat
Response
Returns an NAT
Example
Query
mutation UpdateNat(
$id: Int!,
$sourceNatAddress: String,
$destinationNatAddress: [String],
$subnetId: Int,
$natType: String,
$sourcePort: Int,
$sourceNatZoneId: Int,
$destinationPort: Int,
$destinationNatZoneId: Int,
$sourceType: String,
$destinationType: String
) {
updateNat(
id: $id,
sourceNatAddress: $sourceNatAddress,
destinationNatAddress: $destinationNatAddress,
subnetId: $subnetId,
natType: $natType,
sourcePort: $sourcePort,
sourceNatZoneId: $sourceNatZoneId,
destinationPort: $destinationPort,
destinationNatZoneId: $destinationNatZoneId,
sourceType: $sourceType,
destinationType: $destinationType
) {
id
sourceNatAddress
destinationNatAddress
natType
sourcePort
sourceNatZoneId
destinationPort
destinationNatZoneId
sourceType
destinationType
subnetId
}
}
Variables
{
"id": 123,
"sourceNatAddress": "abc123",
"destinationNatAddress": ["abc123"],
"subnetId": 123,
"natType": "abc123",
"sourcePort": 123,
"sourceNatZoneId": 987,
"destinationPort": 987,
"destinationNatZoneId": 987,
"sourceType": "abc123",
"destinationType": "abc123"
}
Response
{
"data": {
"updateNat": {
"id": 123,
"sourceNatAddress": "xyz789",
"destinationNatAddress": ["abc123"],
"natType": "xyz789",
"sourcePort": 987,
"sourceNatZoneId": 987,
"destinationPort": 987,
"destinationNatZoneId": 123,
"sourceType": "abc123",
"destinationType": "abc123",
"subnetId": 123
}
}
}
updateNetworkRequest
Response
Returns a NetworkRequest
Example
Query
mutation UpdateNetworkRequest(
$id: Int,
$status: String,
$zoneId: Int,
$details: String,
$ipAddressCount: Int,
$subnetId: Int,
$NetworkRequestItems: [NetworkRequestItemInput]
) {
updateNetworkRequest(
id: $id,
status: $status,
zoneId: $zoneId,
details: $details,
ipAddressCount: $ipAddressCount,
subnetId: $subnetId,
NetworkRequestItems: $NetworkRequestItems
) {
id
status
ipAddressCount
details
networkAddress
zoneId
subnetId
NetworkRequestItems {
id
status
zoneId
ipAddress
macAddress
interface
hostname
customAttributes
description
networkRequestId
networkRequest {
...NetworkRequestFragment
}
}
createdAt
}
}
Variables
{
"id": 123,
"status": "xyz789",
"zoneId": 123,
"details": "xyz789",
"ipAddressCount": 987,
"subnetId": 987,
"NetworkRequestItems": [NetworkRequestItemInput]
}
Response
{
"data": {
"updateNetworkRequest": {
"id": 987,
"status": "xyz789",
"ipAddressCount": 123,
"details": "abc123",
"networkAddress": "abc123",
"zoneId": "xyz789",
"subnetId": 987,
"NetworkRequestItems": [NetworkRequestItem],
"createdAt": "abc123"
}
}
}
updatePlannedChange
Response
Returns a PlannedChange
Example
Query
mutation UpdatePlannedChange(
$id: Int!,
$planId: Int!,
$description: String,
$sourceId: Int,
$sourceType: String,
$sourceNetworkAddress: String,
$destinationId: Int,
$destinationType: String,
$destinationNetworkAddress: String,
$status: String
) {
updatePlannedChange(
id: $id,
planId: $planId,
description: $description,
sourceId: $sourceId,
sourceType: $sourceType,
sourceNetworkAddress: $sourceNetworkAddress,
destinationId: $destinationId,
destinationType: $destinationType,
destinationNetworkAddress: $destinationNetworkAddress,
status: $status
) {
id
planId
description
sourceId
sourceType
sourceNetworkAddress
destinationId
destinationType
destinationNetworkAddress
status
date
sourceSubnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
destinationSubnet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
}
}
Variables
{
"id": 123,
"planId": 123,
"description": "abc123",
"sourceId": 987,
"sourceType": "abc123",
"sourceNetworkAddress": "xyz789",
"destinationId": 987,
"destinationType": "abc123",
"destinationNetworkAddress": "abc123",
"status": "xyz789"
}
Response
{
"data": {
"updatePlannedChange": {
"id": 987,
"planId": 987,
"description": "xyz789",
"sourceId": 123,
"sourceType": "abc123",
"sourceNetworkAddress": "abc123",
"destinationId": 987,
"destinationType": "xyz789",
"destinationNetworkAddress": "abc123",
"status": "xyz789",
"date": "abc123",
"sourceSubnet": Subnet,
"destinationSubnet": Subnet
}
}
}
updateProvider
Response
Returns a Provider
Example
Query
mutation UpdateProvider(
$id: Int!,
$name: String,
$active: Boolean,
$azureAppId: String,
$azurePassword: String,
$azureTenantId: String,
$awsAccessKeyId: String,
$awsSecretAccessKey: String,
$awsSessionToken: String,
$customAttributes: JSON
) {
updateProvider(
id: $id,
name: $name,
active: $active,
azureAppId: $azureAppId,
azurePassword: $azurePassword,
azureTenantId: $azureTenantId,
awsAccessKeyId: $awsAccessKeyId,
awsSecretAccessKey: $awsSecretAccessKey,
awsSessionToken: $awsSessionToken,
customAttributes: $customAttributes
) {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
}
Variables
{
"id": 123,
"name": "abc123",
"active": false,
"azureAppId": "abc123",
"azurePassword": "xyz789",
"azureTenantId": "xyz789",
"awsAccessKeyId": "abc123",
"awsSecretAccessKey": "xyz789",
"awsSessionToken": "abc123",
"customAttributes": {}
}
Response
{
"data": {
"updateProvider": {
"id": 987,
"name": "abc123",
"active": false,
"type": "abc123",
"azureAppId": "abc123",
"azurePassword": "xyz789",
"azureTenantId": "xyz789",
"awsAccessKeyId": "abc123",
"awsSecretAccessKey": "xyz789",
"awsSessionToken": "xyz789",
"lastSynchronizedAt": "abc123",
"syncStatus": "abc123",
"syncError": "abc123",
"subnetCount": 987,
"ipCount": 987,
"resourceCount": 123,
"createdAt": "abc123",
"customAttributes": {}
}
}
}
updateReservation
Response
Returns a Reservation
Arguments
| Name | Description |
|---|---|
id - Int
|
|
description - String
|
|
name - String
|
|
color - String
|
|
ipAddresses - [IPAddressInput]
|
Example
Query
mutation UpdateReservation(
$id: Int,
$description: String,
$name: String,
$color: String,
$ipAddresses: [IPAddressInput]
) {
updateReservation(
id: $id,
description: $description,
name: $name,
color: $color,
ipAddresses: $ipAddresses
) {
id
name
description
color
ipAddresses {
id
networkAddress
ipAddressType
ipAssignment {
...IPAssignmentFragment
}
expirationDate
reservation {
...ReservationFragment
}
request {
...NetworkRequestItemFragment
}
scanResults {
...ScanResultFragment
}
inUse
subnet {
...SubnetFragment
}
zone {
...ZoneFragment
}
}
subnetId
}
}
Variables
{
"id": 987,
"description": "xyz789",
"name": "xyz789",
"color": "abc123",
"ipAddresses": [IPAddressInput]
}
Response
{
"data": {
"updateReservation": {
"id": 123,
"name": "abc123",
"description": "abc123",
"color": "xyz789",
"ipAddresses": [IPAddress],
"subnetId": 123
}
}
}
updateResource
Response
Returns a Resource
Example
Query
mutation UpdateResource(
$id: Int!,
$hostname: String,
$OS: String,
$OSVersion: String,
$macAddress: String,
$interface: InterfaceInput
) {
updateResource(
id: $id,
hostname: $hostname,
OS: $OS,
OSVersion: $OSVersion,
macAddress: $macAddress,
interface: $interface
) {
id
hostname
OS
OSVersion
macAddress
cloudResourceId
resourceGroupId
resourceTypeId
provider {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
lastSeenAt
ResourceStatus {
id
name
}
resourceType {
id
name
}
interfaces {
id
name
macAddress
resource {
...ResourceFragment
}
ipAssignment {
...IPAssignmentFragment
}
cloudResourceId
}
createdAt
}
}
Variables
{
"id": 987,
"hostname": "abc123",
"OS": "xyz789",
"OSVersion": "xyz789",
"macAddress": "abc123",
"interface": InterfaceInput
}
Response
{
"data": {
"updateResource": {
"id": 123,
"hostname": "abc123",
"OS": "xyz789",
"OSVersion": "xyz789",
"macAddress": "xyz789",
"cloudResourceId": "abc123",
"resourceGroupId": "xyz789",
"resourceTypeId": 123,
"provider": Provider,
"lastSeenAt": "xyz789",
"ResourceStatus": ResourceStatus,
"resourceType": ResourceType,
"interfaces": [Interface],
"createdAt": "xyz789"
}
}
}
updateResourceStatus
Response
Returns a ResourceStatus
Arguments
| Name | Description |
|---|---|
id - Int
|
|
resourceStatuses - [ResourceStatusInput]
|
Example
Query
mutation UpdateResourceStatus(
$id: Int,
$resourceStatuses: [ResourceStatusInput]
) {
updateResourceStatus(
id: $id,
resourceStatuses: $resourceStatuses
) {
id
name
}
}
Variables
{"id": 123, "resourceStatuses": [ResourceStatusInput]}
Response
{
"data": {
"updateResourceStatus": {
"id": 987,
"name": "abc123"
}
}
}
updateResourceType
Response
Returns a ResourceType
Arguments
| Name | Description |
|---|---|
id - Int
|
|
resourceType - ResourceTypeInput
|
Example
Query
mutation UpdateResourceType(
$id: Int,
$resourceType: ResourceTypeInput
) {
updateResourceType(
id: $id,
resourceType: $resourceType
) {
id
name
}
}
Variables
{"id": 987, "resourceType": ResourceTypeInput}
Response
{
"data": {
"updateResourceType": {
"id": 123,
"name": "abc123"
}
}
}
updateRoleAssignment
Response
Returns a RoleAssignment
Example
Query
mutation UpdateRoleAssignment(
$id: Int!,
$subjectId: Int!,
$subjectType: String!,
$roleId: Int!,
$recordId: Int,
$recordType: String
) {
updateRoleAssignment(
id: $id,
subjectId: $subjectId,
subjectType: $subjectType,
roleId: $roleId,
recordId: $recordId,
recordType: $recordType
) {
id
subjectId
subjectType
recordId
recordType
networkAddress
zoneId
userGroup {
id
name
description
}
role {
id
name
description
plans {
...PlanFragment
}
}
}
}
Variables
{
"id": 987,
"subjectId": 123,
"subjectType": "xyz789",
"roleId": 987,
"recordId": 987,
"recordType": "abc123"
}
Response
{
"data": {
"updateRoleAssignment": {
"id": 123,
"subjectId": 987,
"subjectType": "xyz789",
"recordId": "xyz789",
"recordType": "abc123",
"networkAddress": "xyz789",
"zoneId": 987,
"userGroup": UserGroup,
"role": Role
}
}
}
updateScan
Response
Returns a Scan
Example
Query
mutation UpdateScan(
$id: Int,
$sourceType: String,
$sourceVersion: String,
$scanCommand: String,
$networkAddress: String,
$customAttributes: JSON,
$scannedAt: Date
) {
updateScan(
id: $id,
sourceType: $sourceType,
sourceVersion: $sourceVersion,
scanCommand: $scanCommand,
networkAddress: $networkAddress,
customAttributes: $customAttributes,
scannedAt: $scannedAt
) {
id
subnetId
zoneId
networkAddress
hostname
macAddress
interface
scannedAt
scanCommand
customAttributes
ignore
sourceType
sourceVersion
fileName
result
userId
}
}
Variables
{
"id": 123,
"sourceType": "abc123",
"sourceVersion": "xyz789",
"scanCommand": "abc123",
"networkAddress": "xyz789",
"customAttributes": {},
"scannedAt": "2007-12-03"
}
Response
{
"data": {
"updateScan": {
"id": 987,
"subnetId": 987,
"zoneId": 987,
"networkAddress": "abc123",
"hostname": "xyz789",
"macAddress": "abc123",
"interface": "abc123",
"scannedAt": "2007-12-03",
"scanCommand": "abc123",
"customAttributes": {},
"ignore": true,
"sourceType": "xyz789",
"sourceVersion": "xyz789",
"fileName": "abc123",
"result": "abc123",
"userId": 123
}
}
}
updateScanResult
Response
Returns a ScanResult
Example
Query
mutation UpdateScanResult(
$id: Int,
$ignore: Boolean
) {
updateScanResult(
id: $id,
ignore: $ignore
) {
id
subnetId
zoneId
networkAddress
hostname
resourceType
macAddress
cloudResourceId
interface
scannedAt
ScanId
customAttributes
ignore
sourceType
sourceVersion
fileName
result
ipAssignmentId
}
}
Variables
{"id": 987, "ignore": false}
Response
{
"data": {
"updateScanResult": {
"id": 123,
"subnetId": 123,
"zoneId": 987,
"networkAddress": "xyz789",
"hostname": "abc123",
"resourceType": "xyz789",
"macAddress": "xyz789",
"cloudResourceId": "xyz789",
"interface": "xyz789",
"scannedAt": "2007-12-03",
"ScanId": 123,
"customAttributes": {},
"ignore": false,
"sourceType": "abc123",
"sourceVersion": "xyz789",
"fileName": "xyz789",
"result": "abc123",
"ipAssignmentId": 123
}
}
}
updateSite
Response
Returns a Site
Arguments
| Name | Description |
|---|---|
id - Int!
|
|
name - String
|
|
customAttributes - JSON
|
|
addresses - [AddressInput]
|
Example
Query
mutation UpdateSite(
$id: Int!,
$name: String,
$customAttributes: JSON,
$addresses: [AddressInput]
) {
updateSite(
id: $id,
name: $name,
customAttributes: $customAttributes,
addresses: $addresses
) {
id
name
importBatchId
subnetId
addresses {
id
line1
line2
line3
line4
municipality
province
country
postalCode
}
customAttributes
}
}
Variables
{
"id": 987,
"name": "xyz789",
"customAttributes": {},
"addresses": [AddressInput]
}
Response
{
"data": {
"updateSite": {
"id": 987,
"name": "xyz789",
"importBatchId": 987,
"subnetId": 987,
"addresses": [Address],
"customAttributes": {}
}
}
}
updateSubnet
Response
Returns a Subnet
Arguments
| Name | Description |
|---|---|
id - Int!
|
|
status - String
|
|
name - String
|
|
direction - String
|
|
description - String
|
|
networkAddress - String
|
|
defaultGatewayId - Int
|
|
zoneId - Int
|
|
supernetId - Int
|
|
defaultGateway - String
|
|
VLANId - Int
|
|
VLANNumber - Int
|
|
zoneName - String
|
|
siteId - Int
|
|
gatewayId - Int
|
|
customerIds - [Int]
|
|
supportGroupIds - [Int]
|
|
customAttributes - JSON
|
Example
Query
mutation UpdateSubnet(
$id: Int!,
$status: String,
$name: String,
$direction: String,
$description: String,
$networkAddress: String,
$defaultGatewayId: Int,
$zoneId: Int,
$supernetId: Int,
$defaultGateway: String,
$VLANId: Int,
$VLANNumber: Int,
$zoneName: String,
$siteId: Int,
$gatewayId: Int,
$customerIds: [Int],
$supportGroupIds: [Int],
$customAttributes: JSON
) {
updateSubnet(
id: $id,
status: $status,
name: $name,
direction: $direction,
description: $description,
networkAddress: $networkAddress,
defaultGatewayId: $defaultGatewayId,
zoneId: $zoneId,
supernetId: $supernetId,
defaultGateway: $defaultGateway,
VLANId: $VLANId,
VLANNumber: $VLANNumber,
zoneName: $zoneName,
siteId: $siteId,
gatewayId: $gatewayId,
customerIds: $customerIds,
supportGroupIds: $supportGroupIds,
customAttributes: $customAttributes
) {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
id
name
description
VRF
providerId
provider {
...ProviderFragment
}
parentZone {
...ZoneFragment
}
cloudResourceId
importBatchId
customAttributes
}
provider {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
vlan {
id
number
}
pollable
broadcast
customers {
id
name
importId
importBatchId
addresses {
...AddressFragment
}
sites {
...SiteFragment
}
customAttributes
}
Contacts {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
site {
id
name
importBatchId
subnetId
addresses {
...AddressFragment
}
customAttributes
}
supportGroups {
id
name
description
contacts {
...ContactFragment
}
customAttributes
}
subnets {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
supernet {
id
status
planId
name
description
direction
networkAddress
host
defaultGatewayId
supernetId
defaultGateway
zone {
...ZoneFragment
}
provider {
...ProviderFragment
}
vlan {
...VLANFragment
}
pollable
broadcast
customers {
...CustomerFragment
}
Contacts {
...ContactFragment
}
site {
...SiteFragment
}
supportGroups {
...SupportGroupFragment
}
subnets {
...SubnetFragment
}
supernet {
...SubnetFragment
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
...NATFragment
}
customAttributes
inUse
}
syncStatus
lastSynchronizedAt
syncError
cloudResourceId
importBatchId
nat {
id
sourceNatAddress
destinationNatAddress
natType
sourcePort
sourceNatZoneId
destinationPort
destinationNatZoneId
sourceType
destinationType
subnetId
}
customAttributes
inUse
}
}
Variables
{
"id": 987,
"status": "abc123",
"name": "xyz789",
"direction": "abc123",
"description": "xyz789",
"networkAddress": "abc123",
"defaultGatewayId": 987,
"zoneId": 123,
"supernetId": 987,
"defaultGateway": "abc123",
"VLANId": 987,
"VLANNumber": 987,
"zoneName": "xyz789",
"siteId": 123,
"gatewayId": 987,
"customerIds": [123],
"supportGroupIds": [123],
"customAttributes": {}
}
Response
{
"data": {
"updateSubnet": {
"id": 123,
"status": "abc123",
"planId": 123,
"name": "xyz789",
"description": "abc123",
"direction": "xyz789",
"networkAddress": "xyz789",
"host": "abc123",
"defaultGatewayId": 987,
"supernetId": 123,
"defaultGateway": "abc123",
"zone": Zone,
"provider": Provider,
"vlan": VLAN,
"pollable": false,
"broadcast": "abc123",
"customers": [Customer],
"Contacts": [Contact],
"site": Site,
"supportGroups": [SupportGroup],
"subnets": [Subnet],
"supernet": Subnet,
"syncStatus": "xyz789",
"lastSynchronizedAt": "abc123",
"syncError": "xyz789",
"cloudResourceId": "xyz789",
"importBatchId": 123,
"nat": [NAT],
"customAttributes": {},
"inUse": 987
}
}
}
updateSupportGroup
Response
Returns a SupportGroup
Example
Query
mutation UpdateSupportGroup(
$id: Int!,
$name: String!,
$description: String,
$contactIds: [Int],
$customAttributes: JSON
) {
updateSupportGroup(
id: $id,
name: $name,
description: $description,
contactIds: $contactIds,
customAttributes: $customAttributes
) {
id
name
description
contacts {
id
firstName
lastName
phone
cellPhone
email
email2
importBatchId
SupportGroupId
supportGroup {
...SupportGroupFragment
}
customAttributes
}
customAttributes
}
}
Variables
{
"id": 987,
"name": "abc123",
"description": "abc123",
"contactIds": [987],
"customAttributes": {}
}
Response
{
"data": {
"updateSupportGroup": {
"id": 123,
"name": "abc123",
"description": "xyz789",
"contacts": [Contact],
"customAttributes": {}
}
}
}
updateUserGroup
Example
Query
mutation UpdateUserGroup(
$id: Int!,
$name: String!,
$userIds: [Int]
) {
updateUserGroup(
id: $id,
name: $name,
userIds: $userIds
) {
id
name
description
}
}
Variables
{
"id": 123,
"name": "abc123",
"userIds": [123]
}
Response
{
"data": {
"updateUserGroup": {
"id": 123,
"name": "abc123",
"description": "xyz789"
}
}
}
updateVLAN
updateZone
Response
Returns a Zone
Example
Query
mutation UpdateZone(
$id: Int!,
$name: String!,
$description: String,
$providerId: Int,
$VRF: String,
$customAttributes: JSON
) {
updateZone(
id: $id,
name: $name,
description: $description,
providerId: $providerId,
VRF: $VRF,
customAttributes: $customAttributes
) {
id
name
description
VRF
providerId
provider {
id
name
active
type
azureAppId
azurePassword
azureTenantId
awsAccessKeyId
awsSecretAccessKey
awsSessionToken
lastSynchronizedAt
syncStatus
syncError
subnetCount
ipCount
resourceCount
createdAt
customAttributes
}
parentZone {
id
name
description
VRF
providerId
provider {
...ProviderFragment
}
parentZone {
...ZoneFragment
}
cloudResourceId
importBatchId
customAttributes
}
cloudResourceId
importBatchId
customAttributes
}
}
Variables
{
"id": 123,
"name": "xyz789",
"description": "abc123",
"providerId": 123,
"VRF": "xyz789",
"customAttributes": {}
}
Response
{
"data": {
"updateZone": {
"id": 987,
"name": "abc123",
"description": "abc123",
"VRF": "abc123",
"providerId": 123,
"provider": Provider,
"parentZone": [Zone],
"cloudResourceId": "xyz789",
"importBatchId": 123,
"customAttributes": {}
}
}
}
Types
Activity
ActivityList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [Activity]
|
Example
{"count": 987, "total": 123, "results": [Activity]}
Address
Example
{
"id": 123,
"line1": "abc123",
"line2": "xyz789",
"line3": "abc123",
"line4": "abc123",
"municipality": "abc123",
"province": "abc123",
"country": "xyz789",
"postalCode": "abc123"
}
AddressInput
Example
{
"id": 987,
"line1": "xyz789",
"line2": "abc123",
"line3": "abc123",
"line4": "abc123",
"municipality": "xyz789",
"province": "xyz789",
"country": "abc123",
"postalCode": "abc123"
}
AddressList
AdminUser
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
firstName - String
|
|
lastName - String
|
|
email - String
|
|
role - String
|
|
password - String
|
|
lastLogin - String
|
|
loginCount - Int
|
|
hideWelcome - Boolean
|
|
superUser - Boolean
|
|
apiKey - String
|
|
localUser - Boolean
|
|
passwordLoginEnabled - Boolean
|
|
microsoftLoginEnabled - Boolean
|
|
googleLoginEnabled - Boolean
|
|
config - JSON
|
|
UserOrganizations - [UserOrganization]
|
|
currentOrganizationId - Int
|
|
internal - Boolean
|
|
notificationSettings - JSON
|
|
profile - JSON
|
|
createdAt - String
|
Example
{
"id": 123,
"firstName": "xyz789",
"lastName": "abc123",
"email": "abc123",
"role": "xyz789",
"password": "xyz789",
"lastLogin": "xyz789",
"loginCount": 987,
"hideWelcome": false,
"superUser": true,
"apiKey": "xyz789",
"localUser": false,
"passwordLoginEnabled": true,
"microsoftLoginEnabled": false,
"googleLoginEnabled": true,
"config": {},
"UserOrganizations": [UserOrganization],
"currentOrganizationId": 123,
"internal": true,
"notificationSettings": {},
"profile": {},
"createdAt": "xyz789"
}
AdminUserFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
firstName - StringFilter
|
|
lastName - StringFilter
|
|
email - StringFilter
|
|
role - StringFilter
|
|
password - StringFilter
|
|
lastLogin - StringFilter
|
|
loginCount - IntFilter
|
|
hideWelcome - BooleanFilter
|
|
superUser - BooleanFilter
|
|
apiKey - StringFilter
|
|
localUser - BooleanFilter
|
|
passwordLoginEnabled - BooleanFilter
|
|
microsoftLoginEnabled - BooleanFilter
|
|
googleLoginEnabled - BooleanFilter
|
|
config - JSON
|
|
UserOrganizations - [UserOrganizationFilter]
|
|
Organizations - [OrganizationFilter]
|
|
currentOrganizationId - IntFilter
|
|
internal - BooleanFilter
|
|
notificationSettings - JSON
|
|
profile - JSON
|
|
createdAt - StringFilter
|
|
and - [AdminUserFilter]
|
|
or - [AdminUserFilter]
|
|
not - [AdminUserFilter]
|
Example
{
"id": IntFilter,
"firstName": StringFilter,
"lastName": StringFilter,
"email": StringFilter,
"role": StringFilter,
"password": StringFilter,
"lastLogin": StringFilter,
"loginCount": IntFilter,
"hideWelcome": BooleanFilter,
"superUser": BooleanFilter,
"apiKey": StringFilter,
"localUser": BooleanFilter,
"passwordLoginEnabled": BooleanFilter,
"microsoftLoginEnabled": BooleanFilter,
"googleLoginEnabled": BooleanFilter,
"config": {},
"UserOrganizations": [UserOrganizationFilter],
"Organizations": [OrganizationFilter],
"currentOrganizationId": IntFilter,
"internal": BooleanFilter,
"notificationSettings": {},
"profile": {},
"createdAt": StringFilter,
"and": [AdminUserFilter],
"or": [AdminUserFilter],
"not": [AdminUserFilter]
}
Alert
Example
{
"id": 123,
"SubnetId": 123,
"UserId": 123,
"AlertRuleId": 123,
"status": "xyz789",
"type": "xyz789",
"name": "xyz789",
"Subnet": Subnet,
"description": "xyz789",
"message": "xyz789",
"clearNotification": true
}
AlertDestination
Example
{
"name": "xyz789",
"id": 987,
"type": "xyz789",
"URL": "xyz789",
"slackChannel": "abc123",
"email": "xyz789",
"status": "xyz789",
"verificationCode": "abc123",
"options": {},
"createdAt": "xyz789"
}
AlertDestinationFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
type - StringFilter
|
|
URL - StringFilter
|
|
slackChannel - StringFilter
|
|
email - StringFilter
|
|
status - StringFilter
|
|
options - JSON
|
Example
{
"id": IntFilter,
"name": StringFilter,
"type": StringFilter,
"URL": StringFilter,
"slackChannel": StringFilter,
"email": StringFilter,
"status": StringFilter,
"options": {}
}
AlertDestinationList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int!
|
|
results - [AlertDestination!]
|
Example
{
"count": 987,
"total": 987,
"results": [AlertDestination]
}
AlertFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
clearNotification - Boolean
|
|
name - StringFilter
|
|
type - StringFilter
|
|
URL - StringFilter
|
|
email - StringFilter
|
|
status - StringFilter
|
Example
{
"id": IntFilter,
"clearNotification": true,
"name": StringFilter,
"type": StringFilter,
"URL": StringFilter,
"email": StringFilter,
"status": StringFilter
}
AlertList
AlertRecipient
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
UserId - Int
|
|
userName - String
|
|
AlertRuleId - Int
|
|
rules - [AlertRule]
|
Example
{
"id": 123,
"UserId": 987,
"userName": "xyz789",
"AlertRuleId": 987,
"rules": [AlertRule]
}
AlertRecipientInput
AlertRecipientList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
results - [AlertRecipient]
|
Example
{"count": 123, "results": [AlertRecipient]}
AlertRule
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
SubnetId - Int
|
|
ZoneId - Int
|
|
networkAddress - String
|
|
status - String
|
|
type - String
|
|
name - String
|
|
description - String
|
|
conditions - JSON
|
|
subnet - Subnet
|
|
AlertDestinations - [AlertDestination]
|
|
AlertRecipientId - Int
|
|
AlertRecipients - [AlertRecipient]
|
|
recipients - [AlertRecipient]
|
Example
{
"id": 123,
"SubnetId": 987,
"ZoneId": 123,
"networkAddress": "abc123",
"status": "abc123",
"type": "abc123",
"name": "abc123",
"description": "xyz789",
"conditions": {},
"subnet": Subnet,
"AlertDestinations": [AlertDestination],
"AlertRecipientId": 123,
"AlertRecipients": [AlertRecipient],
"recipients": [AlertRecipient]
}
AlertRuleInput
Example
{
"SubnetId": 123,
"ZoneId": 123,
"networkAddress": "xyz789",
"status": "abc123",
"type": "xyz789",
"name": "abc123",
"description": "abc123",
"conditions": {},
"AlertRecipientId": 123
}
AlertRuleList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int!
|
|
results - [AlertRule]
|
Example
{"count": 987, "total": 987, "results": [AlertRule]}
ApiKey
ApiKeyList
Boolean
Description
The Boolean scalar type represents true or false.
BooleanFilter
CacheControlScope
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PUBLIC"
Contact
Example
{
"id": 123,
"firstName": "xyz789",
"lastName": "abc123",
"phone": "xyz789",
"cellPhone": "abc123",
"email": "abc123",
"email2": "abc123",
"importBatchId": 987,
"SupportGroupId": 123,
"supportGroup": SupportGroup,
"customAttributes": {}
}
ContactFilter
Fields
| Input Field | Description |
|---|---|
firstName - StringFilter
|
|
lastName - StringFilter
|
|
phone - StringFilter
|
|
cellPhone - StringFilter
|
|
email - StringFilter
|
|
email2 - StringFilter
|
|
customAttributes - JSON
|
|
and - [ContactFilter]
|
|
or - [ContactFilter]
|
|
not - ContactFilter
|
Example
{
"firstName": StringFilter,
"lastName": StringFilter,
"phone": StringFilter,
"cellPhone": StringFilter,
"email": StringFilter,
"email2": StringFilter,
"customAttributes": {},
"and": [ContactFilter],
"or": [ContactFilter],
"not": ContactFilter
}
ContactInput
Example
{
"firstName": "abc123",
"lastName": "abc123",
"phone": "xyz789",
"cellPhone": "abc123",
"email": "xyz789",
"email2": "xyz789",
"customAttributes": {}
}
ContactList
CustomAttribute
Example
{
"id": 123,
"modelName": "abc123",
"name": "abc123",
"type": "abc123",
"required": false,
"sectionId": 987,
"rowIndex": 987,
"rowColSpan": 123,
"colIndex": 987,
"colSpan": 987,
"component": "xyz789"
}
CustomAttributeFilter
Fields
| Input Field | Description |
|---|---|
modelName - StringFilter
|
|
name - StringFilter
|
|
type - StringFilter
|
|
required - BooleanFilter
|
|
sectionId - IntFilter
|
|
rowIndex - IntFilter
|
|
rowColSpan - IntFilter
|
|
colIndex - IntFilter
|
|
colSpan - IntFilter
|
|
component - StringFilter
|
|
and - [CustomAttributeFilter]
|
|
or - [CustomAttributeFilter]
|
|
not - [CustomAttributeFilter]
|
Example
{
"modelName": StringFilter,
"name": StringFilter,
"type": StringFilter,
"required": BooleanFilter,
"sectionId": IntFilter,
"rowIndex": IntFilter,
"rowColSpan": IntFilter,
"colIndex": IntFilter,
"colSpan": IntFilter,
"component": StringFilter,
"and": [CustomAttributeFilter],
"or": [CustomAttributeFilter],
"not": [CustomAttributeFilter]
}
CustomAttributeInput
Example
{
"modelName": "abc123",
"name": "abc123",
"type": "xyz789",
"required": false,
"sectionId": 987,
"rowIndex": 123,
"rowColSpan": 987,
"colIndex": 987,
"colSpan": 987,
"component": "xyz789"
}
CustomAttributeList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
results - [CustomAttribute]
|
Example
{"count": 987, "results": [CustomAttribute]}
Customer
CustomerFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
subnets - [SubnetFilter]
|
|
customAttributes - JSON
|
|
importBatchId - IntFilter
|
|
and - [CustomerFilter]
|
|
or - [CustomerFilter]
|
|
not - CustomerFilter
|
Example
{
"id": IntFilter,
"name": StringFilter,
"subnets": [SubnetFilter],
"customAttributes": {},
"importBatchId": IntFilter,
"and": [CustomerFilter],
"or": [CustomerFilter],
"not": CustomerFilter
}
CustomerInput
CustomerList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [Customer]
|
Example
{"count": 987, "total": 123, "results": [Customer]}
DNSEntry
Example
{
"id": 987,
"name": "abc123",
"ttl": 987,
"recordClass": "abc123",
"recordType": "xyz789",
"recordData": "xyz789",
"dnsZone": [DNSZone],
"customAttributes": {},
"networkAddress": "abc123",
"priority": 123,
"status": "abc123",
"IPAssignment": IPAssignment
}
DNSEntryFilter
Fields
| Input Field | Description |
|---|---|
importBatchId - IntFilter
|
|
name - StringFilter
|
|
ttl - StringFilter
|
|
recordClass - StringFilter
|
|
recordType - StringFilter
|
|
recordData - StringFilter
|
|
and - [DNSEntryFilter]
|
|
or - [DNSEntryFilter]
|
|
not - [DNSEntryFilter]
|
Example
{
"importBatchId": IntFilter,
"name": StringFilter,
"ttl": StringFilter,
"recordClass": StringFilter,
"recordType": StringFilter,
"recordData": StringFilter,
"and": [DNSEntryFilter],
"or": [DNSEntryFilter],
"not": [DNSEntryFilter]
}
DNSEntryInput
Example
{
"id": 987,
"name": "xyz789",
"ttl": 123,
"recordClass": "xyz789",
"recordType": "abc123",
"recordData": "xyz789",
"dnsZoneId": 987,
"customAttributes": {}
}
DNSEntryList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [DNSEntry]
|
Example
{"count": 987, "total": 123, "results": [DNSEntry]}
DNSServer
Fields
| Field Name | Description |
|---|---|
name - String!
|
Example
{"name": "abc123"}
DNSServerFilter
Fields
| Input Field | Description |
|---|---|
name - StringFilter
|
|
and - [DNSServerFilter]
|
|
or - [DNSServerFilter]
|
|
not - DNSServerFilter
|
Example
{
"name": StringFilter,
"and": [DNSServerFilter],
"or": [DNSServerFilter],
"not": DNSServerFilter
}
DNSZone
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
dnsServer - [DNSServer]
|
Example
{
"name": "xyz789",
"dnsServer": [DNSServer]
}
Date
Example
"2007-12-03"
DateFilter
Datetime
Example
Datetime
DatetimeFilter
EmailResponse
Fields
| Field Name | Description |
|---|---|
emailSent - Int
|
Example
{"emailSent": 987}
FilterIs
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NULL"
IPAddress
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
networkAddress - String!
|
|
ipAddressType - String
|
|
ipAssignment - IPAssignment
|
|
expirationDate - String
|
|
reservation - Reservation
|
|
request - NetworkRequestItem
|
|
scanResults - [ScanResult]
|
|
inUse - Boolean
|
|
subnet - Subnet
|
|
zone - Zone
|
Example
{
"id": 987,
"networkAddress": "abc123",
"ipAddressType": "xyz789",
"ipAssignment": IPAssignment,
"expirationDate": "xyz789",
"reservation": Reservation,
"request": NetworkRequestItem,
"scanResults": [ScanResult],
"inUse": true,
"subnet": Subnet,
"zone": Zone
}
IPAddressFilter
Fields
| Input Field | Description |
|---|---|
networkAddress - StringFilter
|
|
zone - ZoneFilter
|
|
subnet - SubnetFilter
|
|
networkRequests - [NetworkRequestFilter]
|
|
reservations - [ReservationFilter]
|
|
ipAssignment - [IPAssignmentFilter]
|
|
importBatchId - IntFilter
|
|
and - [IPAddressFilter]
|
|
or - [IPAddressFilter]
|
|
not - IPAddressFilter
|
Example
{
"networkAddress": StringFilter,
"zone": ZoneFilter,
"subnet": SubnetFilter,
"networkRequests": [NetworkRequestFilter],
"reservations": [ReservationFilter],
"ipAssignment": [IPAssignmentFilter],
"importBatchId": IntFilter,
"and": [IPAddressFilter],
"or": [IPAddressFilter],
"not": IPAddressFilter
}
IPAddressInput
IPAddressList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [IPAddress]
|
Example
{"count": 987, "total": 987, "results": [IPAddress]}
IPAssignment
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
subnetId - Int
|
|
networkAddress - String!
|
|
description - String
|
|
ipAddressType - String
|
|
interface - Interface
|
|
lastSeenAt - String
|
|
subnet - Subnet
|
|
DNSEntries - [DNSEntry]
|
|
resource - Resource
|
|
interfaces - [Interface]
|
|
cloudResourceId - String
|
|
createdAt - String
|
|
importBatchId - Int
|
|
customAttributes - JSON
|
|
request - NetworkRequestItem
|
Example
{
"id": 987,
"subnetId": 123,
"networkAddress": "abc123",
"description": "abc123",
"ipAddressType": "abc123",
"interface": Interface,
"lastSeenAt": "abc123",
"subnet": Subnet,
"DNSEntries": [DNSEntry],
"resource": Resource,
"interfaces": [Interface],
"cloudResourceId": "xyz789",
"createdAt": "abc123",
"importBatchId": 123,
"customAttributes": {},
"request": NetworkRequestItem
}
IPAssignmentFilter
Fields
| Input Field | Description |
|---|---|
zone - ZoneFilter
|
|
subnet - SubnetFilter
|
|
networkAddress - StringFilter
|
|
hostname - StringFilter
|
|
resourceType - StringFilter
|
|
macAddress - StringFilter
|
|
interface - StringFilter
|
|
direction - StringFilter
|
|
reservation - ReservationFilter
|
|
DNSEntries - [DNSEntryFilter]
|
|
customAttributes - JSON
|
|
and - [IPAssignmentFilter]
|
|
or - [IPAssignmentFilter]
|
|
not - [IPAssignmentFilter]
|
Example
{
"zone": ZoneFilter,
"subnet": SubnetFilter,
"networkAddress": StringFilter,
"hostname": StringFilter,
"resourceType": StringFilter,
"macAddress": StringFilter,
"interface": StringFilter,
"direction": StringFilter,
"reservation": ReservationFilter,
"DNSEntries": [DNSEntryFilter],
"customAttributes": {},
"and": [IPAssignmentFilter],
"or": [IPAssignmentFilter],
"not": [IPAssignmentFilter]
}
IPAssignmentInput
Fields
| Input Field | Description |
|---|---|
zone - String
|
|
subnet - String
|
|
subnetId - Int
|
|
zoneId - Int
|
|
networkAddress - String!
|
|
hostname - String
|
|
resourceType - String
|
|
macAddress - String
|
|
interface - String
|
|
direction - String
|
|
notes - String
|
|
reservation - String
|
|
dnsEntryValue - String
|
|
dnsEntryType - String
|
|
dnsEntryTTL - String
|
|
customAttributes - JSON
|
Example
{
"zone": "abc123",
"subnet": "abc123",
"subnetId": 987,
"zoneId": 987,
"networkAddress": "xyz789",
"hostname": "abc123",
"resourceType": "abc123",
"macAddress": "abc123",
"interface": "xyz789",
"direction": "abc123",
"notes": "xyz789",
"reservation": "xyz789",
"dnsEntryValue": "xyz789",
"dnsEntryType": "xyz789",
"dnsEntryTTL": "xyz789",
"customAttributes": {}
}
IPAssignmentList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int!
|
|
results - [IPAssignment]
|
Example
{"count": 123, "total": 123, "results": [IPAssignment]}
IPStatusInput
Example
{
"status": "abc123",
"hostname": "abc123",
"networkAddress": "xyz789",
"macAddress": "abc123",
"time": "abc123",
"dnsEntryType": "xyz789",
"dnsEntryValue": "xyz789",
"dnsEntryTTL": "abc123",
"resourceType": "xyz789",
"interface": "xyz789",
"direction": "abc123",
"reservation": "xyz789"
}
IdentityResult
Types
| Union Types |
|---|
Example
UserGroup
IdentityResultList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [IdentityResult]
|
Example
{"count": 987, "total": 123, "results": [UserGroup]}
Import
Example
{
"id": 987,
"description": "abc123",
"customer_count": 123,
"contact_count": 987,
"site_count": 123,
"zone_count": 987,
"subnet_count": 123,
"ip_assignment_count": 987,
"records": [ImportRecord]
}
ImportFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
description - StringFilter
|
|
user - UserFilter
|
Example
{
"id": IntFilter,
"description": StringFilter,
"user": UserFilter
}
ImportList
ImportRecord
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
IntFilter
Interface
InterfaceFilter
Fields
| Input Field | Description |
|---|---|
name - StringFilter
|
|
macAddress - StringFilter
|
|
resource - ResourceFilter
|
|
ipAssignment - IPAssignmentFilter
|
|
cloudResourceId - StringFilter
|
|
and - [InterfaceFilter]
|
|
or - [InterfaceFilter]
|
|
not - InterfaceFilter
|
Example
{
"name": StringFilter,
"macAddress": StringFilter,
"resource": ResourceFilter,
"ipAssignment": IPAssignmentFilter,
"cloudResourceId": StringFilter,
"and": [InterfaceFilter],
"or": [InterfaceFilter],
"not": InterfaceFilter
}
InterfaceInput
InterfaceList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
results - [Interface]
|
Example
{"count": 987, "results": [Interface]}
JSON
Example
{}
Location
LocationList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
results - [Location]
|
Example
{"count": 987, "results": [Location]}
NAT
Example
{
"id": 987,
"sourceNatAddress": "xyz789",
"destinationNatAddress": ["abc123"],
"natType": "abc123",
"sourcePort": 987,
"sourceNatZoneId": 987,
"destinationPort": 987,
"destinationNatZoneId": 987,
"sourceType": "abc123",
"destinationType": "xyz789",
"subnetId": 987
}
NATFilter
Fields
| Input Field | Description |
|---|---|
sourceNatAddress - StringFilter
|
|
destinationNatAddress - [StringFilter]
|
|
natType - StringFilter
|
|
sourcePort - IntFilter
|
|
sourceNatZoneId - IntFilter
|
|
destinationPort - IntFilter
|
|
destinationNatZoneId - IntFilter
|
|
sourceType - StringFilter
|
|
destinationType - StringFilter
|
|
subnet - SubnetFilter
|
Example
{
"sourceNatAddress": StringFilter,
"destinationNatAddress": [StringFilter],
"natType": StringFilter,
"sourcePort": IntFilter,
"sourceNatZoneId": IntFilter,
"destinationPort": IntFilter,
"destinationNatZoneId": IntFilter,
"sourceType": StringFilter,
"destinationType": StringFilter,
"subnet": SubnetFilter
}
NATList
NetworkAddress
Fields
| Field Name | Description |
|---|---|
networkAddress - String
|
Example
{"networkAddress": "abc123"}
NetworkAddressList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
results - [NetworkAddress]
|
Example
{"count": 987, "results": [NetworkAddress]}
NetworkRequest
Example
{
"id": 987,
"status": "xyz789",
"ipAddressCount": 987,
"details": "abc123",
"networkAddress": "abc123",
"zoneId": "abc123",
"subnetId": 987,
"NetworkRequestItems": [NetworkRequestItem],
"createdAt": "xyz789"
}
NetworkRequestFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
status - StringFilter
|
|
title - StringFilter
|
|
description - StringFilter
|
|
subnet - SubnetFilter
|
|
networkRequestItems - [NetworkRequestItemFilter]
|
|
and - [NetworkRequestFilter]
|
|
or - [NetworkRequestFilter]
|
|
not - NetworkRequestFilter
|
Example
{
"id": IntFilter,
"status": StringFilter,
"title": StringFilter,
"description": StringFilter,
"subnet": SubnetFilter,
"networkRequestItems": [NetworkRequestItemFilter],
"and": [NetworkRequestFilter],
"or": [NetworkRequestFilter],
"not": NetworkRequestFilter
}
NetworkRequestItem
Example
{
"id": 123,
"status": "xyz789",
"zoneId": 987,
"ipAddress": "abc123",
"macAddress": "xyz789",
"interface": "abc123",
"hostname": "xyz789",
"customAttributes": {},
"description": "xyz789",
"networkRequestId": 987,
"networkRequest": NetworkRequest
}
NetworkRequestItemFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
status - StringFilter
|
|
ipAddress - StringFilter
|
|
macAddress - StringFilter
|
|
interface - StringFilter
|
|
hostname - StringFilter
|
|
description - StringFilter
|
Example
{
"id": IntFilter,
"status": StringFilter,
"ipAddress": StringFilter,
"macAddress": StringFilter,
"interface": StringFilter,
"hostname": StringFilter,
"description": StringFilter
}
NetworkRequestItemInput
Example
{
"id": 987,
"status": "abc123",
"ipAddress": "xyz789",
"macAddress": "xyz789",
"interface": "abc123",
"hostname": "xyz789",
"description": "xyz789"
}
NetworkRequestList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
results - [NetworkRequest]
|
Example
{"count": 987, "results": [NetworkRequest]}
NetworkResult
Types
| Union Types |
|---|
Example
Subnet
NetworkResultList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [NetworkResult]
|
Example
{"count": 123, "total": 123, "results": [Subnet]}
OrganizationFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
schemaName - StringFilter
|
|
status - StringFilter
|
|
subnetCount - IntFilter
|
|
createdAt - DatetimeFilter
|
|
users - [UserFilter]
|
|
UserOrganizations - [UserOrganizationFilter]
|
Example
{
"id": IntFilter,
"name": StringFilter,
"schemaName": StringFilter,
"status": StringFilter,
"subnetCount": IntFilter,
"createdAt": DatetimeFilter,
"users": [UserFilter],
"UserOrganizations": [UserOrganizationFilter]
}
Plan
PlanFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
projectId - IntFilter
|
|
description - StringFilter
|
|
subnets - [SubnetFilter]
|
|
plannedChanges - [PlannedChangeFilter]
|
|
and - [PlanFilter]
|
|
or - [PlanFilter]
|
|
not - PlanFilter
|
Example
{
"id": IntFilter,
"name": StringFilter,
"projectId": IntFilter,
"description": StringFilter,
"subnets": [SubnetFilter],
"plannedChanges": [PlannedChangeFilter],
"and": [PlanFilter],
"or": [PlanFilter],
"not": PlanFilter
}
PlannedChange
Example
{
"id": 123,
"planId": 123,
"description": "xyz789",
"sourceId": 987,
"sourceType": "xyz789",
"sourceNetworkAddress": "abc123",
"destinationId": 987,
"destinationType": "abc123",
"destinationNetworkAddress": "xyz789",
"status": "abc123",
"date": "xyz789",
"sourceSubnet": Subnet,
"destinationSubnet": Subnet
}
PlannedChangeFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
planId - IntFilter
|
|
description - StringFilter
|
|
sourceId - IntFilter
|
|
sourceType - StringFilter
|
|
sourceNetworkAddress - StringFilter
|
|
destinationId - IntFilter
|
|
destinationType - StringFilter
|
|
destinationNetworkAddress - StringFilter
|
|
status - StringFilter
|
|
date - StringFilter
|
|
sourceSubnet - SubnetFilter
|
|
destinationSubnet - SubnetFilter
|
|
and - [PlannedChangeFilter]
|
|
or - [PlannedChangeFilter]
|
|
not - PlannedChangeFilter
|
Example
{
"id": IntFilter,
"planId": IntFilter,
"description": StringFilter,
"sourceId": IntFilter,
"sourceType": StringFilter,
"sourceNetworkAddress": StringFilter,
"destinationId": IntFilter,
"destinationType": StringFilter,
"destinationNetworkAddress": StringFilter,
"status": StringFilter,
"date": StringFilter,
"sourceSubnet": SubnetFilter,
"destinationSubnet": SubnetFilter,
"and": [PlannedChangeFilter],
"or": [PlannedChangeFilter],
"not": PlannedChangeFilter
}
ProjectFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
plans - [PlanFilter]
|
|
and - [ProjectFilter]
|
|
or - [ProjectFilter]
|
|
not - ProjectFilter
|
Example
{
"id": IntFilter,
"name": StringFilter,
"plans": [PlanFilter],
"and": [ProjectFilter],
"or": [ProjectFilter],
"not": ProjectFilter
}
Provider
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
name - String
|
|
active - Boolean
|
|
type - String
|
|
azureAppId - String
|
|
azurePassword - String
|
|
azureTenantId - String
|
|
awsAccessKeyId - String
|
|
awsSecretAccessKey - String
|
|
awsSessionToken - String
|
|
lastSynchronizedAt - String
|
|
syncStatus - String
|
|
syncError - String
|
|
subnetCount - Int
|
|
ipCount - Int
|
|
resourceCount - Int
|
|
createdAt - String
|
|
customAttributes - JSON
|
Example
{
"id": 987,
"name": "abc123",
"active": true,
"type": "abc123",
"azureAppId": "xyz789",
"azurePassword": "abc123",
"azureTenantId": "abc123",
"awsAccessKeyId": "abc123",
"awsSecretAccessKey": "xyz789",
"awsSessionToken": "abc123",
"lastSynchronizedAt": "abc123",
"syncStatus": "xyz789",
"syncError": "xyz789",
"subnetCount": 987,
"ipCount": 987,
"resourceCount": 123,
"createdAt": "abc123",
"customAttributes": {}
}
ProviderFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
active - BooleanFilter
|
|
type - StringFilter
|
|
azureAppId - StringFilter
|
|
azurePassword - StringFilter
|
|
azureTenantId - StringFilter
|
|
awsAccessKeyId - StringFilter
|
|
awsSecretAccessKey - StringFilter
|
|
awsSessionToken - StringFilter
|
|
lastSynchronizedAt - StringFilter
|
|
syncStatus - StringFilter
|
|
importBatchId - IntFilter
|
|
and - [ProviderFilter]
|
|
or - [ProviderFilter]
|
|
not - ProviderFilter
|
Example
{
"id": IntFilter,
"name": StringFilter,
"active": BooleanFilter,
"type": StringFilter,
"azureAppId": StringFilter,
"azurePassword": StringFilter,
"azureTenantId": StringFilter,
"awsAccessKeyId": StringFilter,
"awsSecretAccessKey": StringFilter,
"awsSessionToken": StringFilter,
"lastSynchronizedAt": StringFilter,
"syncStatus": StringFilter,
"importBatchId": IntFilter,
"and": [ProviderFilter],
"or": [ProviderFilter],
"not": ProviderFilter
}
ProviderList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [Provider]
|
Example
{"count": 987, "total": 123, "results": [Provider]}
Reservation
ReservationFilter
Fields
| Input Field | Description |
|---|---|
importBatchId - IntFilter
|
|
id - IntFilter
|
|
name - StringFilter
|
|
description - StringFilter
|
|
ipAddresses - [IPAddressFilter]
|
|
subnet - SubnetFilter
|
|
and - [ReservationFilter]
|
|
or - [ReservationFilter]
|
|
not - ReservationFilter
|
Example
{
"importBatchId": IntFilter,
"id": IntFilter,
"name": StringFilter,
"description": StringFilter,
"ipAddresses": [IPAddressFilter],
"subnet": SubnetFilter,
"and": [ReservationFilter],
"or": [ReservationFilter],
"not": ReservationFilter
}
ReservationList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
results - [Reservation]
|
Example
{"count": 987, "results": [Reservation]}
Resource
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
hostname - String
|
|
OS - String
|
|
OSVersion - String
|
|
macAddress - String
|
|
cloudResourceId - String
|
|
resourceGroupId - String
|
|
resourceTypeId - Int
|
|
provider - Provider
|
|
lastSeenAt - String
|
|
ResourceStatus - ResourceStatus
|
|
resourceType - ResourceType
|
|
interfaces - [Interface]
|
|
createdAt - String
|
Example
{
"id": 987,
"hostname": "abc123",
"OS": "abc123",
"OSVersion": "xyz789",
"macAddress": "xyz789",
"cloudResourceId": "abc123",
"resourceGroupId": "xyz789",
"resourceTypeId": 987,
"provider": Provider,
"lastSeenAt": "xyz789",
"ResourceStatus": ResourceStatus,
"resourceType": ResourceType,
"interfaces": [Interface],
"createdAt": "xyz789"
}
ResourceFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
hostname - StringFilter
|
|
OS - StringFilter
|
|
OSVersion - StringFilter
|
|
macAddress - StringFilter
|
|
resourceId - StringFilter
|
|
resourceGroupId - StringFilter
|
|
resourceTypeId - IntFilter
|
|
providerId - IntFilter
|
|
interface - StringFilter
|
|
and - [ResourceFilter]
|
|
or - [ResourceFilter]
|
|
not - ResourceFilter
|
Example
{
"id": IntFilter,
"hostname": StringFilter,
"OS": StringFilter,
"OSVersion": StringFilter,
"macAddress": StringFilter,
"resourceId": StringFilter,
"resourceGroupId": StringFilter,
"resourceTypeId": IntFilter,
"providerId": IntFilter,
"interface": StringFilter,
"and": [ResourceFilter],
"or": [ResourceFilter],
"not": ResourceFilter
}
ResourceInput
Example
{
"id": 123,
"hostname": "xyz789",
"OS": "xyz789",
"OSVersion": "xyz789",
"macAddress": "abc123",
"resourceId": "xyz789",
"resourceGroupId": "xyz789",
"resourceTypeId": 123,
"providerId": 123,
"interface": "abc123"
}
ResourceList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int!
|
|
results - [Resource]
|
Example
{"count": 987, "total": 987, "results": [Resource]}
ResourceStatus
ResourceStatusFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
and - [ResourceStatusFilter]
|
|
or - [ResourceStatusFilter]
|
|
not - ResourceStatusFilter
|
Example
{
"id": IntFilter,
"name": StringFilter,
"and": [ResourceStatusFilter],
"or": [ResourceStatusFilter],
"not": ResourceStatusFilter
}
ResourceStatusInput
ResourceStatusList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
results - [ResourceStatus]
|
Example
{"count": 123, "results": [ResourceStatus]}
ResourceType
ResourceTypeFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
and - [ResourceTypeFilter]
|
|
or - [ResourceTypeFilter]
|
|
not - ResourceTypeFilter
|
Example
{
"id": IntFilter,
"name": StringFilter,
"and": [ResourceTypeFilter],
"or": [ResourceTypeFilter],
"not": ResourceTypeFilter
}
ResourceTypeInput
ResourceTypeList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
results - [ResourceType]
|
Example
{"count": 987, "results": [ResourceType]}
ReturningUsersByMonth
Role
RoleAssignment
Example
{
"id": 123,
"subjectId": 987,
"subjectType": "abc123",
"recordId": "abc123",
"recordType": "xyz789",
"networkAddress": "xyz789",
"zoneId": 987,
"userGroup": UserGroup,
"role": Role
}
RoleAssignmentFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
subjectId - IntFilter
|
|
subjectType - StringFilter
|
|
recordId - StringFilter
|
|
recordType - StringFilter
|
|
networkAddress - StringFilter
|
|
zone - ZoneFilter
|
|
user - UserFilter
|
|
userGroup - UserGroupFilter
|
|
role - RoleFilter
|
Example
{
"id": IntFilter,
"subjectId": IntFilter,
"subjectType": StringFilter,
"recordId": StringFilter,
"recordType": StringFilter,
"networkAddress": StringFilter,
"zone": ZoneFilter,
"user": UserFilter,
"userGroup": UserGroupFilter,
"role": RoleFilter
}
RoleAssignmentList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [RoleAssignment]
|
Example
{"count": 987, "total": 123, "results": [RoleAssignment]}
RoleFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
description - StringFilter
|
|
plans - [PlanFilter]
|
|
and - [RoleFilter]
|
|
or - [RoleFilter]
|
|
not - RoleFilter
|
Example
{
"id": IntFilter,
"name": StringFilter,
"description": StringFilter,
"plans": [PlanFilter],
"and": [RoleFilter],
"or": [RoleFilter],
"not": RoleFilter
}
RoleList
Scan
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
subnetId - Int
|
|
zoneId - Int
|
|
networkAddress - String
|
|
hostname - String
|
|
macAddress - String
|
|
interface - String
|
|
scannedAt - Date
|
|
scanCommand - String
|
|
customAttributes - JSON
|
|
ignore - Boolean
|
|
sourceType - String
|
|
sourceVersion - String
|
|
fileName - String
|
|
result - String
|
|
userId - Int
|
Example
{
"id": 987,
"subnetId": 987,
"zoneId": 987,
"networkAddress": "xyz789",
"hostname": "xyz789",
"macAddress": "xyz789",
"interface": "xyz789",
"scannedAt": "2007-12-03",
"scanCommand": "abc123",
"customAttributes": {},
"ignore": true,
"sourceType": "abc123",
"sourceVersion": "abc123",
"fileName": "abc123",
"result": "abc123",
"userId": 987
}
ScanFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
subnetId - IntFilter
|
|
zoneId - IntFilter
|
|
networkAddress - StringFilter
|
|
hostname - StringFilter
|
|
resourceType - StringFilter
|
|
macAddress - StringFilter
|
|
interface - StringFilter
|
|
sourceType - StringFilter
|
|
sourceVersion - StringFilter
|
|
scannedAt - DateFilter
|
|
scanCommand - StringFilter
|
|
customAttributes - JSON
|
|
and - [ScanFilter]
|
|
or - [ScanFilter]
|
|
not - [ScanFilter]
|
Example
{
"id": IntFilter,
"subnetId": IntFilter,
"zoneId": IntFilter,
"networkAddress": StringFilter,
"hostname": StringFilter,
"resourceType": StringFilter,
"macAddress": StringFilter,
"interface": StringFilter,
"sourceType": StringFilter,
"sourceVersion": StringFilter,
"scannedAt": DateFilter,
"scanCommand": StringFilter,
"customAttributes": {},
"and": [ScanFilter],
"or": [ScanFilter],
"not": [ScanFilter]
}
ScanList
ScanResult
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
subnetId - Int
|
|
zoneId - Int
|
|
networkAddress - String!
|
|
hostname - String
|
|
resourceType - String
|
|
macAddress - String
|
|
cloudResourceId - String
|
|
interface - String
|
|
scannedAt - Date
|
|
ScanId - Int
|
|
customAttributes - JSON
|
|
ignore - Boolean
|
|
sourceType - String
|
|
sourceVersion - String
|
|
fileName - String
|
|
result - String
|
|
ipAssignmentId - Int
|
Example
{
"id": 123,
"subnetId": 123,
"zoneId": 987,
"networkAddress": "abc123",
"hostname": "abc123",
"resourceType": "abc123",
"macAddress": "abc123",
"cloudResourceId": "abc123",
"interface": "abc123",
"scannedAt": "2007-12-03",
"ScanId": 123,
"customAttributes": {},
"ignore": true,
"sourceType": "xyz789",
"sourceVersion": "xyz789",
"fileName": "abc123",
"result": "abc123",
"ipAssignmentId": 987
}
ScanResultFilter
Fields
| Input Field | Description |
|---|---|
subnetId - IntFilter
|
|
zoneId - IntFilter
|
|
networkAddress - StringFilter
|
|
hostname - StringFilter
|
|
resourceType - StringFilter
|
|
macAddress - StringFilter
|
|
interface - StringFilter
|
|
scannedAt - DateFilter
|
|
ScanId - IntFilter
|
|
customAttributes - JSON
|
|
and - [ScanResultFilter]
|
|
or - [ScanResultFilter]
|
|
not - [ScanResultFilter]
|
Example
{
"subnetId": IntFilter,
"zoneId": IntFilter,
"networkAddress": StringFilter,
"hostname": StringFilter,
"resourceType": StringFilter,
"macAddress": StringFilter,
"interface": StringFilter,
"scannedAt": DateFilter,
"ScanId": IntFilter,
"customAttributes": {},
"and": [ScanResultFilter],
"or": [ScanResultFilter],
"not": [ScanResultFilter]
}
ScanResultList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [ScanResult]
|
Example
{"count": 123, "total": 987, "results": [ScanResult]}
Site
SiteFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
importBatchId - IntFilter
|
|
name - StringFilter
|
|
subnets - [SubnetFilter]
|
|
customAttributesFilter - JSON
|
|
and - [SiteFilter]
|
|
or - [SiteFilter]
|
|
not - [SiteFilter]
|
Example
{
"id": IntFilter,
"importBatchId": IntFilter,
"name": StringFilter,
"subnets": [SubnetFilter],
"customAttributesFilter": {},
"and": [SiteFilter],
"or": [SiteFilter],
"not": [SiteFilter]
}
SiteInput
SiteList
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
StringFilter
Example
{
"eq": "abc123",
"gt": "xyz789",
"gte": "abc123",
"ilike": "xyz789",
"in": ["xyz789"],
"iregex": "abc123",
"is": "NULL",
"like": "xyz789",
"lt": "abc123",
"lte": "abc123",
"neq": "abc123",
"regex": "xyz789",
"startsWith": "xyz789",
"endsWith": "xyz789",
"contains": "xyz789"
}
Subnet
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
status - String
|
|
planId - Int
|
|
name - String
|
|
description - String
|
|
direction - String
|
|
networkAddress - String!
|
|
host - String
|
|
defaultGatewayId - Int
|
|
supernetId - Int
|
|
defaultGateway - String
|
|
zone - Zone
|
|
provider - Provider
|
|
vlan - VLAN
|
|
pollable - Boolean
|
|
broadcast - String
|
|
customers - [Customer]
|
|
Contacts - [Contact]
|
|
site - Site
|
|
supportGroups - [SupportGroup]
|
|
subnets - [Subnet]
|
|
supernet - Subnet
|
|
syncStatus - String
|
|
lastSynchronizedAt - String
|
|
syncError - String
|
|
cloudResourceId - String
|
|
importBatchId - Int
|
|
nat - [NAT]
|
|
customAttributes - JSON
|
|
inUse - Int
|
Example
{
"id": 987,
"status": "abc123",
"planId": 987,
"name": "xyz789",
"description": "abc123",
"direction": "xyz789",
"networkAddress": "abc123",
"host": "xyz789",
"defaultGatewayId": 987,
"supernetId": 987,
"defaultGateway": "xyz789",
"zone": Zone,
"provider": Provider,
"vlan": VLAN,
"pollable": false,
"broadcast": "abc123",
"customers": [Customer],
"Contacts": [Contact],
"site": Site,
"supportGroups": [SupportGroup],
"subnets": [Subnet],
"supernet": Subnet,
"syncStatus": "xyz789",
"lastSynchronizedAt": "abc123",
"syncError": "abc123",
"cloudResourceId": "abc123",
"importBatchId": 987,
"nat": [NAT],
"customAttributes": {},
"inUse": 987
}
SubnetFilter
Fields
| Input Field | Description |
|---|---|
name - StringFilter
|
|
description - StringFilter
|
|
zone - ZoneFilter
|
|
customers - CustomerFilter
|
|
site - SiteFilter
|
|
status - StringFilter
|
|
vlan - IntFilter
|
|
customAttributesFilter - JSON
|
|
importBatchId - IntFilter
|
|
and - [SubnetFilter]
|
|
or - [SubnetFilter]
|
|
not - [SubnetFilter]
|
Example
{
"name": StringFilter,
"description": StringFilter,
"zone": ZoneFilter,
"customers": CustomerFilter,
"site": SiteFilter,
"status": StringFilter,
"vlan": IntFilter,
"customAttributesFilter": {},
"importBatchId": IntFilter,
"and": [SubnetFilter],
"or": [SubnetFilter],
"not": [SubnetFilter]
}
SubnetInput
Fields
| Input Field | Description |
|---|---|
zone - String
|
|
networkAddress - String!
|
|
name - String
|
|
description - String
|
|
status - String
|
|
subnets - [SubnetInput]
|
|
contactFirstName - String
|
|
contactLastName - String
|
|
contactPhone - String
|
|
contactEmail - String
|
|
customerName - String
|
|
customerStreetAddress - String
|
|
customerStreetAddressLine2 - String
|
|
customerCity - String
|
|
customerStateProvince - String
|
|
customerCountry - String
|
|
customerPostalZipCode - String
|
|
siteName - String
|
|
siteStreetAddress - String
|
|
siteStreetAddressLine2 - String
|
|
siteCity - String
|
|
siteStateProvince - String
|
|
siteCountry - String
|
|
sitePostalZipCode - String
|
|
vlan - Int
|
|
customAttributes - JSON
|
Example
{
"zone": "xyz789",
"networkAddress": "xyz789",
"name": "xyz789",
"description": "abc123",
"status": "abc123",
"subnets": [SubnetInput],
"contactFirstName": "abc123",
"contactLastName": "xyz789",
"contactPhone": "abc123",
"contactEmail": "abc123",
"customerName": "abc123",
"customerStreetAddress": "xyz789",
"customerStreetAddressLine2": "xyz789",
"customerCity": "abc123",
"customerStateProvince": "xyz789",
"customerCountry": "abc123",
"customerPostalZipCode": "abc123",
"siteName": "abc123",
"siteStreetAddress": "abc123",
"siteStreetAddressLine2": "abc123",
"siteCity": "xyz789",
"siteStateProvince": "xyz789",
"siteCountry": "abc123",
"sitePostalZipCode": "abc123",
"vlan": 987,
"customAttributes": {}
}
SubnetList
SubnetTemplateFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
description - StringFilter
|
|
netmask - IntFilter
|
|
and - [SubnetTemplateFilter]
|
|
or - [SubnetTemplateFilter]
|
|
not - SubnetTemplateFilter
|
Example
{
"id": IntFilter,
"name": StringFilter,
"description": StringFilter,
"netmask": IntFilter,
"and": [SubnetTemplateFilter],
"or": [SubnetTemplateFilter],
"not": SubnetTemplateFilter
}
SupportGroup
SupportGroupFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
description - StringFilter
|
|
contacts - [ContactFilter]
|
|
customAttributes - JSON
|
|
and - [SupportGroupFilter]
|
|
or - [SupportGroupFilter]
|
|
not - [SupportGroupFilter]
|
Example
{
"id": IntFilter,
"name": StringFilter,
"description": StringFilter,
"contacts": [ContactFilter],
"customAttributes": {},
"and": [SupportGroupFilter],
"or": [SupportGroupFilter],
"not": [SupportGroupFilter]
}
SupportGroupList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [SupportGroup]
|
Example
{"count": 987, "total": 123, "results": [SupportGroup]}
SupportTicket
SupportTicketFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
message - StringFilter
|
|
user - UserFilter
|
Example
{
"id": IntFilter,
"message": StringFilter,
"user": UserFilter
}
SupportTicketList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [SupportTicket]
|
Example
{"count": 987, "total": 987, "results": [SupportTicket]}
UserCommunication
UserCommunicationFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
and - [UserCommunicationFilter]
|
|
or - [UserCommunicationFilter]
|
|
not - UserCommunicationFilter
|
Example
{
"id": IntFilter,
"name": StringFilter,
"and": [UserCommunicationFilter],
"or": [UserCommunicationFilter],
"not": UserCommunicationFilter
}
UserCommunicationList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [UserCommunication]
|
Example
{
"count": 987,
"total": 123,
"results": [UserCommunication]
}
UserCommunicationVersion
Example
{
"id": 987,
"UserCommunicationId": 987,
"open": 123,
"send": 987,
"bounce": 123,
"emailBody": "abc123",
"schedule": {},
"createdAt": "2007-12-03",
"UserCommunication": UserCommunication
}
UserCommunicationVersionFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
UserCommunicationId - IntFilter
|
|
open - IntFilter
|
|
send - IntFilter
|
|
bounce - IntFilter
|
|
emailBody - StringFilter
|
|
schedule - JSON
|
|
createdAt - DateFilter
|
|
UserCommunication - UserCommunicationFilter
|
Example
{
"id": IntFilter,
"UserCommunicationId": IntFilter,
"open": IntFilter,
"send": IntFilter,
"bounce": IntFilter,
"emailBody": StringFilter,
"schedule": {},
"createdAt": DateFilter,
"UserCommunication": UserCommunicationFilter
}
UserCommunicationVersionList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [UserCommunicationVersion]
|
Example
{
"count": 987,
"total": 987,
"results": [UserCommunicationVersion]
}
UserFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
firstName - StringFilter
|
|
lastName - StringFilter
|
|
email - StringFilter
|
|
role - StringFilter
|
|
password - StringFilter
|
|
lastLogin - StringFilter
|
|
loginCount - IntFilter
|
|
hideWelcome - BooleanFilter
|
|
superUser - BooleanFilter
|
|
apiKey - StringFilter
|
|
localUser - BooleanFilter
|
|
UserOrganizations - [UserOrganizationFilter]
|
|
Organizations - [OrganizationFilter]
|
|
RoleAssignments - [RoleAssignmentFilter]
|
|
notificationSettings - JSON
|
|
currentOrganizationId - Int
|
|
profile - JSON
|
|
and - [UserFilter]
|
|
or - [UserFilter]
|
|
not - [UserFilter]
|
Example
{
"id": IntFilter,
"firstName": StringFilter,
"lastName": StringFilter,
"email": StringFilter,
"role": StringFilter,
"password": StringFilter,
"lastLogin": StringFilter,
"loginCount": IntFilter,
"hideWelcome": BooleanFilter,
"superUser": BooleanFilter,
"apiKey": StringFilter,
"localUser": BooleanFilter,
"UserOrganizations": [UserOrganizationFilter],
"Organizations": [OrganizationFilter],
"RoleAssignments": [RoleAssignmentFilter],
"notificationSettings": {},
"currentOrganizationId": 123,
"profile": {},
"and": [UserFilter],
"or": [UserFilter],
"not": [UserFilter]
}
UserGroup
UserGroupFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
name - StringFilter
|
|
description - StringFilter
|
|
users - [UserFilter]
|
Example
{
"id": IntFilter,
"name": StringFilter,
"description": StringFilter,
"users": [UserFilter]
}
UserGroupList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
total - Int
|
|
results - [UserGroup]
|
Example
{"count": 123, "total": 987, "results": [UserGroup]}
UserOrganization
Example
{
"id": 123,
"role": "abc123",
"email": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"admin": true,
"UserId": 123,
"OrganizationId": 987
}
UserOrganizationFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
role - StringFilter
|
|
email - StringFilter
|
|
firstName - StringFilter
|
|
lastName - StringFilter
|
|
admin - BooleanFilter
|
|
user - UserFilter
|
|
organization - OrganizationFilter
|
Example
{
"id": IntFilter,
"role": StringFilter,
"email": StringFilter,
"firstName": StringFilter,
"lastName": StringFilter,
"admin": BooleanFilter,
"user": UserFilter,
"organization": OrganizationFilter
}
UserOrganizationInput
UserOrganizationList
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
results - [UserOrganization]
|
Example
{"count": 987, "results": [UserOrganization]}
VLAN
VLANFilter
Fields
| Input Field | Description |
|---|---|
number - IntFilter
|
|
and - [VLANFilter]
|
|
or - [VLANFilter]
|
|
not - VLANFilter
|
Example
{
"number": IntFilter,
"and": [VLANFilter],
"or": [VLANFilter],
"not": VLANFilter
}
VLANList
Zone
Example
{
"id": 987,
"name": "abc123",
"description": "xyz789",
"VRF": "abc123",
"providerId": 987,
"provider": Provider,
"parentZone": [Zone],
"cloudResourceId": "abc123",
"importBatchId": 123,
"customAttributes": {}
}
ZoneFilter
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
|
importBatchId - IntFilter
|
|
name - StringFilter
|
|
description - StringFilter
|
|
VRF - StringFilter
|
|
provider - ProviderFilter
|
|
parentZone - [ZoneFilter]
|
|
cloudResourceId - StringFilter
|
|
customAttributesFilter - JSON
|
|
and - [ZoneFilter]
|
|
or - [ZoneFilter]
|
|
not - ZoneFilter
|
Example
{
"id": IntFilter,
"importBatchId": IntFilter,
"name": StringFilter,
"description": StringFilter,
"VRF": StringFilter,
"provider": ProviderFilter,
"parentZone": [ZoneFilter],
"cloudResourceId": StringFilter,
"customAttributesFilter": {},
"and": [ZoneFilter],
"or": [ZoneFilter],
"not": ZoneFilter
}