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

activeUsersByMonth

Response

Returns [ActiveUsersByMonth]

Arguments
Name Description
type - String
userId - Int

Example

Query
query ActiveUsersByMonth(
  $type: String,
  $userId: Int
) {
  activeUsersByMonth(
    type: $type,
    userId: $userId
  ) {
    value
    label
  }
}
Variables
{"type": "abc123", "userId": 123}
Response
{
  "data": {
    "activeUsersByMonth": [
      {"value": 987, "label": "xyz789"}
    ]
  }
}

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": 987,
      "line1": "abc123",
      "line2": "xyz789",
      "line3": "abc123",
      "line4": "abc123",
      "municipality": "xyz789",
      "province": "abc123",
      "country": "xyz789",
      "postalCode": "abc123"
    }
  }
}

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

adminUserGet

Response

Returns an AdminUser

Arguments
Name Description
id - Int!

Example

Query
query AdminUserGet($id: Int!) {
  adminUserGet(id: $id) {
    id
    firstName
    lastName
    email
    role
    password
    lastLogin
    loginCount
    hideWelcome
    superUser
    apiKey
    localUser
    config
    UserOrganizations {
      id
      role
      email
      firstName
      lastName
      admin
    }
    currentOrganizationId
    createdAt
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "adminUserGet": {
      "id": 123,
      "firstName": "abc123",
      "lastName": "xyz789",
      "email": "abc123",
      "role": "abc123",
      "password": "abc123",
      "lastLogin": "abc123",
      "loginCount": 987,
      "hideWelcome": false,
      "superUser": true,
      "apiKey": "xyz789",
      "localUser": false,
      "config": {},
      "UserOrganizations": [UserOrganization],
      "currentOrganizationId": 987,
      "createdAt": "xyz789"
    }
  }
}

allUsers

Response

Returns an AllUserList

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

Example

Query
query AllUsers(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String
) {
  allUsers(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir
  ) {
    count
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789"
}
Response
{"data": {"allUsers": {"count": 987}}}

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": 987}
Response
{
  "data": {
    "apiKey": {
      "id": 123,
      "apiKey": "abc123",
      "apiKeyExpiry": "abc123",
      "apiKeyName": "abc123"
    }
  }
}

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": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "xyz789"
}
Response
{
  "data": {
    "apiKeys": {
      "count": 987,
      "total": 987,
      "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
      networkAddress
      description
      ipAddressType
      interface {
        ...InterfaceFragment
      }
      lastSeenAt
      subnet {
        ...SubnetFragment
      }
      DNSEntries {
        ...DNSEntryFragment
      }
      resource {
        ...ResourceFragment
      }
      interfaces {
        ...InterfaceFragment
      }
      cloudResourceId
      createdAt
      importBatchId
      customAttributes
      request {
        ...NetworkRequestItemFragment
      }
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "subnet_id": 123
}
Response
{
  "data": {
    "availableIPAssignments": {
      "count": 987,
      "total": 987,
      "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": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123"
}
Response
{
  "data": {
    "availableSubnets": {
      "count": 987,
      "results": [NetworkAddress]
    }
  }
}

averageActiveUsersByDay

Arguments
Name Description
type - String
userId - Int

Example

Query
query AverageActiveUsersByDay(
  $type: String,
  $userId: Int
) {
  averageActiveUsersByDay(
    type: $type,
    userId: $userId
  ) {
    value
    label
  }
}
Variables
{"type": "xyz789", "userId": 987}
Response
{
  "data": {
    "averageActiveUsersByDay": [
      {"value": 987.65, "label": "xyz789"}
    ]
  }
}

changes

Response

Returns a ChangeList

Arguments
Name Description
changeableType - String
changeableId - Int
zoneId - Int
networkAddress - String
limit - Int
offset - Int
sort_by - String
sort_dir - String

Example

Query
query Changes(
  $changeableType: String,
  $changeableId: Int,
  $zoneId: Int,
  $networkAddress: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String
) {
  changes(
    changeableType: $changeableType,
    changeableId: $changeableId,
    zoneId: $zoneId,
    networkAddress: $networkAddress,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir
  ) {
    count
    results {
      changeableType
      changeableId
      document
      createdAt
      networkAddress
      zoneId
    }
  }
}
Variables
{
  "changeableType": "abc123",
  "changeableId": 987,
  "zoneId": 123,
  "networkAddress": "abc123",
  "limit": 987,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123"
}
Response
{"data": {"changes": {"count": 123, "results": [Change]}}}

clientConfig

Response

Returns a ClientConfig

Example

Query
query ClientConfig {
  clientConfig {
    MicrosoftLoginEnabled
    GoogleLoginEnabled
    clientUrl
    WebsiteName
    reactApiUrl
    LdapEnabled
    MouseflowEnabled
  }
}
Response
{
  "data": {
    "clientConfig": {
      "MicrosoftLoginEnabled": "xyz789",
      "GoogleLoginEnabled": "xyz789",
      "clientUrl": "abc123",
      "WebsiteName": "xyz789",
      "reactApiUrl": "xyz789",
      "LdapEnabled": "abc123",
      "MouseflowEnabled": "xyz789"
    }
  }
}

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

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

Example

Query
query Contacts(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $contactableId: Int,
  $contactableType: String,
  $importId: Int
) {
  contacts(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    contactableId: $contactableId,
    contactableType: $contactableType,
    importId: $importId
  ) {
    count
    total
    results {
      id
      firstName
      lastName
      phone
      cellPhone
      email
      email2
      importBatchId
      customAttributes
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "contactableId": 123,
  "contactableType": "xyz789",
  "importId": 987
}
Response
{
  "data": {
    "contacts": {
      "count": 123,
      "total": 987,
      "results": [Contact]
    }
  }
}

customAttribute

Response

Returns a CustomAttribute

Arguments
Name Description
id - Int!

Example

Query
query CustomAttribute($id: Int!) {
  customAttribute(id: $id) {
    id
    modelName
    name
    type
    required
    sectionId
    rowIndex
    rowColSpan
    colIndex
    colSpan
    component
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "customAttribute": {
      "id": 987,
      "modelName": "xyz789",
      "name": "abc123",
      "type": "xyz789",
      "required": false,
      "sectionId": 123,
      "rowIndex": 123,
      "rowColSpan": 987,
      "colIndex": 987,
      "colSpan": 987,
      "component": "abc123"
    }
  }
}

customAttributes

Response

Returns a CustomAttributeList

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

Example

Query
query CustomAttributes(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $modelName: String
) {
  customAttributes(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    modelName: $modelName
  ) {
    count
    results {
      id
      modelName
      name
      type
      required
      sectionId
      rowIndex
      rowColSpan
      colIndex
      colSpan
      component
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "modelName": "abc123"
}
Response
{
  "data": {
    "customAttributes": {
      "count": 123,
      "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
      addresses {
        ...AddressFragment
      }
    }
    customAttributes
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "customer": {
      "id": 987,
      "name": "xyz789",
      "importId": 987,
      "importBatchId": 123,
      "addresses": [Address],
      "sites": [Site],
      "customAttributes": {}
    }
  }
}

customers

Response

Returns a CustomerList

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

Example

Query
query Customers(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $subnetId: Int,
  $importId: Int
) {
  customers(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    subnetId: $subnetId,
    importId: $importId
  ) {
    count
    total
    results {
      id
      name
      importId
      importBatchId
      addresses {
        ...AddressFragment
      }
      sites {
        ...SiteFragment
      }
      customAttributes
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "subnetId": 123,
  "importId": 987
}
Response
{
  "data": {
    "customers": {
      "count": 123,
      "total": 123,
      "results": [Customer]
    }
  }
}

dnsEntries

Response

Returns an DNSEntryList

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

Example

Query
query DnsEntries(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String
) {
  dnsEntries(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir
  ) {
    count
    total
    results {
      id
      name
      ttl
      recordClass
      recordType
      recordData
      dnsZone {
        ...DNSZoneFragment
      }
      customAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123"
}
Response
{
  "data": {
    "dnsEntries": {
      "count": 123,
      "total": 987,
      "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
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "dnsEntry": {
      "id": 987,
      "name": "xyz789",
      "ttl": 987,
      "recordClass": "abc123",
      "recordType": "xyz789",
      "recordData": "abc123",
      "dnsZone": [DNSZone],
      "customAttributes": {}
    }
  }
}

dnsServer

Response

Returns an DNSServer

Arguments
Name Description
id - Int!

Example

Query
query DnsServer($id: Int!) {
  dnsServer(id: $id) {
    name
  }
}
Variables
{"id": 987}
Response
{"data": {"dnsServer": {"name": "abc123"}}}

dnsServers

Response

Returns an DNSServerList

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

Example

Query
query DnsServers(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String
) {
  dnsServers(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir
  ) {
    count
    results {
      name
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789"
}
Response
{
  "data": {
    "dnsServers": {"count": 987, "results": [DNSServer]}
  }
}

dnsZone

Response

Returns an DNSZone

Arguments
Name Description
id - Int!

Example

Query
query DnsZone($id: Int!) {
  dnsZone(id: $id) {
    name
    dnsServer {
      name
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "dnsZone": {
      "name": "xyz789",
      "dnsServer": [DNSServer]
    }
  }
}

dnsZones

Response

Returns an DNSZoneList

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

Example

Query
query DnsZones(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String
) {
  dnsZones(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir
  ) {
    count
    results {
      name
      dnsServer {
        ...DNSServerFragment
      }
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789"
}
Response
{
  "data": {
    "dnsZones": {"count": 987, "results": [DNSZone]}
  }
}

gateway

Response

Returns a Gateway

Arguments
Name Description
gateway - String!
subnetId - Int!

Example

Query
query Gateway(
  $gateway: String!,
  $subnetId: Int!
) {
  gateway(
    gateway: $gateway,
    subnetId: $subnetId
  ) {
    id
    gateway
  }
}
Variables
{"gateway": "abc123", "subnetId": 123}
Response
{
  "data": {
    "gateway": {
      "id": 987,
      "gateway": "xyz789"
    }
  }
}

gateways

Response

Returns a GatewayList

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

Example

Query
query Gateways(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $subnet_id: Int,
  $available: Boolean,
  $contiguous: Boolean
) {
  gateways(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    subnet_id: $subnet_id,
    available: $available,
    contiguous: $contiguous
  ) {
    count
    total
    results {
      id
      gateway
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "subnet_id": 987,
  "available": false,
  "contiguous": true
}
Response
{
  "data": {
    "gateways": {
      "count": 123,
      "total": 123,
      "results": [Gateway]
    }
  }
}

getMeasurement

Response

Returns a DataPoint

Arguments
Name Description
recordId - Int
metric - String
metricId - Int
date - Date

Example

Query
query GetMeasurement(
  $recordId: Int,
  $metric: String,
  $metricId: Int,
  $date: Date
) {
  getMeasurement(
    recordId: $recordId,
    metric: $metric,
    metricId: $metricId,
    date: $date
  ) {
    label
    value
    unit
  }
}
Variables
{
  "recordId": 123,
  "metric": "abc123",
  "metricId": 123,
  "date": "2007-12-03"
}
Response
{
  "data": {
    "getMeasurement": {
      "label": "abc123",
      "value": 987.65,
      "unit": "xyz789"
    }
  }
}

getTabulation

Response

Returns [DataPoint]

Arguments
Name Description
recordId - Int
metricId - Int
startDate - Date
endDate - Date
groupBy - String
orderBy - String

Example

Query
query GetTabulation(
  $recordId: Int,
  $metricId: Int,
  $startDate: Date,
  $endDate: Date,
  $groupBy: String,
  $orderBy: String
) {
  getTabulation(
    recordId: $recordId,
    metricId: $metricId,
    startDate: $startDate,
    endDate: $endDate,
    groupBy: $groupBy,
    orderBy: $orderBy
  ) {
    label
    value
    unit
  }
}
Variables
{
  "recordId": 123,
  "metricId": 987,
  "startDate": "2007-12-03",
  "endDate": "2007-12-03",
  "groupBy": "abc123",
  "orderBy": "xyz789"
}
Response
{
  "data": {
    "getTabulation": [
      {
        "label": "abc123",
        "value": 123.45,
        "unit": "abc123"
      }
    ]
  }
}

getTimeSeries

Response

Returns [DataPoint]

Arguments
Name Description
recordId - Int
metricId - Int
startDate - Date
endDate - Date
groupBy - String
orderBy - String

Example

Query
query GetTimeSeries(
  $recordId: Int,
  $metricId: Int,
  $startDate: Date,
  $endDate: Date,
  $groupBy: String,
  $orderBy: String
) {
  getTimeSeries(
    recordId: $recordId,
    metricId: $metricId,
    startDate: $startDate,
    endDate: $endDate,
    groupBy: $groupBy,
    orderBy: $orderBy
  ) {
    label
    value
    unit
  }
}
Variables
{
  "recordId": 123,
  "metricId": 987,
  "startDate": "2007-12-03",
  "endDate": "2007-12-03",
  "groupBy": "abc123",
  "orderBy": "xyz789"
}
Response
{
  "data": {
    "getTimeSeries": [
      {
        "label": "abc123",
        "value": 123.45,
        "unit": "abc123"
      }
    ]
  }
}

getUsage

Response

Returns [UsageResult]

Arguments
Name Description
reportType - String

Example

Query
query GetUsage($reportType: String) {
  getUsage(reportType: $reportType) {
    id
    name
    allocated
    inUse
    percentInUse
  }
}
Variables
{"reportType": "abc123"}
Response
{
  "data": {
    "getUsage": [
      {
        "id": 123,
        "name": "abc123",
        "allocated": 123.45,
        "inUse": 123.45,
        "percentInUse": "xyz789"
      }
    ]
  }
}

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": "abc123",
  "limit": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "xyz789"
}
Response
{
  "data": {
    "identities": {
      "count": 987,
      "total": 123,
      "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": 987}
Response
{
  "data": {
    "import": {
      "id": 987,
      "description": "abc123",
      "customer_count": 123,
      "contact_count": 123,
      "site_count": 123,
      "zone_count": 123,
      "subnet_count": 987,
      "ip_assignment_count": 987,
      "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": "xyz789",
      "customer_count": 123,
      "contact_count": 987,
      "site_count": 123,
      "zone_count": 123,
      "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

Example

Query
query Imports(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $type: String
) {
  imports(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    type: $type
  ) {
    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": "xyz789",
  "sort_dir": "abc123",
  "type": "xyz789"
}
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
      }
      interfaces {
        ...InterfaceFragment
      }
    }
    ipAssignment {
      id
      networkAddress
      description
      ipAddressType
      interface {
        ...InterfaceFragment
      }
      lastSeenAt
      subnet {
        ...SubnetFragment
      }
      DNSEntries {
        ...DNSEntryFragment
      }
      resource {
        ...ResourceFragment
      }
      interfaces {
        ...InterfaceFragment
      }
      cloudResourceId
      createdAt
      importBatchId
      customAttributes
      request {
        ...NetworkRequestItemFragment
      }
    }
    cloudResourceId
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "interface": {
      "id": 123,
      "name": "abc123",
      "macAddress": "abc123",
      "resource": Resource,
      "ipAssignment": IPAssignment,
      "cloudResourceId": "abc123"
    }
  }
}

interfaces

Response

Returns an InterfaceList

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

Example

Query
query Interfaces(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String
) {
  interfaces(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir
  ) {
    count
    results {
      id
      name
      macAddress
      resource {
        ...ResourceFragment
      }
      ipAssignment {
        ...IPAssignmentFragment
      }
      cloudResourceId
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "xyz789"
}
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
      networkAddress
      description
      ipAddressType
      interface {
        ...InterfaceFragment
      }
      lastSeenAt
      subnet {
        ...SubnetFragment
      }
      DNSEntries {
        ...DNSEntryFragment
      }
      resource {
        ...ResourceFragment
      }
      interfaces {
        ...InterfaceFragment
      }
      cloudResourceId
      createdAt
      importBatchId
      customAttributes
      request {
        ...NetworkRequestItemFragment
      }
    }
    reservation {
      id
      name
      description
      color
      ipAddresses {
        ...IPAddressFragment
      }
    }
    request {
      id
      status
      zoneId
      ipAddress
      macAddress
      interface
      hostname
      customAttributes
      description
      networkRequestId
      networkRequest {
        ...NetworkRequestFragment
      }
    }
    inUse
    subnet {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    zone {
      id
      name
      description
      VRF
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
    }
  }
}
Variables
{
  "networkAddress": "abc123",
  "subnetId": 123
}
Response
{
  "data": {
    "ipAddress": {
      "id": 123,
      "networkAddress": "xyz789",
      "ipAddressType": "xyz789",
      "ipAssignment": IPAssignment,
      "reservation": Reservation,
      "request": NetworkRequestItem,
      "inUse": true,
      "subnet": Subnet,
      "zone": Zone
    }
  }
}

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

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
) {
  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
  ) {
    count
    total
    results {
      id
      networkAddress
      ipAddressType
      ipAssignment {
        ...IPAssignmentFragment
      }
      reservation {
        ...ReservationFragment
      }
      request {
        ...NetworkRequestItemFragment
      }
      inUse
      subnet {
        ...SubnetFragment
      }
      zone {
        ...ZoneFragment
      }
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "subnet_id": 987,
  "available": false,
  "contiguous": true,
  "subnetName": "abc123"
}
Response
{
  "data": {
    "ipAddresses": {
      "count": 123,
      "total": 987,
      "results": [IPAddress]
    }
  }
}

ipAssignment

Response

Returns an IPAssignment

Arguments
Name Description
id - Int!

Example

Query
query IpAssignment($id: Int!) {
  ipAssignment(id: $id) {
    id
    networkAddress
    description
    ipAddressType
    interface {
      id
      name
      macAddress
      resource {
        ...ResourceFragment
      }
      ipAssignment {
        ...IPAssignmentFragment
      }
      cloudResourceId
    }
    lastSeenAt
    subnet {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    DNSEntries {
      id
      name
      ttl
      recordClass
      recordType
      recordData
      dnsZone {
        ...DNSZoneFragment
      }
      customAttributes
    }
    resource {
      id
      hostname
      OS
      OSVersion
      macAddress
      cloudResourceId
      resourceGroupId
      resourceTypeId
      provider {
        ...ProviderFragment
      }
      interfaces {
        ...InterfaceFragment
      }
    }
    interfaces {
      id
      name
      macAddress
      resource {
        ...ResourceFragment
      }
      ipAssignment {
        ...IPAssignmentFragment
      }
      cloudResourceId
    }
    cloudResourceId
    createdAt
    importBatchId
    customAttributes
    request {
      id
      status
      zoneId
      ipAddress
      macAddress
      interface
      hostname
      customAttributes
      description
      networkRequestId
      networkRequest {
        ...NetworkRequestFragment
      }
    }
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "ipAssignment": {
      "id": 123,
      "networkAddress": "xyz789",
      "description": "xyz789",
      "ipAddressType": "abc123",
      "interface": Interface,
      "lastSeenAt": "abc123",
      "subnet": Subnet,
      "DNSEntries": [DNSEntry],
      "resource": Resource,
      "interfaces": [Interface],
      "cloudResourceId": "abc123",
      "createdAt": "xyz789",
      "importBatchId": 123,
      "customAttributes": {},
      "request": NetworkRequestItem
    }
  }
}

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

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
) {
  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
  ) {
    count
    total
    results {
      id
      networkAddress
      description
      ipAddressType
      interface {
        ...InterfaceFragment
      }
      lastSeenAt
      subnet {
        ...SubnetFragment
      }
      DNSEntries {
        ...DNSEntryFragment
      }
      resource {
        ...ResourceFragment
      }
      interfaces {
        ...InterfaceFragment
      }
      cloudResourceId
      createdAt
      importBatchId
      customAttributes
      request {
        ...NetworkRequestItemFragment
      }
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "subnet_id": 123,
  "importId": 987,
  "subnet": "xyz789",
  "zoneName": "abc123"
}
Response
{
  "data": {
    "ipAssignments": {
      "count": 123,
      "total": 987,
      "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": "abc123"
    }
  }
}

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

nats

Response

Returns a NATList

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

Example

Query
query Nats(
  $destinationNatZoneId: Int,
  $sourceNatZoneId: Int,
  $subnetId: Int,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String
) {
  nats(
    destinationNatZoneId: $destinationNatZoneId,
    sourceNatZoneId: $sourceNatZoneId,
    subnetId: $subnetId,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir
  ) {
    count
    results {
      id
      sourceNatAddress
      destinationNatAddress
      natType
      sourcePort
      sourceNatZoneId
      destinationPort
      destinationNatZoneId
      sourceType
      destinationType
      subnetId
    }
  }
}
Variables
{
  "destinationNatZoneId": 987,
  "sourceNatZoneId": 123,
  "subnetId": 123,
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123"
}
Response
{"data": {"nats": {"count": 123, "results": [NAT]}}}

networkRequest

Response

Returns a NetworkRequest

Arguments
Name Description
id - Int!

Example

Query
query NetworkRequest($id: Int!) {
  networkRequest(id: $id) {
    id
    status
    ipAddressCount
    details
    networkAddress
    zoneId
    subnetId
    NetworkRequestItems {
      id
      status
      zoneId
      ipAddress
      macAddress
      interface
      hostname
      customAttributes
      description
      networkRequestId
      networkRequest {
        ...NetworkRequestFragment
      }
    }
    createdAt
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "networkRequest": {
      "id": 987,
      "status": "xyz789",
      "ipAddressCount": 123,
      "details": "xyz789",
      "networkAddress": "xyz789",
      "zoneId": "abc123",
      "subnetId": 123,
      "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

Example

Query
query NetworkRequests(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $type: String,
  $subnetId: Int,
  $status: String
) {
  networkRequests(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    type: $type,
    subnetId: $subnetId,
    status: $status
  ) {
    count
    results {
      id
      status
      ipAddressCount
      details
      networkAddress
      zoneId
      subnetId
      NetworkRequestItems {
        ...NetworkRequestItemFragment
      }
      createdAt
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "type": "xyz789",
  "subnetId": 987,
  "status": "abc123"
}
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": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789"
}
Response
{
  "data": {
    "networkSearch": {
      "count": 123,
      "total": 123,
      "results": [Subnet]
    }
  }
}

newUsersByDay

Response

Returns [NewUsersByDay]

Example

Query
query NewUsersByDay {
  newUsersByDay {
    count
    date
  }
}
Response
{
  "data": {
    "newUsersByDay": [
      {"count": 123, "date": "abc123"}
    ]
  }
}

plan

Response

Returns a Plan

Arguments
Name Description
id - Int!

Example

Query
query Plan($id: Int!) {
  plan(id: $id) {
    id
    name
    projectId
    description
    subnets {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    plannedChanges {
      id
      planId
      description
      sourceId
      sourceType
      sourceNetworkAddress
      destinationId
      destinationType
      destinationNetworkAddress
      status
      date
      sourceSubnet {
        ...SubnetFragment
      }
      destinationSubnet {
        ...SubnetFragment
      }
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "plan": {
      "id": 123,
      "name": "xyz789",
      "projectId": 987,
      "description": "abc123",
      "subnets": [Subnet],
      "plannedChanges": [PlannedChange]
    }
  }
}

plannedChange

Response

Returns a PlannedChange

Arguments
Name Description
id - Int!

Example

Query
query PlannedChange($id: Int!) {
  plannedChange(id: $id) {
    id
    planId
    description
    sourceId
    sourceType
    sourceNetworkAddress
    destinationId
    destinationType
    destinationNetworkAddress
    status
    date
    sourceSubnet {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    destinationSubnet {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "plannedChange": {
      "id": 987,
      "planId": 123,
      "description": "abc123",
      "sourceId": 987,
      "sourceType": "xyz789",
      "sourceNetworkAddress": "xyz789",
      "destinationId": 123,
      "destinationType": "xyz789",
      "destinationNetworkAddress": "abc123",
      "status": "abc123",
      "date": "xyz789",
      "sourceSubnet": Subnet,
      "destinationSubnet": Subnet
    }
  }
}

plannedChanges

Response

Returns a PlannedChangeList

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

Example

Query
query PlannedChanges(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $planId: Int
) {
  plannedChanges(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    planId: $planId
  ) {
    count
    results {
      id
      planId
      description
      sourceId
      sourceType
      sourceNetworkAddress
      destinationId
      destinationType
      destinationNetworkAddress
      status
      date
      sourceSubnet {
        ...SubnetFragment
      }
      destinationSubnet {
        ...SubnetFragment
      }
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "planId": 123
}
Response
{
  "data": {
    "plannedChanges": {
      "count": 987,
      "results": [PlannedChange]
    }
  }
}

plans

Response

Returns a PlanList

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

Example

Query
query Plans(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String
) {
  plans(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir
  ) {
    count
    results {
      id
      name
      projectId
      description
      subnets {
        ...SubnetFragment
      }
      plannedChanges {
        ...PlannedChangeFragment
      }
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 987,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123"
}
Response
{"data": {"plans": {"count": 987, "results": [Plan]}}}

project

Response

Returns a Project

Arguments
Name Description
id - Int!

Example

Query
query Project($id: Int!) {
  project(id: $id) {
    id
    name
    plans {
      id
      name
      projectId
      description
      subnets {
        ...SubnetFragment
      }
      plannedChanges {
        ...PlannedChangeFragment
      }
    }
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "project": {
      "id": 987,
      "name": "abc123",
      "plans": [Plan]
    }
  }
}

projects

Response

Returns a ProjectList

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

Example

Query
query Projects(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $type: String
) {
  projects(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    type: $type
  ) {
    count
    results {
      id
      name
      plans {
        ...PlanFragment
      }
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "type": "abc123"
}
Response
{
  "data": {
    "projects": {"count": 987, "results": [Project]}
  }
}

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
    awsAccessKeyId
    awsSecretAccessKey
    lastSynchronizedAt
    syncStatus
    syncError
    customAttributes
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "provider": {
      "id": 987,
      "name": "xyz789",
      "active": true,
      "type": "abc123",
      "azureAppId": "xyz789",
      "azurePassword": "xyz789",
      "azureTenantId": "abc123",
      "awsAccessKeyId": "xyz789",
      "awsSecretAccessKey": "xyz789",
      "lastSynchronizedAt": "abc123",
      "syncStatus": "abc123",
      "syncError": "abc123",
      "customAttributes": {}
    }
  }
}

providers

Response

Returns a ProviderList

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

Example

Query
query Providers(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $type: String
) {
  providers(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    type: $type
  ) {
    count
    total
    results {
      id
      name
      active
      type
      azureAppId
      azurePassword
      azureTenantId
      awsAccessKeyId
      awsSecretAccessKey
      lastSynchronizedAt
      syncStatus
      syncError
      customAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "type": "abc123"
}
Response
{
  "data": {
    "providers": {
      "count": 123,
      "total": 987,
      "results": [Provider]
    }
  }
}

reservation

Response

Returns a Reservation

Arguments
Name Description
id - Int!

Example

Query
query Reservation($id: Int!) {
  reservation(id: $id) {
    id
    name
    description
    color
    ipAddresses {
      id
      networkAddress
      ipAddressType
      ipAssignment {
        ...IPAssignmentFragment
      }
      reservation {
        ...ReservationFragment
      }
      request {
        ...NetworkRequestItemFragment
      }
      inUse
      subnet {
        ...SubnetFragment
      }
      zone {
        ...ZoneFragment
      }
    }
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "reservation": {
      "id": 987,
      "name": "xyz789",
      "description": "xyz789",
      "color": "xyz789",
      "ipAddresses": [IPAddress]
    }
  }
}

reservations

Response

Returns a ReservationList

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

Example

Query
query Reservations(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $subnet_id: Int
) {
  reservations(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    subnet_id: $subnet_id
  ) {
    count
    results {
      id
      name
      description
      color
      ipAddresses {
        ...IPAddressFragment
      }
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "subnet_id": 123
}
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
      awsAccessKeyId
      awsSecretAccessKey
      lastSynchronizedAt
      syncStatus
      syncError
      customAttributes
    }
    interfaces {
      id
      name
      macAddress
      resource {
        ...ResourceFragment
      }
      ipAssignment {
        ...IPAssignmentFragment
      }
      cloudResourceId
    }
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "resource": {
      "id": 123,
      "hostname": "abc123",
      "OS": "xyz789",
      "OSVersion": "abc123",
      "macAddress": "xyz789",
      "cloudResourceId": "abc123",
      "resourceGroupId": "xyz789",
      "resourceTypeId": 987,
      "provider": Provider,
      "interfaces": [Interface]
    }
  }
}

resourceType

Response

Returns a ResourceType

Arguments
Name Description
id - Int!

Example

Query
query ResourceType($id: Int!) {
  resourceType(id: $id) {
    id
    name
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "resourceType": {
      "id": 123,
      "name": "xyz789"
    }
  }
}

resourceTypes

Response

Returns a ResourceTypeList

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

Example

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

resources

Response

Returns a ResourceList

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

Example

Query
query Resources(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $subnetId: Int
) {
  resources(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    subnetId: $subnetId
  ) {
    count
    results {
      id
      hostname
      OS
      OSVersion
      macAddress
      cloudResourceId
      resourceGroupId
      resourceTypeId
      provider {
        ...ProviderFragment
      }
      interfaces {
        ...InterfaceFragment
      }
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "subnetId": 987
}
Response
{
  "data": {
    "resources": {"count": 123, "results": [Resource]}
  }
}

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": 123}
Response
{
  "data": {
    "role": {
      "id": 987,
      "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
    userGroup {
      id
      name
      description
    }
    role {
      id
      name
      description
      plans {
        ...PlanFragment
      }
    }
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "roleAssignment": {
      "id": 987,
      "subjectId": 987,
      "subjectType": "xyz789",
      "recordId": "abc123",
      "recordType": "abc123",
      "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

Example

Query
query RoleAssignments(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $recordType: String,
  $recordId: Int
) {
  roleAssignments(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    recordType: $recordType,
    recordId: $recordId
  ) {
    count
    total
    results {
      id
      subjectId
      subjectType
      recordId
      recordType
      userGroup {
        ...UserGroupFragment
      }
      role {
        ...RoleFragment
      }
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "abc123",
  "recordType": "abc123",
  "recordId": 987
}
Response
{
  "data": {
    "roleAssignments": {
      "count": 123,
      "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

Example

Query
query Roles(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $type: String
) {
  roles(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    type: $type
  ) {
    count
    results {
      id
      name
      description
      plans {
        ...PlanFragment
      }
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "type": "xyz789"
}
Response
{"data": {"roles": {"count": 123, "results": [Role]}}}

site

Response

Returns a Site

Arguments
Name Description
id - Int!

Example

Query
query Site($id: Int!) {
  site(id: $id) {
    id
    name
    importBatchId
    addresses {
      id
      line1
      line2
      line3
      line4
      municipality
      province
      country
      postalCode
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "site": {
      "id": 987,
      "name": "abc123",
      "importBatchId": 987,
      "addresses": [Address]
    }
  }
}

sites

Response

Returns a SiteList

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

Example

Query
query Sites(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $type: String,
  $importId: Int
) {
  sites(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    type: $type,
    importId: $importId
  ) {
    count
    total
    results {
      id
      name
      importBatchId
      addresses {
        ...AddressFragment
      }
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 123,
  "sort_by": "xyz789",
  "sort_dir": "xyz789",
  "type": "xyz789",
  "importId": 987
}
Response
{
  "data": {
    "sites": {
      "count": 987,
      "total": 987,
      "results": [Site]
    }
  }
}

subnet

Response

Returns a Subnet

Arguments
Name Description
id - Int!

Example

Query
query Subnet($id: Int!) {
  subnet(id: $id) {
    id
    status
    planId
    name
    description
    direction
    networkAddress
    host
    defaultGatewayId
    supernetId
    defaultGateway
    zone {
      id
      name
      description
      VRF
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
    }
    vlan {
      id
      number
    }
    pollable
    broadcast
    customers {
      id
      name
      importId
      importBatchId
      addresses {
        ...AddressFragment
      }
      sites {
        ...SiteFragment
      }
      customAttributes
    }
    Contacts {
      id
      firstName
      lastName
      phone
      cellPhone
      email
      email2
      importBatchId
      customAttributes
    }
    site {
      id
      name
      importBatchId
      addresses {
        ...AddressFragment
      }
    }
    gateway {
      id
      gateway
    }
    supportGroups {
      id
      name
      description
      contacts {
        ...ContactFragment
      }
      customAttributes
    }
    subnets {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    supernet {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    syncStatus
    lastSynchronizedAt
    syncError
    cloudResourceId
    importBatchId
    customAttributes
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "subnet": {
      "id": 987,
      "status": "xyz789",
      "planId": 123,
      "name": "xyz789",
      "description": "abc123",
      "direction": "xyz789",
      "networkAddress": "abc123",
      "host": "abc123",
      "defaultGatewayId": 123,
      "supernetId": 987,
      "defaultGateway": "xyz789",
      "zone": Zone,
      "vlan": VLAN,
      "pollable": true,
      "broadcast": "abc123",
      "customers": [Customer],
      "Contacts": [Contact],
      "site": Site,
      "gateway": Gateway,
      "supportGroups": [SupportGroup],
      "subnets": [Subnet],
      "supernet": Subnet,
      "syncStatus": "xyz789",
      "lastSynchronizedAt": "abc123",
      "syncError": "xyz789",
      "cloudResourceId": "xyz789",
      "importBatchId": 987,
      "customAttributes": {}
    }
  }
}

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

subnetTemplate

Response

Returns a SubnetTemplate

Arguments
Name Description
id - Int!

Example

Query
query SubnetTemplate($id: Int!) {
  subnetTemplate(id: $id) {
    id
    name
    description
    netmask
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "subnetTemplate": {
      "id": 123,
      "name": "abc123",
      "description": "abc123",
      "netmask": 123
    }
  }
}

subnetTemplates

Response

Returns a SubnetTemplateList

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

Example

Query
query SubnetTemplates(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String
) {
  subnetTemplates(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir
  ) {
    count
    results {
      id
      name
      description
      netmask
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789"
}
Response
{
  "data": {
    "subnetTemplates": {
      "count": 123,
      "results": [SubnetTemplate]
    }
  }
}

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

Example

Query
query Subnets(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $supernetId: Int,
  $importId: Int,
  $zoneName: String,
  $topLevelOnly: Boolean
) {
  subnets(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    supernetId: $supernetId,
    importId: $importId,
    zoneName: $zoneName,
    topLevelOnly: $topLevelOnly
  ) {
    count
    total
    results {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "supernetId": 987,
  "importId": 123,
  "zoneName": "xyz789",
  "topLevelOnly": true
}
Response
{
  "data": {
    "subnets": {
      "count": 123,
      "total": 987,
      "results": [Subnet]
    }
  }
}

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

supportGroups

Response

Returns a SupportGroupList

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

Example

Query
query SupportGroups(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $subnetId: Int
) {
  supportGroups(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    subnetId: $subnetId
  ) {
    count
    total
    results {
      id
      name
      description
      contacts {
        ...ContactFragment
      }
      customAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "abc123",
  "subnetId": 123
}
Response
{
  "data": {
    "supportGroups": {
      "count": 123,
      "total": 123,
      "results": [SupportGroup]
    }
  }
}

usageSummary

Response

Returns a SubnetUsageSummary

Arguments
Name Description
subnetId - Int!

Example

Query
query UsageSummary($subnetId: Int!) {
  usageSummary(subnetId: $subnetId) {
    available
    inUse
  }
}
Variables
{"subnetId": 123}
Response
{"data": {"usageSummary": {"available": 123, "inUse": 123}}}

userGroup

Response

Returns a UserGroup

Arguments
Name Description
id - Int!

Example

Query
query UserGroup($id: Int!) {
  userGroup(id: $id) {
    id
    name
    description
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "userGroup": {
      "id": 987,
      "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

Example

Query
query UserGroups(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $subnetId: Int
) {
  userGroups(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    subnetId: $subnetId
  ) {
    count
    total
    results {
      id
      name
      description
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "subnetId": 123
}
Response
{
  "data": {
    "userGroups": {
      "count": 123,
      "total": 123,
      "results": [UserGroup]
    }
  }
}

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

Example

Query
query Vlans(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String
) {
  vlans(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir
  ) {
    count
    results {
      id
      number
    }
  }
}
Variables
{
  "search": "abc123",
  "limit": 123,
  "offset": 987,
  "sort_by": "xyz789",
  "sort_dir": "abc123"
}
Response
{"data": {"vlans": {"count": 987, "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
    provider {
      id
      name
      active
      type
      azureAppId
      azurePassword
      azureTenantId
      awsAccessKeyId
      awsSecretAccessKey
      lastSynchronizedAt
      syncStatus
      syncError
      customAttributes
    }
    parentZone {
      id
      name
      description
      VRF
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
    }
    cloudResourceId
    importBatchId
    customAttributes
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "zone": {
      "id": 123,
      "name": "abc123",
      "description": "abc123",
      "VRF": "abc123",
      "provider": Provider,
      "parentZone": [Zone],
      "cloudResourceId": "xyz789",
      "importBatchId": 123,
      "customAttributes": {}
    }
  }
}

zones

Response

Returns a ZoneList

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

Example

Query
query Zones(
  $search: String,
  $limit: Int,
  $offset: Int,
  $sort_by: String,
  $sort_dir: String,
  $providerId: Int,
  $importId: Int
) {
  zones(
    search: $search,
    limit: $limit,
    offset: $offset,
    sort_by: $sort_by,
    sort_dir: $sort_dir,
    providerId: $providerId,
    importId: $importId
  ) {
    count
    total
    results {
      id
      name
      description
      VRF
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
    }
  }
}
Variables
{
  "search": "xyz789",
  "limit": 987,
  "offset": 123,
  "sort_by": "abc123",
  "sort_dir": "xyz789",
  "providerId": 987,
  "importId": 987
}
Response
{
  "data": {
    "zones": {
      "count": 987,
      "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
    customAttributes
  }
}
Variables
{
  "subnetId": 123,
  "contactIds": [987],
  "contactName": "abc123",
  "networkAddress": "xyz789",
  "zoneId": 987
}
Response
{
  "data": {
    "addContactsToSubnet": [
      {
        "id": 987,
        "firstName": "abc123",
        "lastName": "xyz789",
        "phone": "abc123",
        "cellPhone": "abc123",
        "email": "abc123",
        "email2": "xyz789",
        "importBatchId": 987,
        "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
    customAttributes
  }
}
Variables
{"id": 987, "contactIds": [987]}
Response
{
  "data": {
    "addContactsToSupportGroup": [
      {
        "id": 123,
        "firstName": "abc123",
        "lastName": "xyz789",
        "phone": "xyz789",
        "cellPhone": "xyz789",
        "email": "xyz789",
        "email2": "abc123",
        "importBatchId": 123,
        "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
      addresses {
        ...AddressFragment
      }
    }
    customAttributes
  }
}
Variables
{
  "id": 987,
  "customerIds": [987],
  "customerName": "xyz789",
  "networkAddress": "xyz789",
  "zoneId": 123
}
Response
{
  "data": {
    "addCustomersToSubnet": [
      {
        "id": 987,
        "name": "abc123",
        "importId": 987,
        "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
      customAttributes
    }
    customAttributes
  }
}
Variables
{
  "subnetId": 123,
  "supportGroupIds": [987],
  "supportGroupName": "abc123",
  "networkAddress": "abc123",
  "zoneId": 123
}
Response
{
  "data": {
    "addSupportGroupsToSubnet": [
      {
        "id": 987,
        "name": "xyz789",
        "description": "abc123",
        "contacts": [Contact],
        "customAttributes": {}
      }
    ]
  }
}

createAddress

Response

Returns an Address

Arguments
Name Description
id - Int
addresses - [AddressInput]

Example

Query
mutation CreateAddress(
  $id: Int,
  $addresses: [AddressInput]
) {
  createAddress(
    id: $id,
    addresses: $addresses
  ) {
    id
    line1
    line2
    line3
    line4
    municipality
    province
    country
    postalCode
  }
}
Variables
{"id": 123, "addresses": [AddressInput]}
Response
{
  "data": {
    "createAddress": {
      "id": 987,
      "line1": "xyz789",
      "line2": "abc123",
      "line3": "xyz789",
      "line4": "abc123",
      "municipality": "xyz789",
      "province": "abc123",
      "country": "xyz789",
      "postalCode": "xyz789"
    }
  }
}

createContact

Response

Returns a Contact

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

Example

Query
mutation CreateContact(
  $firstName: String,
  $lastName: String,
  $phone: String,
  $cellPhone: String,
  $email: String,
  $email2: String,
  $customAttributes: JSON
) {
  createContact(
    firstName: $firstName,
    lastName: $lastName,
    phone: $phone,
    cellPhone: $cellPhone,
    email: $email,
    email2: $email2,
    customAttributes: $customAttributes
  ) {
    id
    firstName
    lastName
    phone
    cellPhone
    email
    email2
    importBatchId
    customAttributes
  }
}
Variables
{
  "firstName": "abc123",
  "lastName": "abc123",
  "phone": "abc123",
  "cellPhone": "xyz789",
  "email": "abc123",
  "email2": "xyz789",
  "customAttributes": {}
}
Response
{
  "data": {
    "createContact": {
      "id": 987,
      "firstName": "xyz789",
      "lastName": "xyz789",
      "phone": "abc123",
      "cellPhone": "xyz789",
      "email": "abc123",
      "email2": "xyz789",
      "importBatchId": 987,
      "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": "xyz789",
  "type": "abc123",
  "required": true,
  "sectionId": 987,
  "rowIndex": 987,
  "rowColSpan": 123,
  "colIndex": 123,
  "colSpan": 987,
  "component": "xyz789"
}
Response
{
  "data": {
    "createCustomAttribute": {
      "id": 123,
      "modelName": "xyz789",
      "name": "abc123",
      "type": "xyz789",
      "required": true,
      "sectionId": 123,
      "rowIndex": 987,
      "rowColSpan": 123,
      "colIndex": 123,
      "colSpan": 987,
      "component": "abc123"
    }
  }
}

createCustomer

Response

Returns a Customer

Arguments
Name Description
name - String!
customAttributes - JSON
addresses - [AddressInput]

Example

Query
mutation CreateCustomer(
  $name: String!,
  $customAttributes: JSON,
  $addresses: [AddressInput]
) {
  createCustomer(
    name: $name,
    customAttributes: $customAttributes,
    addresses: $addresses
  ) {
    id
    name
    importId
    importBatchId
    addresses {
      id
      line1
      line2
      line3
      line4
      municipality
      province
      country
      postalCode
    }
    sites {
      id
      name
      importBatchId
      addresses {
        ...AddressFragment
      }
    }
    customAttributes
  }
}
Variables
{
  "name": "xyz789",
  "customAttributes": {},
  "addresses": [AddressInput]
}
Response
{
  "data": {
    "createCustomer": {
      "id": 987,
      "name": "abc123",
      "importId": 123,
      "importBatchId": 123,
      "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

Example

Query
mutation CreateDNSEntry(
  $name: String!,
  $ttl: Int,
  $recordClass: String,
  $recordType: String,
  $recordData: String,
  $customAttributes: JSON
) {
  createDNSEntry(
    name: $name,
    ttl: $ttl,
    recordClass: $recordClass,
    recordType: $recordType,
    recordData: $recordData,
    customAttributes: $customAttributes
  ) {
    id
    name
    ttl
    recordClass
    recordType
    recordData
    dnsZone {
      name
      dnsServer {
        ...DNSServerFragment
      }
    }
    customAttributes
  }
}
Variables
{
  "name": "abc123",
  "ttl": 123,
  "recordClass": "xyz789",
  "recordType": "abc123",
  "recordData": "abc123",
  "customAttributes": {}
}
Response
{
  "data": {
    "createDNSEntry": {
      "id": 987,
      "name": "abc123",
      "ttl": 123,
      "recordClass": "xyz789",
      "recordType": "abc123",
      "recordData": "xyz789",
      "dnsZone": [DNSZone],
      "customAttributes": {}
    }
  }
}

createDNSServer

Response

Returns an DNSServer

Arguments
Name Description
code - String!
name - String!

Example

Query
mutation CreateDNSServer(
  $code: String!,
  $name: String!
) {
  createDNSServer(
    code: $code,
    name: $name
  ) {
    name
  }
}
Variables
{
  "code": "xyz789",
  "name": "abc123"
}
Response
{
  "data": {
    "createDNSServer": {"name": "abc123"}
  }
}

createDNSZone

Response

Returns an DNSZone

Arguments
Name Description
name - String!

Example

Query
mutation CreateDNSZone($name: String!) {
  createDNSZone(name: $name) {
    name
    dnsServer {
      name
    }
  }
}
Variables
{"name": "xyz789"}
Response
{
  "data": {
    "createDNSZone": {
      "name": "xyz789",
      "dnsServer": [DNSServer]
    }
  }
}

createGateway

Response

Returns a Gateway

Arguments
Name Description
gateway - String!
subnetId - Int!

Example

Query
mutation CreateGateway(
  $gateway: String!,
  $subnetId: Int!
) {
  createGateway(
    gateway: $gateway,
    subnetId: $subnetId
  ) {
    id
    gateway
  }
}
Variables
{"gateway": "abc123", "subnetId": 123}
Response
{
  "data": {
    "createGateway": {
      "id": 987,
      "gateway": "xyz789"
    }
  }
}

createIPAssignment

Response

Returns an IPAssignment

Arguments
Name Description
networkAddress - String!
subnetId - Int!
description - String
ipAddressType - String
dnsEntries - [DNSEntryInput]
resource - ResourceInput
interfaceId - Int
customAttributes - JSON

Example

Query
mutation CreateIPAssignment(
  $networkAddress: String!,
  $subnetId: Int!,
  $description: String,
  $ipAddressType: String,
  $dnsEntries: [DNSEntryInput],
  $resource: ResourceInput,
  $interfaceId: Int,
  $customAttributes: JSON
) {
  createIPAssignment(
    networkAddress: $networkAddress,
    subnetId: $subnetId,
    description: $description,
    ipAddressType: $ipAddressType,
    dnsEntries: $dnsEntries,
    resource: $resource,
    interfaceId: $interfaceId,
    customAttributes: $customAttributes
  ) {
    id
    networkAddress
    description
    ipAddressType
    interface {
      id
      name
      macAddress
      resource {
        ...ResourceFragment
      }
      ipAssignment {
        ...IPAssignmentFragment
      }
      cloudResourceId
    }
    lastSeenAt
    subnet {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    DNSEntries {
      id
      name
      ttl
      recordClass
      recordType
      recordData
      dnsZone {
        ...DNSZoneFragment
      }
      customAttributes
    }
    resource {
      id
      hostname
      OS
      OSVersion
      macAddress
      cloudResourceId
      resourceGroupId
      resourceTypeId
      provider {
        ...ProviderFragment
      }
      interfaces {
        ...InterfaceFragment
      }
    }
    interfaces {
      id
      name
      macAddress
      resource {
        ...ResourceFragment
      }
      ipAssignment {
        ...IPAssignmentFragment
      }
      cloudResourceId
    }
    cloudResourceId
    createdAt
    importBatchId
    customAttributes
    request {
      id
      status
      zoneId
      ipAddress
      macAddress
      interface
      hostname
      customAttributes
      description
      networkRequestId
      networkRequest {
        ...NetworkRequestFragment
      }
    }
  }
}
Variables
{
  "networkAddress": "xyz789",
  "subnetId": 987,
  "description": "abc123",
  "ipAddressType": "xyz789",
  "dnsEntries": [DNSEntryInput],
  "resource": ResourceInput,
  "interfaceId": 123,
  "customAttributes": {}
}
Response
{
  "data": {
    "createIPAssignment": {
      "id": 123,
      "networkAddress": "abc123",
      "description": "abc123",
      "ipAddressType": "abc123",
      "interface": Interface,
      "lastSeenAt": "xyz789",
      "subnet": Subnet,
      "DNSEntries": [DNSEntry],
      "resource": Resource,
      "interfaces": [Interface],
      "cloudResourceId": "xyz789",
      "createdAt": "xyz789",
      "importBatchId": 987,
      "customAttributes": {},
      "request": NetworkRequestItem
    }
  }
}

createImport

Response

Returns an Import

Arguments
Name Description
name - String
description - String

Example

Query
mutation CreateImport(
  $name: String,
  $description: String
) {
  createImport(
    name: $name,
    description: $description
  ) {
    id
    description
    customer_count
    contact_count
    site_count
    zone_count
    subnet_count
    ip_assignment_count
    records {
      id
      type
      display
      value
    }
  }
}
Variables
{
  "name": "xyz789",
  "description": "xyz789"
}
Response
{
  "data": {
    "createImport": {
      "id": 123,
      "description": "xyz789",
      "customer_count": 987,
      "contact_count": 123,
      "site_count": 123,
      "zone_count": 987,
      "subnet_count": 123,
      "ip_assignment_count": 123,
      "records": [ImportRecord]
    }
  }
}

createInterface

Response

Returns an Interface

Arguments
Name Description
name - String!

Example

Query
mutation CreateInterface($name: String!) {
  createInterface(name: $name) {
    id
    name
    macAddress
    resource {
      id
      hostname
      OS
      OSVersion
      macAddress
      cloudResourceId
      resourceGroupId
      resourceTypeId
      provider {
        ...ProviderFragment
      }
      interfaces {
        ...InterfaceFragment
      }
    }
    ipAssignment {
      id
      networkAddress
      description
      ipAddressType
      interface {
        ...InterfaceFragment
      }
      lastSeenAt
      subnet {
        ...SubnetFragment
      }
      DNSEntries {
        ...DNSEntryFragment
      }
      resource {
        ...ResourceFragment
      }
      interfaces {
        ...InterfaceFragment
      }
      cloudResourceId
      createdAt
      importBatchId
      customAttributes
      request {
        ...NetworkRequestItemFragment
      }
    }
    cloudResourceId
  }
}
Variables
{"name": "xyz789"}
Response
{
  "data": {
    "createInterface": {
      "id": 987,
      "name": "xyz789",
      "macAddress": "xyz789",
      "resource": Resource,
      "ipAssignment": IPAssignment,
      "cloudResourceId": "abc123"
    }
  }
}

createLocation

Response

Returns a Location

Arguments
Name Description
name - String

Example

Query
mutation CreateLocation($name: String) {
  createLocation(name: $name) {
    id
    name
  }
}
Variables
{"name": "xyz789"}
Response
{
  "data": {
    "createLocation": {
      "id": 123,
      "name": "xyz789"
    }
  }
}

createNat

Response

Returns an NAT

Arguments
Name Description
sourceNatAddress - String
destinationNatAddress - [String]
subnetId - Int
natType - String
sourcePort - Int
sourceNatZoneId - Int
destinationPort - Int
destinationNatZoneId - Int
sourceType - String
destinationType - String

Example

Query
mutation CreateNat(
  $sourceNatAddress: String,
  $destinationNatAddress: [String],
  $subnetId: Int,
  $natType: String,
  $sourcePort: Int,
  $sourceNatZoneId: Int,
  $destinationPort: Int,
  $destinationNatZoneId: Int,
  $sourceType: String,
  $destinationType: String
) {
  createNat(
    sourceNatAddress: $sourceNatAddress,
    destinationNatAddress: $destinationNatAddress,
    subnetId: $subnetId,
    natType: $natType,
    sourcePort: $sourcePort,
    sourceNatZoneId: $sourceNatZoneId,
    destinationPort: $destinationPort,
    destinationNatZoneId: $destinationNatZoneId,
    sourceType: $sourceType,
    destinationType: $destinationType
  ) {
    id
    sourceNatAddress
    destinationNatAddress
    natType
    sourcePort
    sourceNatZoneId
    destinationPort
    destinationNatZoneId
    sourceType
    destinationType
    subnetId
  }
}
Variables
{
  "sourceNatAddress": "abc123",
  "destinationNatAddress": ["abc123"],
  "subnetId": 123,
  "natType": "abc123",
  "sourcePort": 987,
  "sourceNatZoneId": 987,
  "destinationPort": 987,
  "destinationNatZoneId": 987,
  "sourceType": "abc123",
  "destinationType": "xyz789"
}
Response
{
  "data": {
    "createNat": {
      "id": 987,
      "sourceNatAddress": "xyz789",
      "destinationNatAddress": ["xyz789"],
      "natType": "xyz789",
      "sourcePort": 123,
      "sourceNatZoneId": 123,
      "destinationPort": 123,
      "destinationNatZoneId": 123,
      "sourceType": "xyz789",
      "destinationType": "abc123",
      "subnetId": 987
    }
  }
}

createNetworkRequest

Response

Returns a NetworkRequest

Arguments
Name Description
status - String!
ipAddressCount - Int
details - String
subnetId - Int
NetworkRequestItems - [NetworkRequestItemInput]

Example

Query
mutation CreateNetworkRequest(
  $status: String!,
  $ipAddressCount: Int,
  $details: String,
  $subnetId: Int,
  $NetworkRequestItems: [NetworkRequestItemInput]
) {
  createNetworkRequest(
    status: $status,
    ipAddressCount: $ipAddressCount,
    details: $details,
    subnetId: $subnetId,
    NetworkRequestItems: $NetworkRequestItems
  ) {
    id
    status
    ipAddressCount
    details
    networkAddress
    zoneId
    subnetId
    NetworkRequestItems {
      id
      status
      zoneId
      ipAddress
      macAddress
      interface
      hostname
      customAttributes
      description
      networkRequestId
      networkRequest {
        ...NetworkRequestFragment
      }
    }
    createdAt
  }
}
Variables
{
  "status": "xyz789",
  "ipAddressCount": 123,
  "details": "xyz789",
  "subnetId": 987,
  "NetworkRequestItems": [NetworkRequestItemInput]
}
Response
{
  "data": {
    "createNetworkRequest": {
      "id": 123,
      "status": "xyz789",
      "ipAddressCount": 123,
      "details": "xyz789",
      "networkAddress": "abc123",
      "zoneId": "abc123",
      "subnetId": 987,
      "NetworkRequestItems": [NetworkRequestItem],
      "createdAt": "abc123"
    }
  }
}

createPlan

Response

Returns a Plan

Arguments
Name Description
name - String!
projectId - Int!
description - String
subnets - [SubnetInput]

Example

Query
mutation CreatePlan(
  $name: String!,
  $projectId: Int!,
  $description: String,
  $subnets: [SubnetInput]
) {
  createPlan(
    name: $name,
    projectId: $projectId,
    description: $description,
    subnets: $subnets
  ) {
    id
    name
    projectId
    description
    subnets {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    plannedChanges {
      id
      planId
      description
      sourceId
      sourceType
      sourceNetworkAddress
      destinationId
      destinationType
      destinationNetworkAddress
      status
      date
      sourceSubnet {
        ...SubnetFragment
      }
      destinationSubnet {
        ...SubnetFragment
      }
    }
  }
}
Variables
{
  "name": "xyz789",
  "projectId": 987,
  "description": "xyz789",
  "subnets": [SubnetInput]
}
Response
{
  "data": {
    "createPlan": {
      "id": 123,
      "name": "abc123",
      "projectId": 987,
      "description": "xyz789",
      "subnets": [Subnet],
      "plannedChanges": [PlannedChange]
    }
  }
}

createPlannedChange

Response

Returns a PlannedChange

Arguments
Name Description
planId - Int!
sourceId - Int
description - String
sourceType - String
sourceNetworkAddress - String
destinationId - Int
destinationType - String
destinationNetworkAddress - String
status - String

Example

Query
mutation CreatePlannedChange(
  $planId: Int!,
  $sourceId: Int,
  $description: String,
  $sourceType: String,
  $sourceNetworkAddress: String,
  $destinationId: Int,
  $destinationType: String,
  $destinationNetworkAddress: String,
  $status: String
) {
  createPlannedChange(
    planId: $planId,
    sourceId: $sourceId,
    description: $description,
    sourceType: $sourceType,
    sourceNetworkAddress: $sourceNetworkAddress,
    destinationId: $destinationId,
    destinationType: $destinationType,
    destinationNetworkAddress: $destinationNetworkAddress,
    status: $status
  ) {
    id
    planId
    description
    sourceId
    sourceType
    sourceNetworkAddress
    destinationId
    destinationType
    destinationNetworkAddress
    status
    date
    sourceSubnet {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    destinationSubnet {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
  }
}
Variables
{
  "planId": 987,
  "sourceId": 987,
  "description": "abc123",
  "sourceType": "abc123",
  "sourceNetworkAddress": "abc123",
  "destinationId": 123,
  "destinationType": "abc123",
  "destinationNetworkAddress": "xyz789",
  "status": "abc123"
}
Response
{
  "data": {
    "createPlannedChange": {
      "id": 987,
      "planId": 987,
      "description": "abc123",
      "sourceId": 987,
      "sourceType": "abc123",
      "sourceNetworkAddress": "abc123",
      "destinationId": 123,
      "destinationType": "abc123",
      "destinationNetworkAddress": "abc123",
      "status": "xyz789",
      "date": "xyz789",
      "sourceSubnet": Subnet,
      "destinationSubnet": Subnet
    }
  }
}

createProject

Response

Returns a Project

Arguments
Name Description
name - String

Example

Query
mutation CreateProject($name: String) {
  createProject(name: $name) {
    id
    name
    plans {
      id
      name
      projectId
      description
      subnets {
        ...SubnetFragment
      }
      plannedChanges {
        ...PlannedChangeFragment
      }
    }
  }
}
Variables
{"name": "xyz789"}
Response
{
  "data": {
    "createProject": {
      "id": 987,
      "name": "xyz789",
      "plans": [Plan]
    }
  }
}

createProvider

Response

Returns a Provider

Arguments
Name Description
name - String
type - String
active - Boolean
azureAppId - String
azurePassword - String
azureTenantId - String
awsAccessKeyId - String
awsSecretAccessKey - String
customAttributes - JSON

Example

Query
mutation CreateProvider(
  $name: String,
  $type: String,
  $active: Boolean,
  $azureAppId: String,
  $azurePassword: String,
  $azureTenantId: String,
  $awsAccessKeyId: String,
  $awsSecretAccessKey: String,
  $customAttributes: JSON
) {
  createProvider(
    name: $name,
    type: $type,
    active: $active,
    azureAppId: $azureAppId,
    azurePassword: $azurePassword,
    azureTenantId: $azureTenantId,
    awsAccessKeyId: $awsAccessKeyId,
    awsSecretAccessKey: $awsSecretAccessKey,
    customAttributes: $customAttributes
  ) {
    id
    name
    active
    type
    azureAppId
    azurePassword
    azureTenantId
    awsAccessKeyId
    awsSecretAccessKey
    lastSynchronizedAt
    syncStatus
    syncError
    customAttributes
  }
}
Variables
{
  "name": "xyz789",
  "type": "abc123",
  "active": true,
  "azureAppId": "abc123",
  "azurePassword": "abc123",
  "azureTenantId": "abc123",
  "awsAccessKeyId": "abc123",
  "awsSecretAccessKey": "abc123",
  "customAttributes": {}
}
Response
{
  "data": {
    "createProvider": {
      "id": 123,
      "name": "abc123",
      "active": true,
      "type": "xyz789",
      "azureAppId": "xyz789",
      "azurePassword": "abc123",
      "azureTenantId": "abc123",
      "awsAccessKeyId": "abc123",
      "awsSecretAccessKey": "abc123",
      "lastSynchronizedAt": "abc123",
      "syncStatus": "xyz789",
      "syncError": "xyz789",
      "customAttributes": {}
    }
  }
}

createReservation

Response

Returns a Reservation

Arguments
Name Description
name - String!
description - String
subnetId - Int!
color - String
ipAddresses - [IPAddressInput]
networkAddresses - [String]
zoneId - Int
networkAddress - String

Example

Query
mutation CreateReservation(
  $name: String!,
  $description: String,
  $subnetId: Int!,
  $color: String,
  $ipAddresses: [IPAddressInput],
  $networkAddresses: [String],
  $zoneId: Int,
  $networkAddress: String
) {
  createReservation(
    name: $name,
    description: $description,
    subnetId: $subnetId,
    color: $color,
    ipAddresses: $ipAddresses,
    networkAddresses: $networkAddresses,
    zoneId: $zoneId,
    networkAddress: $networkAddress
  ) {
    id
    name
    description
    color
    ipAddresses {
      id
      networkAddress
      ipAddressType
      ipAssignment {
        ...IPAssignmentFragment
      }
      reservation {
        ...ReservationFragment
      }
      request {
        ...NetworkRequestItemFragment
      }
      inUse
      subnet {
        ...SubnetFragment
      }
      zone {
        ...ZoneFragment
      }
    }
  }
}
Variables
{
  "name": "xyz789",
  "description": "abc123",
  "subnetId": 987,
  "color": "abc123",
  "ipAddresses": [IPAddressInput],
  "networkAddresses": ["xyz789"],
  "zoneId": 987,
  "networkAddress": "xyz789"
}
Response
{
  "data": {
    "createReservation": {
      "id": 987,
      "name": "xyz789",
      "description": "xyz789",
      "color": "abc123",
      "ipAddresses": [IPAddress]
    }
  }
}

createResource

Response

Returns a SupportGroup

Arguments
Name Description
name - String!
description - String

Example

Query
mutation CreateResource(
  $name: String!,
  $description: String
) {
  createResource(
    name: $name,
    description: $description
  ) {
    id
    name
    description
    contacts {
      id
      firstName
      lastName
      phone
      cellPhone
      email
      email2
      importBatchId
      customAttributes
    }
    customAttributes
  }
}
Variables
{
  "name": "abc123",
  "description": "xyz789"
}
Response
{
  "data": {
    "createResource": {
      "id": 123,
      "name": "abc123",
      "description": "xyz789",
      "contacts": [Contact],
      "customAttributes": {}
    }
  }
}

createResourceType

Response

Returns a ResourceType

Arguments
Name Description
id - Int
resourceType - ResourceTypeInput

Example

Query
mutation CreateResourceType(
  $id: Int,
  $resourceType: ResourceTypeInput
) {
  createResourceType(
    id: $id,
    resourceType: $resourceType
  ) {
    id
    name
  }
}
Variables
{"id": 987, "resourceType": ResourceTypeInput}
Response
{
  "data": {
    "createResourceType": {
      "id": 987,
      "name": "xyz789"
    }
  }
}

createRole

Response

Returns a Role

Arguments
Name Description
name - String

Example

Query
mutation CreateRole($name: String) {
  createRole(name: $name) {
    id
    name
    description
    plans {
      id
      name
      projectId
      description
      subnets {
        ...SubnetFragment
      }
      plannedChanges {
        ...PlannedChangeFragment
      }
    }
  }
}
Variables
{"name": "abc123"}
Response
{
  "data": {
    "createRole": {
      "id": 987,
      "name": "abc123",
      "description": "abc123",
      "plans": [Plan]
    }
  }
}

createRoleAssignment

Response

Returns a RoleAssignment

Arguments
Name Description
subjectId - Int!
subjectType - String!
roleId - Int!
recordId - Int
recordType - String
userName - String
roleName - String
networkAddress - String
zoneId - Int

Example

Query
mutation CreateRoleAssignment(
  $subjectId: Int!,
  $subjectType: String!,
  $roleId: Int!,
  $recordId: Int,
  $recordType: String,
  $userName: String,
  $roleName: String,
  $networkAddress: String,
  $zoneId: Int
) {
  createRoleAssignment(
    subjectId: $subjectId,
    subjectType: $subjectType,
    roleId: $roleId,
    recordId: $recordId,
    recordType: $recordType,
    userName: $userName,
    roleName: $roleName,
    networkAddress: $networkAddress,
    zoneId: $zoneId
  ) {
    id
    subjectId
    subjectType
    recordId
    recordType
    userGroup {
      id
      name
      description
    }
    role {
      id
      name
      description
      plans {
        ...PlanFragment
      }
    }
  }
}
Variables
{
  "subjectId": 123,
  "subjectType": "abc123",
  "roleId": 987,
  "recordId": 987,
  "recordType": "xyz789",
  "userName": "abc123",
  "roleName": "xyz789",
  "networkAddress": "xyz789",
  "zoneId": 987
}
Response
{
  "data": {
    "createRoleAssignment": {
      "id": 123,
      "subjectId": 123,
      "subjectType": "abc123",
      "recordId": "xyz789",
      "recordType": "abc123",
      "userGroup": UserGroup,
      "role": Role
    }
  }
}

createSite

Response

Returns a Site

Arguments
Name Description
name - String
customAttributes - JSON
addresses - [AddressInput]

Example

Query
mutation CreateSite(
  $name: String,
  $customAttributes: JSON,
  $addresses: [AddressInput]
) {
  createSite(
    name: $name,
    customAttributes: $customAttributes,
    addresses: $addresses
  ) {
    id
    name
    importBatchId
    addresses {
      id
      line1
      line2
      line3
      line4
      municipality
      province
      country
      postalCode
    }
  }
}
Variables
{
  "name": "abc123",
  "customAttributes": {},
  "addresses": [AddressInput]
}
Response
{
  "data": {
    "createSite": {
      "id": 987,
      "name": "abc123",
      "importBatchId": 123,
      "addresses": [Address]
    }
  }
}

createSubnet

Response

Returns a Subnet

Arguments
Name Description
planId - Int
status - String
name - String
direction - String
description - String
networkAddress - String
defaultGatewayId - Int
zoneId - Int
supernetId - Int
siteId - Int
defaultGateway - String
VLANId - Int
customAttributes - JSON

Example

Query
mutation CreateSubnet(
  $planId: Int,
  $status: String,
  $name: String,
  $direction: String,
  $description: String,
  $networkAddress: String,
  $defaultGatewayId: Int,
  $zoneId: Int,
  $supernetId: Int,
  $siteId: Int,
  $defaultGateway: String,
  $VLANId: Int,
  $customAttributes: JSON
) {
  createSubnet(
    planId: $planId,
    status: $status,
    name: $name,
    direction: $direction,
    description: $description,
    networkAddress: $networkAddress,
    defaultGatewayId: $defaultGatewayId,
    zoneId: $zoneId,
    supernetId: $supernetId,
    siteId: $siteId,
    defaultGateway: $defaultGateway,
    VLANId: $VLANId,
    customAttributes: $customAttributes
  ) {
    id
    status
    planId
    name
    description
    direction
    networkAddress
    host
    defaultGatewayId
    supernetId
    defaultGateway
    zone {
      id
      name
      description
      VRF
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
    }
    vlan {
      id
      number
    }
    pollable
    broadcast
    customers {
      id
      name
      importId
      importBatchId
      addresses {
        ...AddressFragment
      }
      sites {
        ...SiteFragment
      }
      customAttributes
    }
    Contacts {
      id
      firstName
      lastName
      phone
      cellPhone
      email
      email2
      importBatchId
      customAttributes
    }
    site {
      id
      name
      importBatchId
      addresses {
        ...AddressFragment
      }
    }
    gateway {
      id
      gateway
    }
    supportGroups {
      id
      name
      description
      contacts {
        ...ContactFragment
      }
      customAttributes
    }
    subnets {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    supernet {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    syncStatus
    lastSynchronizedAt
    syncError
    cloudResourceId
    importBatchId
    customAttributes
  }
}
Variables
{
  "planId": 987,
  "status": "xyz789",
  "name": "abc123",
  "direction": "abc123",
  "description": "abc123",
  "networkAddress": "xyz789",
  "defaultGatewayId": 123,
  "zoneId": 987,
  "supernetId": 987,
  "siteId": 123,
  "defaultGateway": "abc123",
  "VLANId": 987,
  "customAttributes": {}
}
Response
{
  "data": {
    "createSubnet": {
      "id": 123,
      "status": "xyz789",
      "planId": 123,
      "name": "abc123",
      "description": "abc123",
      "direction": "xyz789",
      "networkAddress": "abc123",
      "host": "abc123",
      "defaultGatewayId": 987,
      "supernetId": 123,
      "defaultGateway": "abc123",
      "zone": Zone,
      "vlan": VLAN,
      "pollable": true,
      "broadcast": "xyz789",
      "customers": [Customer],
      "Contacts": [Contact],
      "site": Site,
      "gateway": Gateway,
      "supportGroups": [SupportGroup],
      "subnets": [Subnet],
      "supernet": Subnet,
      "syncStatus": "xyz789",
      "lastSynchronizedAt": "abc123",
      "syncError": "abc123",
      "cloudResourceId": "xyz789",
      "importBatchId": 123,
      "customAttributes": {}
    }
  }
}

createSubnetTemplate

Response

Returns a SubnetTemplate

Arguments
Name Description
name - String
description - String
netmask - String

Example

Query
mutation CreateSubnetTemplate(
  $name: String,
  $description: String,
  $netmask: String
) {
  createSubnetTemplate(
    name: $name,
    description: $description,
    netmask: $netmask
  ) {
    id
    name
    description
    netmask
  }
}
Variables
{
  "name": "xyz789",
  "description": "xyz789",
  "netmask": "abc123"
}
Response
{
  "data": {
    "createSubnetTemplate": {
      "id": 987,
      "name": "xyz789",
      "description": "xyz789",
      "netmask": 123
    }
  }
}

createSupportGroup

Response

Returns a SupportGroup

Arguments
Name Description
name - String!
description - String

Example

Query
mutation CreateSupportGroup(
  $name: String!,
  $description: String
) {
  createSupportGroup(
    name: $name,
    description: $description
  ) {
    id
    name
    description
    contacts {
      id
      firstName
      lastName
      phone
      cellPhone
      email
      email2
      importBatchId
      customAttributes
    }
    customAttributes
  }
}
Variables
{
  "name": "abc123",
  "description": "xyz789"
}
Response
{
  "data": {
    "createSupportGroup": {
      "id": 987,
      "name": "xyz789",
      "description": "xyz789",
      "contacts": [Contact],
      "customAttributes": {}
    }
  }
}

createUserGroup

Response

Returns a UserGroup

Arguments
Name Description
name - String!

Example

Query
mutation CreateUserGroup($name: String!) {
  createUserGroup(name: $name) {
    id
    name
    description
  }
}
Variables
{"name": "xyz789"}
Response
{
  "data": {
    "createUserGroup": {
      "id": 987,
      "name": "abc123",
      "description": "abc123"
    }
  }
}

createVLAN

Response

Returns a VLAN

Arguments
Name Description
number - Int!

Example

Query
mutation CreateVLAN($number: Int!) {
  createVLAN(number: $number) {
    id
    number
  }
}
Variables
{"number": 123}
Response
{"data": {"createVLAN": {"id": 123, "number": 987}}}

createZone

Response

Returns a Zone

Arguments
Name Description
name - String!
description - String
providerId - Int
VRF - String
customAttributes - JSON

Example

Query
mutation CreateZone(
  $name: String!,
  $description: String,
  $providerId: Int,
  $VRF: String,
  $customAttributes: JSON
) {
  createZone(
    name: $name,
    description: $description,
    providerId: $providerId,
    VRF: $VRF,
    customAttributes: $customAttributes
  ) {
    id
    name
    description
    VRF
    provider {
      id
      name
      active
      type
      azureAppId
      azurePassword
      azureTenantId
      awsAccessKeyId
      awsSecretAccessKey
      lastSynchronizedAt
      syncStatus
      syncError
      customAttributes
    }
    parentZone {
      id
      name
      description
      VRF
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
    }
    cloudResourceId
    importBatchId
    customAttributes
  }
}
Variables
{
  "name": "abc123",
  "description": "abc123",
  "providerId": 123,
  "VRF": "xyz789",
  "customAttributes": {}
}
Response
{
  "data": {
    "createZone": {
      "id": 987,
      "name": "abc123",
      "description": "xyz789",
      "VRF": "xyz789",
      "provider": Provider,
      "parentZone": [Zone],
      "cloudResourceId": "abc123",
      "importBatchId": 123,
      "customAttributes": {}
    }
  }
}

destroyAddress

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyAddress($id: Int!) {
  destroyAddress(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyAddress": true}}

destroyContact

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyContact($id: Int!) {
  destroyContact(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyContact": true}}

destroyCustomAttributes

Response

Returns a Boolean

Arguments
Name Description
ids - [Int!]

Example

Query
mutation DestroyCustomAttributes($ids: [Int!]) {
  destroyCustomAttributes(ids: $ids)
}
Variables
{"ids": [987]}
Response
{"data": {"destroyCustomAttributes": true}}

destroyCustomer

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyCustomer($id: Int!) {
  destroyCustomer(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyCustomer": true}}

destroyDNSEntry

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyDNSEntry($id: Int!) {
  destroyDNSEntry(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyDNSEntry": false}}

destroyDNSServer

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyDNSServer($id: Int!) {
  destroyDNSServer(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyDNSServer": false}}

destroyDNSZone

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyDNSZone($id: Int!) {
  destroyDNSZone(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyDNSZone": false}}

destroyIPAssignment

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyIPAssignment($id: Int!) {
  destroyIPAssignment(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyIPAssignment": true}}

destroyImport

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyImport($id: Int!) {
  destroyImport(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyImport": true}}

destroyInterface

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyInterface($id: Int!) {
  destroyInterface(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyInterface": true}}

destroyLocation

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyLocation($id: Int!) {
  destroyLocation(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyLocation": false}}

destroyNat

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyNat($id: Int!) {
  destroyNat(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyNat": true}}

destroyNetworkRequest

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyNetworkRequest($id: Int!) {
  destroyNetworkRequest(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyNetworkRequest": true}}

destroyPlan

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyPlan($id: Int!) {
  destroyPlan(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyPlan": false}}

destroyPlannedChange

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyPlannedChange($id: Int!) {
  destroyPlannedChange(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyPlannedChange": false}}

destroyProject

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyProject($id: Int!) {
  destroyProject(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyProject": false}}

destroyProvider

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyProvider($id: Int!) {
  destroyProvider(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyProvider": true}}

destroyReservation

Response

Returns a Boolean

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

Example

Query
mutation DestroyReservation(
  $id: Int!,
  $networkAddresses: [String],
  $zoneId: Int,
  $networkAddress: String
) {
  destroyReservation(
    id: $id,
    networkAddresses: $networkAddresses,
    zoneId: $zoneId,
    networkAddress: $networkAddress
  )
}
Variables
{
  "id": 987,
  "networkAddresses": ["abc123"],
  "zoneId": 123,
  "networkAddress": "xyz789"
}
Response
{"data": {"destroyReservation": false}}

destroyResource

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyResource($id: Int!) {
  destroyResource(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyResource": false}}

destroyResourceType

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyResourceType($id: Int!) {
  destroyResourceType(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyResourceType": false}}

destroyRole

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyRole($id: Int!) {
  destroyRole(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyRole": false}}

destroyRoleAssignment

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyRoleAssignment($id: Int!) {
  destroyRoleAssignment(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyRoleAssignment": true}}

destroySite

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroySite($id: Int!) {
  destroySite(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroySite": true}}

destroySubnet

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroySubnet($id: Int!) {
  destroySubnet(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroySubnet": false}}

destroySubnetTemplate

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroySubnetTemplate($id: Int!) {
  destroySubnetTemplate(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroySubnetTemplate": true}}

destroySupportGroup

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroySupportGroup($id: Int!) {
  destroySupportGroup(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroySupportGroup": false}}

destroyUserGroup

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyUserGroup($id: Int!) {
  destroyUserGroup(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"destroyUserGroup": true}}

destroyVLAN

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyVLAN($id: Int!) {
  destroyVLAN(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyVLAN": false}}

destroyZone

Response

Returns a Boolean

Arguments
Name Description
id - Int!

Example

Query
mutation DestroyZone($id: Int!) {
  destroyZone(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"destroyZone": true}}

generateApiKey

Response

Returns an ApiKey

Arguments
Name Description
apiKeyName - String!
customExpiration - String
apiKey - String!

Example

Query
mutation GenerateApiKey(
  $apiKeyName: String!,
  $customExpiration: String,
  $apiKey: String!
) {
  generateApiKey(
    apiKeyName: $apiKeyName,
    customExpiration: $customExpiration,
    apiKey: $apiKey
  ) {
    id
    apiKey
    apiKeyExpiry
    apiKeyName
  }
}
Variables
{
  "apiKeyName": "abc123",
  "customExpiration": "xyz789",
  "apiKey": "xyz789"
}
Response
{
  "data": {
    "generateApiKey": {
      "id": 123,
      "apiKey": "abc123",
      "apiKeyExpiry": "abc123",
      "apiKeyName": "xyz789"
    }
  }
}

importContacts

Response

Returns a Boolean

Arguments
Name Description
importId - Int!
contacts - [ContactInput]!

Example

Query
mutation ImportContacts(
  $importId: Int!,
  $contacts: [ContactInput]!
) {
  importContacts(
    importId: $importId,
    contacts: $contacts
  )
}
Variables
{"importId": 987, "contacts": [ContactInput]}
Response
{"data": {"importContacts": false}}

importCustomAttributes

Response

Returns a Boolean

Arguments
Name Description
importId - Int!
contacts - [CustomAttributeInput]!

Example

Query
mutation ImportCustomAttributes(
  $importId: Int!,
  $contacts: [CustomAttributeInput]!
) {
  importCustomAttributes(
    importId: $importId,
    contacts: $contacts
  )
}
Variables
{"importId": 123, "contacts": [CustomAttributeInput]}
Response
{"data": {"importCustomAttributes": true}}

importCustomers

Response

Returns a Boolean

Arguments
Name Description
importId - Int!
customers - [CustomerInput]!

Example

Query
mutation ImportCustomers(
  $importId: Int!,
  $customers: [CustomerInput]!
) {
  importCustomers(
    importId: $importId,
    customers: $customers
  )
}
Variables
{"importId": 123, "customers": [CustomerInput]}
Response
{"data": {"importCustomers": true}}

importIPAssignments

Response

Returns a Boolean

Arguments
Name Description
importId - Int!
ipAssignments - [IPAssignmentInput]!

Example

Query
mutation ImportIPAssignments(
  $importId: Int!,
  $ipAssignments: [IPAssignmentInput]!
) {
  importIPAssignments(
    importId: $importId,
    ipAssignments: $ipAssignments
  )
}
Variables
{"importId": 123, "ipAssignments": [IPAssignmentInput]}
Response
{"data": {"importIPAssignments": true}}

importSites

Response

Returns a Boolean

Arguments
Name Description
importId - Int!
sites - [SiteInput]!

Example

Query
mutation ImportSites(
  $importId: Int!,
  $sites: [SiteInput]!
) {
  importSites(
    importId: $importId,
    sites: $sites
  )
}
Variables
{"importId": 987, "sites": [SiteInput]}
Response
{"data": {"importSites": false}}

importSubnets

Response

Returns a Boolean

Arguments
Name Description
importId - Int!
subnets - [SubnetInput]!

Example

Query
mutation ImportSubnets(
  $importId: Int!,
  $subnets: [SubnetInput]!
) {
  importSubnets(
    importId: $importId,
    subnets: $subnets
  )
}
Variables
{"importId": 987, "subnets": [SubnetInput]}
Response
{"data": {"importSubnets": false}}

importZones

Response

Returns a Boolean

Arguments
Name Description
importId - Int!
zones - [ZoneInput]!

Example

Query
mutation ImportZones(
  $importId: Int!,
  $zones: [ZoneInput]!
) {
  importZones(
    importId: $importId,
    zones: $zones
  )
}
Variables
{"importId": 987, "zones": [ZoneInput]}
Response
{"data": {"importZones": false}}

refreshSubnet

Response

Returns a Subnet

Arguments
Name Description
id - Int!

Example

Query
mutation RefreshSubnet($id: Int!) {
  refreshSubnet(id: $id) {
    id
    status
    planId
    name
    description
    direction
    networkAddress
    host
    defaultGatewayId
    supernetId
    defaultGateway
    zone {
      id
      name
      description
      VRF
      provider {
        ...ProviderFragment
      }
      parentZone {
        ...ZoneFragment
      }
      cloudResourceId
      importBatchId
      customAttributes
    }
    vlan {
      id
      number
    }
    pollable
    broadcast
    customers {
      id
      name
      importId
      importBatchId
      addresses {
        ...AddressFragment
      }
      sites {
        ...SiteFragment
      }
      customAttributes
    }
    Contacts {
      id
      firstName
      lastName
      phone
      cellPhone
      email
      email2
      importBatchId
      customAttributes
    }
    site {
      id
      name
      importBatchId
      addresses {
        ...AddressFragment
      }
    }
    gateway {
      id
      gateway
    }
    supportGroups {
      id
      name
      description
      contacts {
        ...ContactFragment
      }
      customAttributes
    }
    subnets {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broadcast
      customers {
        ...CustomerFragment
      }
      Contacts {
        ...ContactFragment
      }
      site {
        ...SiteFragment
      }
      gateway {
        ...GatewayFragment
      }
      supportGroups {
        ...SupportGroupFragment
      }
      subnets {
        ...SubnetFragment
      }
      supernet {
        ...SubnetFragment
      }
      syncStatus
      lastSynchronizedAt
      syncError
      cloudResourceId
      importBatchId
      customAttributes
    }
    supernet {
      id
      status
      planId
      name
      description
      direction
      networkAddress
      host
      defaultGatewayId
      supernetId
      defaultGateway
      zone {
        ...ZoneFragment
      }
      vlan {
        ...VLANFragment
      }
      pollable
      broa