Lightmesh GraphQL API documentation

This is the GraphQL API documentation for Tidal Lightmesh.

API Endpoints
http://next.lightmesh.com/graphql
Version

1.0.0

Lightmesh guides

Need more information? Visit the Lightmesh guides for additional help.

Queries

activities

Response

Returns an ActivityList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String

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": 123,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789"
}
Response
{
  "data": {
    "activities": {
      "count": 987,
      "total": 987,
      "results": [Activity]
    }
  }
}

address

Response

Returns an Address

Arguments
Name Description
id - Int!

Example

Query
query Address($id: Int!) {
  address(id: $id) {
    id
    line1
    line2
    line3
    line4
    municipality
    province
    country
    postalCode
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "address": {
      "id": 123,
      "line1": "abc123",
      "line2": "xyz789",
      "line3": "abc123",
      "line4": "xyz789",
      "municipality": "xyz789",
      "province": "abc123",
      "country": "abc123",
      "postalCode": "xyz789"
    }
  }
}

addresses

Response

Returns an AddressList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String

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": "xyz789",
  "sort_dir": "abc123",
  "type": "xyz789"
}
Response
{
  "data": {
    "addresses": {"count": 123, "results": [Address]}
  }
}

alert

Response

Returns an Alert

Arguments
Name Description
id - Int!

Example

Query
query Alert($id: Int!) {
  alert(id: $id) {
    id
    SubnetId
    UserId
    AlertRuleId
    status
    type
    name
    Subnet {
      id
      status
      planId
      name
      description
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
    description
    message
    clearNotification
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "alert": {
      "id": 123,
      "SubnetId": 987,
      "UserId": 987,
      "AlertRuleId": 987,
      "status": "xyz789",
      "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": 987,
      "type": "xyz789",
      "URL": "xyz789",
      "slackChannel": "abc123",
      "email": "xyz789",
      "status": "abc123",
      "verificationCode": "abc123",
      "options": {},
      "createdAt": "xyz789"
    }
  }
}

alertDestinations

Response

Returns an AlertDestinationList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
filter - AlertDestinationFilter

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": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "filter": AlertDestinationFilter
}
Response
{
  "data": {
    "alertDestinations": {
      "count": 123,
      "total": 123,
      "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": 987,
      "UserId": 987,
      "userName": "abc123",
      "AlertRuleId": 987,
      "rules": [AlertRule]
    }
  }
}

alertRecipients

Response

Returns an AlertRecipientList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String

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": "abc123",
  "sort_dir": "xyz789",
  "type": "xyz789"
}
Response
{
  "data": {
    "alertRecipients": {
      "count": 123,
      "results": [AlertRecipient]
    }
  }
}

alertRule

Response

Returns an AlertRule

Arguments
Name Description
id - Int!

Example

Query
query AlertRule($id: Int!) {
  alertRule(id: $id) {
    id
    SubnetId
    ZoneId
    networkAddress
    status
    type
    name
    description
    conditions
    subnet {
      id
      status
      planId
      name
      description
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      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": 987,
      "SubnetId": 123,
      "ZoneId": 123,
      "networkAddress": "xyz789",
      "status": "abc123",
      "type": "abc123",
      "name": "abc123",
      "description": "xyz789",
      "conditions": {},
      "subnet": Subnet,
      "AlertDestinations": [AlertDestination],
      "AlertRecipientId": 987,
      "AlertRecipients": [AlertRecipient],
      "recipients": [AlertRecipient]
    }
  }
}

alertRules

Response

Returns an AlertRuleList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
SubnetId - Int

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": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "type": "abc123",
  "SubnetId": 123
}
Response
{
  "data": {
    "alertRules": {
      "count": 987,
      "total": 987,
      "results": [AlertRule]
    }
  }
}

alerts

Response

Returns an AlertList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
SubnetId - Int
filter - AlertFilter

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": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "type": "xyz789",
  "SubnetId": 987,
  "filter": AlertFilter
}
Response
{
  "data": {
    "alerts": {
      "count": 123,
      "total": 987,
      "results": [Alert]
    }
  }
}

apiKey

Response

Returns an ApiKey

Arguments
Name Description
id - Int!

Example

Query
query ApiKey($id: Int!) {
  apiKey(id: $id) {
    id
    apiKey
    apiKeyExpiry
    apiKeyName
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "apiKey": {
      "id": 123,
      "apiKey": "abc123",
      "apiKeyExpiry": "abc123",
      "apiKeyName": "xyz789"
    }
  }
}

apiKeys

Response

Returns an ApiKeyList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String

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": "xyz789",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123"
}
Response
{
  "data": {
    "apiKeys": {
      "count": 123,
      "total": 123,
      "results": [ApiKey]
    }
  }
}

availableIPAssignments

Response

Returns an IPAssignmentList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
subnet_id - Int

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
      }
      cloudAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "subnet_id": 123
}
Response
{
  "data": {
    "availableIPAssignments": {
      "count": 987,
      "total": 123,
      "results": [IPAssignment]
    }
  }
}

availableSubnets

Response

Returns a NetworkAddressList

Arguments
Name Description
search - String
netmask - Int
limit - Int
offset - Int
sort_by - String
sort_dir - String

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": "abc123",
  "netmask": 123,
  "limit": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "xyz789"
}
Response
{
  "data": {
    "availableSubnets": {
      "count": 123,
      "results": [NetworkAddress]
    }
  }
}

contact

Response

Returns a Contact

Arguments
Name Description
id - Int!

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": 123}
Response
{
  "data": {
    "contact": {
      "id": 123,
      "firstName": "xyz789",
      "lastName": "abc123",
      "phone": "abc123",
      "cellPhone": "xyz789",
      "email": "abc123",
      "email2": "abc123",
      "importBatchId": 123,
      "SupportGroupId": 987,
      "supportGroup": SupportGroup,
      "customAttributes": {}
    }
  }
}

contactIpAddresses

Response

Returns an IPAddressList

Arguments
Name Description
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

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
      }
      cloudAttributes
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "subnet_id": 123,
  "available": true,
  "contiguous": true,
  "subnetName": "abc123",
  "subnet": "xyz789",
  "contactId": 987
}
Response
{
  "data": {
    "contactIpAddresses": {
      "count": 987,
      "total": 123,
      "results": [IPAddress]
    }
  }
}

contactSubnets

Response

Returns a SubnetList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
contactId - Int

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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 123,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "contactId": 123
}
Response
{
  "data": {
    "contactSubnets": {
      "count": 123,
      "total": 123,
      "results": [Subnet]
    }
  }
}

contactSubnetsResources

Response

Returns a ResourceList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
contactId - Int

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": "abc123",
  "limit": 987,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "contactId": 987
}
Response
{
  "data": {
    "contactSubnetsResources": {
      "count": 987,
      "total": 987,
      "results": [Resource]
    }
  }
}

contacts

Response

Returns a ContactList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
contactableId - Int
contactableType - String
importId - Int
filter - ContactFilter

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": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "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": 123}
Response
{
  "data": {
    "customAttribute": {
      "id": 987,
      "modelName": "xyz789",
      "name": "abc123",
      "type": "xyz789",
      "required": true,
      "sectionId": 123,
      "rowIndex": 123,
      "rowColSpan": 123,
      "colIndex": 123,
      "colSpan": 987,
      "component": "xyz789"
    }
  }
}

customAttributes

Response

Returns a CustomAttributeList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
modelName - String
filter - CustomAttributeFilter

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": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "modelName": "abc123",
  "filter": CustomAttributeFilter
}
Response
{
  "data": {
    "customAttributes": {
      "count": 987,
      "results": [CustomAttribute]
    }
  }
}

customer

Response

Returns a Customer

Arguments
Name Description
id - Int!

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": 987,
      "name": "abc123",
      "importId": 987,
      "importBatchId": 987,
      "addresses": [Address],
      "sites": [Site],
      "customAttributes": {}
    }
  }
}

customerIpAddresses

Response

Returns an IPAddressList

Arguments
Name Description
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

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
      }
      cloudAttributes
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "subnet_id": 987,
  "available": false,
  "contiguous": false,
  "subnetName": "abc123",
  "subnet": "abc123",
  "customerId": 123
}
Response
{
  "data": {
    "customerIpAddresses": {
      "count": 123,
      "total": 987,
      "results": [IPAddress]
    }
  }
}

customerSubnets

Response

Returns a SubnetList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
customerId - Int

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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "customerId": 123
}
Response
{
  "data": {
    "customerSubnets": {
      "count": 123,
      "total": 123,
      "results": [Subnet]
    }
  }
}

customers

Response

Returns a CustomerList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
subnetId - Int
importId - Int
filter - CustomerFilter

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": "abc123",
  "subnetId": 123,
  "importId": 987,
  "filter": CustomerFilter
}
Response
{
  "data": {
    "customers": {
      "count": 987,
      "total": 987,
      "results": [Customer]
    }
  }
}

dataCenterIpAddresses

Response

Returns an IPAddressList

Arguments
Name Description
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

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
      }
      cloudAttributes
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "subnet_id": 123,
  "available": false,
  "contiguous": true,
  "subnetName": "abc123",
  "subnet": "xyz789",
  "dataCenterId": 987
}
Response
{
  "data": {
    "dataCenterIpAddresses": {
      "count": 123,
      "total": 123,
      "results": [IPAddress]
    }
  }
}

dataCenterSubnets

Response

Returns a SubnetList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
dataCenterId - Int

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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "dataCenterId": 123
}
Response
{
  "data": {
    "dataCenterSubnets": {
      "count": 987,
      "total": 123,
      "results": [Subnet]
    }
  }
}

dataCenterSubnetsResources

Response

Returns a ResourceList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
dataCenterId - Int

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": "xyz789",
  "limit": 987,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "dataCenterId": 123
}
Response
{
  "data": {
    "dataCenterSubnetsResources": {
      "count": 123,
      "total": 123,
      "results": [Resource]
    }
  }
}

dataCenterZones

Response

Returns a ZoneList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
providerId - Int
importId - Int
dataCenterId - Int

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
      cloudAttributes
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 987,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "providerId": 123,
  "importId": 987,
  "dataCenterId": 987
}
Response
{
  "data": {
    "dataCenterZones": {
      "count": 987,
      "total": 987,
      "results": [Zone]
    }
  }
}

dnsEntries

Response

Returns an DNSEntryList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
filter - DNSEntryFilter

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": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "filter": DNSEntryFilter
}
Response
{
  "data": {
    "dnsEntries": {
      "count": 123,
      "total": 123,
      "results": [DNSEntry]
    }
  }
}

dnsEntry

Response

Returns an DNSEntry

Arguments
Name Description
id - Int!

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
      }
      cloudAttributes
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "dnsEntry": {
      "id": 987,
      "name": "abc123",
      "ttl": 123,
      "recordClass": "xyz789",
      "recordType": "abc123",
      "recordData": "xyz789",
      "dnsZone": [DNSZone],
      "customAttributes": {},
      "networkAddress": "xyz789",
      "priority": 123,
      "status": "abc123",
      "IPAssignment": IPAssignment
    }
  }
}

identities

Response

Returns an IdentityResultList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String

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": "xyz789",
  "limit": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123"
}
Response
{
  "data": {
    "identities": {
      "count": 123,
      "total": 987,
      "results": [UserGroup]
    }
  }
}

import

Response

Returns an Import

Arguments
Name Description
id - Int!

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": 123}
Response
{
  "data": {
    "import": {
      "id": 123,
      "description": "xyz789",
      "customer_count": 987,
      "contact_count": 987,
      "site_count": 987,
      "zone_count": 123,
      "subnet_count": 123,
      "ip_assignment_count": 123,
      "records": [ImportRecord]
    }
  }
}

importStats

Response

Returns an Import

Arguments
Name Description
id - Int!

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": 987}
Response
{
  "data": {
    "importStats": {
      "id": 123,
      "description": "abc123",
      "customer_count": 123,
      "contact_count": 987,
      "site_count": 987,
      "zone_count": 987,
      "subnet_count": 987,
      "ip_assignment_count": 123,
      "records": [ImportRecord]
    }
  }
}

imports

Response

Returns an ImportList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
filter - ImportFilter

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": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "type": "abc123",
  "filter": ImportFilter
}
Response
{"data": {"imports": {"count": 987, "results": [Import]}}}

interface

Response

Returns an Interface

Arguments
Name Description
id - Int!

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
      }
      cloudAttributes
    }
    cloudResourceId
    cloudAttributes
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "interface": {
      "id": 123,
      "name": "xyz789",
      "macAddress": "abc123",
      "resource": Resource,
      "ipAssignment": IPAssignment,
      "cloudResourceId": "xyz789",
      "cloudAttributes": {}
    }
  }
}

interfaces

Response

Returns an InterfaceList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
filter - InterfaceFilter

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
      cloudAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 123,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "filter": InterfaceFilter
}
Response
{
  "data": {
    "interfaces": {"count": 987, "results": [Interface]}
  }
}

ipAddress

Response

Returns an IPAddress

Arguments
Name Description
networkAddress - String!
subnetId - Int!

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
      }
      cloudAttributes
    }
    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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
    zone {
      id
      name
      description
      VRF
      providerId
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
      cloudAttributes
    }
    cloudAttributes
  }
}
Variables
{
  "networkAddress": "xyz789",
  "subnetId": 987
}
Response
{
  "data": {
    "ipAddress": {
      "id": 123,
      "networkAddress": "xyz789",
      "ipAddressType": "xyz789",
      "ipAssignment": IPAssignment,
      "expirationDate": "abc123",
      "reservation": Reservation,
      "request": NetworkRequestItem,
      "scanResults": [ScanResult],
      "inUse": false,
      "subnet": Subnet,
      "zone": Zone,
      "cloudAttributes": {}
    }
  }
}

ipAddresses

Response

Returns an IPAddressList

Arguments
Name Description
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

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
      }
      cloudAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "subnet_id": 123,
  "available": false,
  "contiguous": false,
  "subnetName": "abc123",
  "subnet": "xyz789",
  "filter": IPAddressFilter
}
Response
{
  "data": {
    "ipAddresses": {
      "count": 123,
      "total": 987,
      "results": [IPAddress]
    }
  }
}

ipAssignment

Response

Returns an IPAssignment

Arguments
Name Description
id - Int
subnetId - Int

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
      cloudAttributes
    }
    lastSeenAt
    subnet {
      id
      status
      planId
      name
      description
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      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
      cloudAttributes
    }
    cloudResourceId
    createdAt
    importBatchId
    customAttributes
    request {
      id
      status
      zoneId
      ipAddress
      macAddress
      interface
      hostname
      customAttributes
      description
      networkRequestId
      networkRequest {
        ...NetworkRequestFragment
      }
    }
    cloudAttributes
  }
}
Variables
{"id": 123, "subnetId": 123}
Response
{
  "data": {
    "ipAssignment": {
      "id": 123,
      "subnetId": 987,
      "networkAddress": "xyz789",
      "description": "abc123",
      "ipAddressType": "abc123",
      "interface": Interface,
      "lastSeenAt": "xyz789",
      "subnet": Subnet,
      "DNSEntries": [DNSEntry],
      "resource": Resource,
      "interfaces": [Interface],
      "cloudResourceId": "abc123",
      "createdAt": "xyz789",
      "importBatchId": 123,
      "customAttributes": {},
      "request": NetworkRequestItem,
      "cloudAttributes": {}
    }
  }
}

ipAssignments

Response

Returns an IPAssignmentList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
subnet_id - Int
importId - Int
subnet - String
zoneName - String
filter - IPAssignmentFilter

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
      }
      cloudAttributes
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "subnet_id": 987,
  "importId": 123,
  "subnet": "abc123",
  "zoneName": "abc123",
  "filter": IPAssignmentFilter
}
Response
{
  "data": {
    "ipAssignments": {
      "count": 987,
      "total": 123,
      "results": [IPAssignment]
    }
  }
}

location

Response

Returns a Location

Arguments
Name Description
id - Int!

Example

Query
query Location($id: Int!) {
  location(id: $id) {
    id
    name
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "location": {
      "id": 123,
      "name": "xyz789"
    }
  }
}

locations

Response

Returns a LocationList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String

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": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "type": "abc123"
}
Response
{
  "data": {
    "locations": {"count": 123, "results": [Location]}
  }
}

nat

Response

Returns an NAT

Arguments
Name Description
id - Int!

Example

Query
query Nat($id: Int!) {
  nat(id: $id) {
    id
    sourceNatAddress
    destinationNatAddress
    natType
    sourcePort
    sourceNatZoneId
    destinationPort
    destinationNatZoneId
    sourceType
    destinationType
    subnetId
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "nat": {
      "id": 987,
      "sourceNatAddress": "xyz789",
      "destinationNatAddress": ["abc123"],
      "natType": "xyz789",
      "sourcePort": 123,
      "sourceNatZoneId": 987,
      "destinationPort": 987,
      "destinationNatZoneId": 987,
      "sourceType": "abc123",
      "destinationType": "abc123",
      "subnetId": 987
    }
  }
}

nats

Response

Returns a NATList

Arguments
Name Description
destinationNatZoneId - Int
sourceNatZoneId - Int
subnetId - Int
limit - Int
offset - Int
sort_by - String
sort_dir - String
filter - NATFilter

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
    total
    results {
      id
      sourceNatAddress
      destinationNatAddress
      natType
      sourcePort
      sourceNatZoneId
      destinationPort
      destinationNatZoneId
      sourceType
      destinationType
      subnetId
    }
  }
}
Variables
{
  "destinationNatZoneId": 987,
  "sourceNatZoneId": 987,
  "subnetId": 123,
  "limit": 987,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "filter": NATFilter
}
Response
{
  "data": {
    "nats": {"count": 123, "total": 987, "results": [NAT]}
  }
}

networkContainer

Response

Returns a NetworkContainer

Arguments
Name Description
id - Int!

Example

Query
query NetworkContainer($id: Int!) {
  networkContainer(id: $id) {
    id
    name
    cidrAddress
    filter
    subnets {
      id
      status
      planId
      name
      description
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
    site {
      id
      name
      importBatchId
      subnetId
      addresses {
        ...AddressFragment
      }
      customAttributes
    }
    zone {
      id
      name
      description
      VRF
      providerId
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
      cloudAttributes
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "networkContainer": {
      "id": 987,
      "name": "xyz789",
      "cidrAddress": "abc123",
      "filter": {},
      "subnets": [Subnet],
      "site": Site,
      "zone": Zone
    }
  }
}

networkContainers

Response

Returns a NetworkContainerList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String

Example

Query
query NetworkContainers(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $type: String
) {
  networkContainers(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    type: $type
  ) {
    count
    total
    results {
      id
      name
      cidrAddress
      filter
      subnets {
        ...SubnetFragment
      }
      site {
        ...SiteFragment
      }
      zone {
        ...ZoneFragment
      }
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "type": "abc123"
}
Response
{
  "data": {
    "networkContainers": {
      "count": 123,
      "total": 987,
      "results": [NetworkContainer]
    }
  }
}

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": "xyz789",
      "networkAddress": "xyz789",
      "zoneId": "abc123",
      "subnetId": 987,
      "NetworkRequestItems": [NetworkRequestItem],
      "createdAt": "abc123"
    }
  }
}

networkRequests

Response

Returns a NetworkRequestList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
subnetId - Int
status - String
filter - NetworkRequestFilter

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": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "type": "abc123",
  "subnetId": 123,
  "status": "xyz789",
  "filter": NetworkRequestFilter
}
Response
{
  "data": {
    "networkRequests": {
      "count": 123,
      "results": [NetworkRequest]
    }
  }
}

networkSearch

Response

Returns a NetworkResultList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String

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": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123"
}
Response
{
  "data": {
    "networkSearch": {
      "count": 123,
      "total": 987,
      "results": [Subnet]
    }
  }
}

nextAvailableSubnet

Response

Returns a NetworkAddress

Arguments
Name Description
subnetId - Int
networkContainerId - Int
netmask - Int
filter - SubnetFilter

Example

Query
query NextAvailableSubnet(
  $subnetId: Int,
  $networkContainerId: Int,
  $netmask: Int,
  $filter: SubnetFilter
) {
  nextAvailableSubnet(
    subnetId: $subnetId,
    networkContainerId: $networkContainerId,
    netmask: $netmask,
    filter: $filter
  ) {
    networkAddress
  }
}
Variables
{
  "subnetId": 123,
  "networkContainerId": 123,
  "netmask": 987,
  "filter": SubnetFilter
}
Response
{
  "data": {
    "nextAvailableSubnet": {
      "networkAddress": "abc123"
    }
  }
}

provider

Response

Returns a Provider

Arguments
Name Description
id - Int!

Example

Query
query Provider($id: Int!) {
  provider(id: $id) {
    id
    name
    active
    type
    azureAppId
    azurePassword
    azureTenantId
    awsAccountId
    awsRoleName
    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": "abc123",
      "azureTenantId": "xyz789",
      "awsAccountId": "abc123",
      "awsRoleName": "abc123",
      "awsAccessKeyId": "xyz789",
      "awsSecretAccessKey": "abc123",
      "awsSessionToken": "abc123",
      "lastSynchronizedAt": "xyz789",
      "syncStatus": "xyz789",
      "syncError": "abc123",
      "subnetCount": 123,
      "ipCount": 123,
      "resourceCount": 987,
      "createdAt": "abc123",
      "customAttributes": {}
    }
  }
}

providers

Response

Returns a ProviderList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
filter - ProviderFilter

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
      awsAccountId
      awsRoleName
      awsAccessKeyId
      awsSecretAccessKey
      awsSessionToken
      lastSynchronizedAt
      syncStatus
      syncError
      subnetCount
      ipCount
      resourceCount
      createdAt
      customAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "type": "abc123",
  "filter": ProviderFilter
}
Response
{
  "data": {
    "providers": {
      "count": 123,
      "total": 123,
      "results": [Provider]
    }
  }
}

region

Response

Returns a Region

Arguments
Name Description
id - Int!

Example

Query
query Region($id: Int!) {
  region(id: $id) {
    id
    name
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "region": {"id": 987, "name": "abc123"}
  }
}

regions

Response

Returns a RegionList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String

Example

Query
query Regions(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $type: String
) {
  regions(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    type: $type
  ) {
    count
    results {
      id
      name
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "type": "xyz789"
}
Response
{"data": {"regions": {"count": 123, "results": [Region]}}}

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
      }
      cloudAttributes
    }
    subnetId
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "reservation": {
      "id": 123,
      "name": "abc123",
      "description": "abc123",
      "color": "xyz789",
      "ipAddresses": [IPAddress],
      "subnetId": 987
    }
  }
}

reservations

Response

Returns a ReservationList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
subnet_id - Int
filter - ReservationFilter

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": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "subnet_id": 123,
  "filter": ReservationFilter
}
Response
{
  "data": {
    "reservations": {
      "count": 987,
      "results": [Reservation]
    }
  }
}

resource

Response

Returns a Resource

Arguments
Name Description
id - Int!

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
      awsAccountId
      awsRoleName
      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
      cloudAttributes
    }
    createdAt
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "resource": {
      "id": 987,
      "hostname": "xyz789",
      "OS": "abc123",
      "OSVersion": "xyz789",
      "macAddress": "abc123",
      "cloudResourceId": "xyz789",
      "resourceGroupId": "abc123",
      "resourceTypeId": 987,
      "provider": Provider,
      "lastSeenAt": "abc123",
      "ResourceStatus": ResourceStatus,
      "resourceType": ResourceType,
      "interfaces": [Interface],
      "createdAt": "xyz789"
    }
  }
}

resourceStatus

Response

Returns a ResourceStatus

Arguments
Name Description
id - Int!

Example

Query
query ResourceStatus($id: Int!) {
  resourceStatus(id: $id) {
    id
    name
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "resourceStatus": {
      "id": 987,
      "name": "abc123"
    }
  }
}

resourceStatuses

Response

Returns a ResourceStatusList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
filter - ResourceStatusFilter

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": "abc123",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "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": 987,
      "name": "xyz789"
    }
  }
}

resourceTypes

Response

Returns a ResourceTypeList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
filter - ResourceTypeFilter

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": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "type": "xyz789",
  "filter": ResourceTypeFilter
}
Response
{
  "data": {
    "resourceTypes": {
      "count": 123,
      "results": [ResourceType]
    }
  }
}

resources

Response

Returns a ResourceList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
subnetId - Int
filter - ResourceFilter

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": "abc123",
  "limit": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "subnetId": 987,
  "filter": ResourceFilter
}
Response
{
  "data": {
    "resources": {
      "count": 123,
      "total": 123,
      "results": [Resource]
    }
  }
}

returningUsersByMonth

Response

Returns [ReturningUsersByMonth]

Example

Query
query ReturningUsersByMonth {
  returningUsersByMonth {
    value
    label
  }
}
Response
{
  "data": {
    "returningUsersByMonth": [
      {"value": 987, "label": "abc123"}
    ]
  }
}

role

Response

Returns a Role

Arguments
Name Description
id - Int!

Example

Query
query Role($id: Int!) {
  role(id: $id) {
    id
    name
    description
    plans {
      id
      name
      projectId
      description
      subnets {
        ...SubnetFragment
      }
      plannedChanges {
        ...PlannedChangeFragment
      }
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "role": {
      "id": 123,
      "name": "xyz789",
      "description": "xyz789",
      "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": 987}
Response
{
  "data": {
    "roleAssignment": {
      "id": 987,
      "subjectId": 123,
      "subjectType": "abc123",
      "recordId": "abc123",
      "recordType": "abc123",
      "networkAddress": "abc123",
      "zoneId": 123,
      "userGroup": UserGroup,
      "role": Role
    }
  }
}

roleAssignments

Response

Returns a RoleAssignmentList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
recordType - String
recordId - Int
filter - RoleAssignmentFilter

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": "abc123",
  "sort_dir": "xyz789",
  "recordType": "xyz789",
  "recordId": 987,
  "filter": RoleAssignmentFilter
}
Response
{
  "data": {
    "roleAssignments": {
      "count": 987,
      "total": 987,
      "results": [RoleAssignment]
    }
  }
}

roles

Response

Returns a RoleList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
filter - RoleFilter

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": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "type": "abc123",
  "filter": RoleFilter
}
Response
{"data": {"roles": {"count": 987, "results": [Role]}}}

scan

Response

Returns a Scan

Arguments
Name Description
networkAddress - String!
zoneId - Int

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": 123}
Response
{
  "data": {
    "scan": {
      "id": 123,
      "subnetId": 987,
      "zoneId": 987,
      "networkAddress": "xyz789",
      "hostname": "abc123",
      "macAddress": "abc123",
      "interface": "xyz789",
      "scannedAt": "2007-12-03",
      "scanCommand": "xyz789",
      "customAttributes": {},
      "ignore": false,
      "sourceType": "abc123",
      "sourceVersion": "xyz789",
      "fileName": "xyz789",
      "result": "xyz789",
      "userId": 987
    }
  }
}

scanResult

Response

Returns a ScanResult

Arguments
Name Description
networkAddress - String!
zoneId - Int

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": "xyz789", "zoneId": 987}
Response
{
  "data": {
    "scanResult": {
      "id": 987,
      "subnetId": 987,
      "zoneId": 123,
      "networkAddress": "abc123",
      "hostname": "abc123",
      "resourceType": "abc123",
      "macAddress": "abc123",
      "cloudResourceId": "abc123",
      "interface": "xyz789",
      "scannedAt": "2007-12-03",
      "ScanId": 987,
      "customAttributes": {},
      "ignore": false,
      "sourceType": "xyz789",
      "sourceVersion": "abc123",
      "fileName": "xyz789",
      "result": "xyz789",
      "ipAssignmentId": 987
    }
  }
}

scanResults

Response

Returns a ScanResultList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
networkAddress - String
zoneId - Int
subnetId - Int
filter - ScanResultFilter

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": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "networkAddress": "xyz789",
  "zoneId": 123,
  "subnetId": 123,
  "filter": ScanResultFilter
}
Response
{
  "data": {
    "scanResults": {
      "count": 987,
      "total": 987,
      "results": [ScanResult]
    }
  }
}

scans

Response

Returns a ScanList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
networkAddress - String
zoneId - Int
subnetId - Int
filter - ScanFilter

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": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "networkAddress": "abc123",
  "zoneId": 123,
  "subnetId": 987,
  "filter": ScanFilter
}
Response
{
  "data": {
    "scans": {
      "count": 123,
      "total": 987,
      "results": [Scan]
    }
  }
}

site

Response

Returns a Site

Arguments
Name Description
id - Int!

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": 987,
      "name": "xyz789",
      "importBatchId": 987,
      "subnetId": 123,
      "addresses": [Address],
      "customAttributes": {}
    }
  }
}

siteIpAddresses

Response

Returns an IPAddressList

Arguments
Name Description
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

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
      }
      cloudAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "subnet_id": 123,
  "available": true,
  "contiguous": false,
  "subnetName": "abc123",
  "subnet": "abc123",
  "siteId": 123
}
Response
{
  "data": {
    "siteIpAddresses": {
      "count": 123,
      "total": 123,
      "results": [IPAddress]
    }
  }
}

siteSubnets

Response

Returns a SubnetList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
siteId - Int

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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "siteId": 987
}
Response
{
  "data": {
    "siteSubnets": {
      "count": 987,
      "total": 123,
      "results": [Subnet]
    }
  }
}

siteSubnetsResources

Response

Returns a ResourceList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
siteId - Int

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": 987,
      "results": [Resource]
    }
  }
}

sites

Response

Returns a SiteList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
importId - Int
filter - SiteFilter

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": 123,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "type": "xyz789",
  "importId": 123,
  "filter": SiteFilter
}
Response
{
  "data": {
    "sites": {
      "count": 987,
      "total": 123,
      "results": [Site]
    }
  }
}

stripeSubscriptionPlansPricing

Response

Returns a StripePricingList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
importId - Int

Example

Query
query StripeSubscriptionPlansPricing(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $type: String,
  $importId: Int
) {
  stripeSubscriptionPlansPricing(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    type: $type,
    importId: $importId
  ) {
    count
    total
    results {
      subscriptionPlanId
      subscriptionPlanName
      stripeMonthlyPriceId
      stripeYearlyPriceId
      stripeMonthlyPrice {
        ...PriceDetailsFragment
      }
      stripeYearlyPrice {
        ...PriceDetailsFragment
      }
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "type": "abc123",
  "importId": 987
}
Response
{
  "data": {
    "stripeSubscriptionPlansPricing": {
      "count": 987,
      "total": 987,
      "results": [StripePricing]
    }
  }
}

subnet

Response

Returns a Subnet

Arguments
Name Description
id - Int!

Example

Query
query Subnet($id: Int!) {
  subnet(id: $id) {
    id
    status
    planId
    name
    description
    networkAddress
    host
    defaultGatewayId
    supernetId
    defaultGateway
    zone {
      id
      name
      description
      VRF
      providerId
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
      cloudAttributes
    }
    provider {
      id
      name
      active
      type
      azureAppId
      azurePassword
      azureTenantId
      awsAccountId
      awsRoleName
      awsAccessKeyId
      awsSecretAccessKey
      awsSessionToken
      lastSynchronizedAt
      syncStatus
      syncError
      subnetCount
      ipCount
      resourceCount
      createdAt
      customAttributes
    }
    region {
      id
      name
    }
    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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
    supernet {
      id
      status
      planId
      name
      description
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
    syncStatus
    lastSynchronizedAt
    syncError
    cloudResourceId
    importBatchId
    nat {
      id
      sourceNatAddress
      destinationNatAddress
      natType
      sourcePort
      sourceNatZoneId
      destinationPort
      destinationNatZoneId
      sourceType
      destinationType
      subnetId
    }
    customAttributes
    cloudAttributes
    inUse
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "subnet": {
      "id": 123,
      "status": "abc123",
      "planId": 987,
      "name": "abc123",
      "description": "abc123",
      "networkAddress": "xyz789",
      "host": "xyz789",
      "defaultGatewayId": 987,
      "supernetId": 987,
      "defaultGateway": "abc123",
      "zone": Zone,
      "provider": Provider,
      "region": Region,
      "vlan": VLAN,
      "pollable": true,
      "broadcast": "abc123",
      "customers": [Customer],
      "Contacts": [Contact],
      "site": Site,
      "supportGroups": [SupportGroup],
      "subnets": [Subnet],
      "supernet": Subnet,
      "syncStatus": "abc123",
      "lastSynchronizedAt": "abc123",
      "syncError": "xyz789",
      "cloudResourceId": "xyz789",
      "importBatchId": 987,
      "nat": [NAT],
      "customAttributes": {},
      "cloudAttributes": {},
      "inUse": 123
    }
  }
}

subnetSupportGroupContacts

Response

Returns a ContactList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
subnetId - Int
contactableId - Int
contactableType - String

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": "abc123",
  "limit": 987,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "subnetId": 123,
  "contactableId": 987,
  "contactableType": "abc123"
}
Response
{
  "data": {
    "subnetSupportGroupContacts": {
      "count": 987,
      "total": 987,
      "results": [Contact]
    }
  }
}

subnets

Response

Returns a SubnetList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
supernetId - Int
importId - Int
zoneName - String
topLevelOnly - Boolean
filter - SubnetFilter

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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "supernetId": 987,
  "importId": 987,
  "zoneName": "xyz789",
  "topLevelOnly": false,
  "filter": SubnetFilter
}
Response
{
  "data": {
    "subnets": {
      "count": 123,
      "total": 123,
      "results": [Subnet]
    }
  }
}

subnetsResources

Response

Returns a ResourceList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
customerId - Int

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": "xyz789",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "customerId": 987
}
Response
{
  "data": {
    "subnetsResources": {
      "count": 987,
      "total": 123,
      "results": [Resource]
    }
  }
}

subscriptionPlan

Response

Returns a SubscriptionPlan

Arguments
Name Description
id - Int!

Example

Query
query SubscriptionPlan($id: Int!) {
  subscriptionPlan(id: $id) {
    id
    name
    ipLimit
    userLimit
    logRetention
    apiRateLimit
    planFeatures
    emc
    stripeMonthlyPriceId
    stripeYearlyPriceId
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "subscriptionPlan": {
      "id": 123,
      "name": "abc123",
      "ipLimit": 123,
      "userLimit": 987,
      "logRetention": 987,
      "apiRateLimit": 987,
      "planFeatures": {},
      "emc": 987,
      "stripeMonthlyPriceId": "xyz789",
      "stripeYearlyPriceId": "abc123"
    }
  }
}

subscriptionPlans

Response

Returns a SubscriptionPlanList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
type - String
importId - Int

Example

Query
query SubscriptionPlans(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $type: String,
  $importId: Int
) {
  subscriptionPlans(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    type: $type,
    importId: $importId
  ) {
    count
    total
    results {
      id
      name
      ipLimit
      userLimit
      logRetention
      apiRateLimit
      planFeatures
      emc
      stripeMonthlyPriceId
      stripeYearlyPriceId
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "type": "abc123",
  "importId": 123
}
Response
{
  "data": {
    "subscriptionPlans": {
      "count": 123,
      "total": 987,
      "results": [SubscriptionPlan]
    }
  }
}

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": 123}
Response
{
  "data": {
    "supportGroup": {
      "id": 123,
      "name": "xyz789",
      "description": "abc123",
      "contacts": [Contact],
      "customAttributes": {}
    }
  }
}

supportGroupContacts

Response

Returns a ContactList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
subnetId - Int
supportGroupId - Int

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": "abc123",
  "limit": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "subnetId": 987,
  "supportGroupId": 123
}
Response
{
  "data": {
    "supportGroupContacts": {
      "count": 123,
      "total": 123,
      "results": [Contact]
    }
  }
}

supportGroupIpAddresses

Response

Returns an IPAddressList

Arguments
Name Description
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

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
      }
      cloudAttributes
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "subnet_id": 123,
  "available": true,
  "contiguous": false,
  "subnetName": "xyz789",
  "subnet": "xyz789",
  "supportGroupId": 123
}
Response
{
  "data": {
    "supportGroupIpAddresses": {
      "count": 987,
      "total": 987,
      "results": [IPAddress]
    }
  }
}

supportGroupSubnets

Response

Returns a SubnetList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
supportGroupId - Int

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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "supportGroupId": 123
}
Response
{
  "data": {
    "supportGroupSubnets": {
      "count": 987,
      "total": 987,
      "results": [Subnet]
    }
  }
}

supportGroupSubnetsResources

Response

Returns a ResourceList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
supportGroupId - Int

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": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "supportGroupId": 987
}
Response
{
  "data": {
    "supportGroupSubnetsResources": {
      "count": 987,
      "total": 123,
      "results": [Resource]
    }
  }
}

supportGroups

Response

Returns a SupportGroupList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
subnetId - Int
filter - SupportGroupFilter

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": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "subnetId": 987,
  "filter": SupportGroupFilter
}
Response
{
  "data": {
    "supportGroups": {
      "count": 123,
      "total": 987,
      "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": 987,
      "UserId": 123,
      "message": "abc123"
    }
  }
}

supportTickets

Response

Returns a SupportTicketList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
filter - SupportTicketFilter

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": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "filter": SupportTicketFilter
}
Response
{
  "data": {
    "supportTickets": {
      "count": 987,
      "total": 987,
      "results": [SupportTicket]
    }
  }
}

userCommunicationVersions

Response

Returns a UserCommunicationVersionList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
filter - UserCommunicationVersionFilter

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": 123,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "filter": UserCommunicationVersionFilter
}
Response
{
  "data": {
    "userCommunicationVersions": {
      "count": 987,
      "total": 123,
      "results": [UserCommunicationVersion]
    }
  }
}

userCommunications

Response

Returns a UserCommunicationList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
filter - UserCommunicationFilter

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": "xyz789",
  "limit": 123,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "filter": UserCommunicationFilter
}
Response
{
  "data": {
    "userCommunications": {
      "count": 123,
      "total": 123,
      "results": [UserCommunication]
    }
  }
}

userGroup

Response

Returns a UserGroup

Arguments
Name Description
id - Int!

Example

Query
query UserGroup($id: Int!) {
  userGroup(id: $id) {
    id
    name
    description
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "userGroup": {
      "id": 123,
      "name": "abc123",
      "description": "abc123"
    }
  }
}

userGroups

Response

Returns a UserGroupList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
subnetId - Int
filter - UserGroupFilter

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": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "subnetId": 987,
  "filter": UserGroupFilter
}
Response
{
  "data": {
    "userGroups": {
      "count": 123,
      "total": 123,
      "results": [UserGroup]
    }
  }
}

userOrganizations

Response

Returns a UserOrganizationList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
filter - UserOrganizationFilter

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": "abc123",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "filter": UserOrganizationFilter
}
Response
{
  "data": {
    "userOrganizations": {
      "count": 987,
      "results": [UserOrganization]
    }
  }
}

vlan

Response

Returns a VLAN

Arguments
Name Description
id - Int!

Example

Query
query Vlan($id: Int!) {
  vlan(id: $id) {
    id
    number
  }
}
Variables
{"id": 123}
Response
{"data": {"vlan": {"id": 123, "number": 987}}}

vlans

Response

Returns an VLANList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
filter - VLANFilter

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": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "filter": VLANFilter
}
Response
{"data": {"vlans": {"count": 123, "results": [VLAN]}}}

zone

Response

Returns a Zone

Arguments
Name Description
id - Int!

Example

Query
query Zone($id: Int!) {
  zone(id: $id) {
    id
    name
    description
    VRF
    providerId
    provider {
      id
      name
      active
      type
      azureAppId
      azurePassword
      azureTenantId
      awsAccountId
      awsRoleName
      awsAccessKeyId
      awsSecretAccessKey
      awsSessionToken
      lastSynchronizedAt
      syncStatus
      syncError
      subnetCount
      ipCount
      resourceCount
      createdAt
      customAttributes
    }
    parentZone {
      id
      name
      description
      VRF
      providerId
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
      cloudAttributes
    }
    cloudResourceId
    importBatchId
    customAttributes
    cloudAttributes
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "zone": {
      "id": 987,
      "name": "xyz789",
      "description": "abc123",
      "VRF": "abc123",
      "providerId": 123,
      "provider": Provider,
      "parentZone": [Zone],
      "cloudResourceId": "xyz789",
      "importBatchId": 123,
      "customAttributes": {},
      "cloudAttributes": {}
    }
  }
}

zoneIpAddresses

Response

Returns an IPAddressList

Arguments
Name Description
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

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
      }
      cloudAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "subnet_id": 987,
  "available": false,
  "contiguous": true,
  "subnetName": "abc123",
  "subnet": "abc123",
  "zoneId": 123
}
Response
{
  "data": {
    "zoneIpAddresses": {
      "count": 123,
      "total": 123,
      "results": [IPAddress]
    }
  }
}

zoneSubnets

Response

Returns a SubnetList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
zoneId - Int

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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "zoneId": 123
}
Response
{
  "data": {
    "zoneSubnets": {
      "count": 123,
      "total": 987,
      "results": [Subnet]
    }
  }
}

zoneSubnetsResources

Response

Returns a ResourceList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
zoneId - Int

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": "xyz789",
  "limit": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "zoneId": 123
}
Response
{
  "data": {
    "zoneSubnetsResources": {
      "count": 987,
      "total": 987,
      "results": [Resource]
    }
  }
}

zones

Response

Returns a ZoneList

Arguments
Name Description
search - String
limit - Int
offset - Int
sort_by - String
sort_dir - String
providerId - Int
importId - Int
filter - ZoneFilter

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
      cloudAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "providerId": 987,
  "importId": 987,
  "filter": ZoneFilter
}
Response
{
  "data": {
    "zones": {
      "count": 123,
      "total": 987,
      "results": [Zone]
    }
  }
}

Mutations

addContactsToSubnet

Response

Returns [Contact]

Arguments
Name Description
subnetId - Int!
contactIds - [Int!]
contactName - String
networkAddress - String
zoneId - Int

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": 123,
  "contactIds": [987],
  "contactName": "abc123",
  "networkAddress": "abc123",
  "zoneId": 987
}
Response
{
  "data": {
    "addContactsToSubnet": [
      {
        "id": 987,
        "firstName": "abc123",
        "lastName": "xyz789",
        "phone": "xyz789",
        "cellPhone": "xyz789",
        "email": "abc123",
        "email2": "xyz789",
        "importBatchId": 987,
        "SupportGroupId": 987,
        "supportGroup": SupportGroup,
        "customAttributes": {}
      }
    ]
  }
}

addContactsToSupportGroup

Response

Returns [Contact]

Arguments
Name Description
id - Int!
contactIds - [Int]!

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": 987,
        "firstName": "xyz789",
        "lastName": "abc123",
        "phone": "xyz789",
        "cellPhone": "xyz789",
        "email": "abc123",
        "email2": "xyz789",
        "importBatchId": 987,
        "SupportGroupId": 987,
        "supportGroup": SupportGroup,
        "customAttributes": {}
      }
    ]
  }
}

addCustomersToSubnet

Response

Returns [Customer]

Arguments
Name Description
id - Int!
customerIds - [Int]!
customerName - String
networkAddress - String
zoneId - Int

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": [123],
  "customerName": "abc123",
  "networkAddress": "xyz789",
  "zoneId": 123
}
Response
{
  "data": {
    "addCustomersToSubnet": [
      {
        "id": 987,
        "name": "abc123",
        "importId": 123,
        "importBatchId": 987,
        "addresses": [Address],
        "sites": [Site],
        "customAttributes": {}
      }
    ]
  }
}

addSupportGroupsToSubnet

Response

Returns [SupportGroup]

Arguments
Name Description
subnetId - Int!
supportGroupIds - [Int]!
supportGroupName - String
networkAddress - String
zoneId - Int

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": 987,
  "supportGroupIds": [987],
  "supportGroupName": "abc123",
  "networkAddress": "xyz789",
  "zoneId": 987
}
Response
{
  "data": {
    "addSupportGroupsToSubnet": [
      {
        "id": 123,
        "name": "abc123",
        "description": "xyz789",
        "contacts": [Contact],
        "customAttributes": {}
      }
    ]
  }
}

adminUserUpdate

Response

Returns an AdminUser

Arguments
Name Description
id - Int!
role - String
firstName - String
lastName - String
email - String
orgRole - String
hideWelcome - Boolean
currentPassword - String
password - String
internal - Boolean
config - JSON
UserOrganizations - [UserOrganizationInput]

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": 123,
  "role": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "email": "abc123",
  "orgRole": "xyz789",
  "hideWelcome": true,
  "currentPassword": "xyz789",
  "password": "abc123",
  "internal": true,
  "config": {},
  "UserOrganizations": [UserOrganizationInput]
}
Response
{
  "data": {
    "adminUserUpdate": {
      "id": 987,
      "firstName": "xyz789",
      "lastName": "xyz789",
      "email": "abc123",
      "role": "xyz789",
      "password": "xyz789",
      "lastLogin": "abc123",
      "loginCount": 123,
      "hideWelcome": false,
      "superUser": false,
      "apiKey": "xyz789",
      "localUser": false,
      "passwordLoginEnabled": false,
      "microsoftLoginEnabled": true,
      "googleLoginEnabled": false,
      "config": {},
      "UserOrganizations": [UserOrganization],
      "currentOrganizationId": 123,
      "internal": true,
      "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": 987, "addresses": [AddressInput]}
Response
{
  "data": {
    "createAddress": {
      "id": 123,
      "line1": "xyz789",
      "line2": "xyz789",
      "line3": "xyz789",
      "line4": "xyz789",
      "municipality": "abc123",
      "province": "xyz789",
      "country": "abc123",
      "postalCode": "xyz789"
    }
  }
}

createAlert

Response

Returns an Alert

Arguments
Name Description
SubnetId - Int
UserId - Int
AlertRuleId - Int
status - String
type - String
name - String
description - String

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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      inUse
    }
    description
    message
    clearNotification
  }
}
Variables
{
  "SubnetId": 987,
  "UserId": 987,
  "AlertRuleId": 123,
  "status": "xyz789",
  "type": "abc123",
  "name": "abc123",
  "description": "xyz789"
}
Response
{
  "data": {
    "createAlert": {
      "id": 987,
      "SubnetId": 123,
      "UserId": 123,
      "AlertRuleId": 987,
      "status": "abc123",
      "type": "xyz789",
      "name": "abc123",
      "Subnet": Subnet,
      "description": "xyz789",
      "message": "xyz789",
      "clearNotification": true
    }
  }
}

createAlertDestination

Response

Returns an AlertDestination

Arguments
Name Description
name - String
type - String
URL - String
status - String
email - String
verificationCode - String
slackChannel - String
options - JSON

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": "xyz789",
  "type": "abc123",
  "URL": "abc123",
  "status": "abc123",
  "email": "xyz789",
  "verificationCode": "abc123",
  "slackChannel": "xyz789",
  "options": {}
}
Response
{
  "data": {
    "createAlertDestination": {
      "name": "xyz789",
      "id": 123,
      "type": "xyz789",
      "URL": "xyz789",
      "slackChannel": "xyz789",
      "email": "abc123",
      "status": "xyz789",
      "verificationCode": "xyz789",
      "options": {},
      "createdAt": "xyz789"
    }
  }
}

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": 987,
      "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
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      provider {
        ...ProviderFragment
      }
      region {
        ...RegionFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      nat {
        ...NATFragment
      }
      customAttributes
      cloudAttributes
      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": 123,
      "SubnetId": 987,
      "ZoneId": 123,
      "networkAddress": "abc123",
      "status": "xyz789",
      "type": "xyz789",
      "name": "xyz789",
      "description": "xyz789",
      "conditions": {},
      "subnet": Subnet,
      "AlertDestinations": [AlertDestination],
      "AlertRecipientId": 123,
      "AlertRecipients": [AlertRecipient],
      "recipients": [AlertRecipient]
    }
  }
}

createContact

Response

Returns a Contact

Arguments
Name Description
firstName - String
lastName - String
phone - String
cellPhone - String
email - String
email2 - String
SupportGroupId - Int
customAttributes - JSON

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": "xyz789",
  "lastName": "xyz789",
  "phone": "xyz789",
  "cellPhone": "xyz789",
  "email": "abc123",
  "email2": "xyz789",
  "SupportGroupId": 987,
  "customAttributes": {}
}
Response
{
  "data": {
    "createContact": {
      "id": 123,
      "firstName": "abc123",
      "lastName": "xyz789",
      "phone": "abc123",
      "cellPhone": "abc123",
      "email": "abc123",
      "email2": "abc123",
      "importBatchId": 987,
      "SupportGroupId": 123,
      "supportGroup": SupportGroup,
      "customAttributes": {}
    }
  }
}

createCustomAttribute

Response

Returns a CustomAttribute

Arguments
Name Description
modelName - String
name - String
type - String
required - Boolean
sectionId - Int
rowIndex - Int
rowColSpan - Int
colIndex - Int
colSpan - Int
component - String

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": "xyz789",
  "name": "abc123",
  "type": "abc123",
  "required": true,
  "sectionId": 987,
  "rowIndex": 987,
  "rowColSpan": 123,
  "colIndex": 987,
  "colSpan": 987,
  "component": "abc123"
}
Response
{
  "data": {
    "createCustomAttribute": {
      "id": 123,
      "modelName": "abc123",
      "name": "xyz789",
      "type": "abc123",
      "required": true,
      "sectionId": 123,
      "rowIndex": 123,
      "rowColSpan": 123,
      "colIndex": 987,
      "colSpan": 123,
      "component": "xyz789"
    }
  }
}

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": "xyz789",
  "customAttributes": {},
  "addresses": [AddressInput]
}
Response
{
  "data": {
    "createCustomer": {
      "id": 123,
      "name": "xyz789",
      "importId": 987,
      "importBatchId": 987,
      "addresses": [Address],
      "sites": [Site],
      "customAttributes": {}
    }
  }
}

createDNSEntry

Response

Returns an DNSEntry

Arguments
Name Description
name - String!
ttl - Int
recordClass - String
recordType - String
recordData - String
customAttributes - JSON
networkAddress - String
priority - Int
status - String

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: