NearbyComputing API API Reference

Documentation for GraphQL API Gateway

API Endpoints

Demo:
https://demo.nearbycomputing.com

Charts

View information about one or more Block Charts

Charts

Block chart

Fetch a chart by name and version

name:

string

Block Chart name

version:

string

Block Chart version. If unspecified, then the latest version is returned

Example

Request Content-Types: application/json

Query

query blockChart($name: String!, $version: String){
  blockChart(name: $name, version: $version){
    id
    name
    version
    availableVersions
    categories
    description
    chartYaml
    displayName
    valuesSchema
    overridesYaml
    vendor
    logoUrl
  }
}

Variables

{
  "name": "string",
  "version": "string"
}

Try it now

200 OK

Successful operation

type

BlockChart

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "blockChart": {
      "id": "string",
      "name": "string",
      "version": "string",
      "availableVersions": [
        "string"
      ],
      "categories": [
        "string"
      ],
      "description": "string",
      "chartYaml": "string",
      "displayName": "string",
      "valuesSchema": "string",
      "overridesYaml": "string",
      "vendor": "string",
      "logoUrl": "string"
    }
  }
}

Charts

Block charts

Fetch the latest versions of all charts in the marketplace

category:

string

(no description)

vendors:

string[]

(no description)

chartType:

BlockChartType

(no description)

Example

Request Content-Types: application/json

Query

query blockCharts($category: String, $vendors: [ID!], $chartType: BlockChartType){
  blockCharts(category: $category, vendors: $vendors, chartType: $chartType){
    id
    name
    version
    availableVersions
    categories
    description
    chartYaml
    displayName
    valuesSchema
    overridesYaml
    vendor
    logoUrl
  }
}

Variables

{
  "category": "string",
  "vendors": [
    "string"
  ],
  "chartType": "string"
}

Try it now

200 OK

Successful operation

type

BlockChart

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "blockCharts": [
      {
        "id": "string",
        "name": "string",
        "version": "string",
        "availableVersions": [
          "string"
        ],
        "categories": [
          "string"
        ],
        "description": "string",
        "chartYaml": "string",
        "displayName": "string",
        "valuesSchema": "string",
        "overridesYaml": "string",
        "vendor": "string",
        "logoUrl": "string"
      }
    ]
  }
}

Charts

Publish Block Chart

Publish a new Block Chart based on an existing template

input:

PublishBlockChartInput

(no description)

Example

Request Content-Types: application/json

Query

mutation publishBlockChart($input: PublishBlockChartInput!){
  publishBlockChart(input: $input){
    id
    name
    version
    availableVersions
    categories
    description
    chartYaml
    displayName
    valuesSchema
    overridesYaml
    vendor
    logoUrl
  }
}

Variables

{
  "input": {
    "templateName": "string",
    "templateVersion": "string",
    "chartMeta": {
      "name": "string",
      "version": "string",
      "displayName": "string",
      "vendor": "string",
      "description": "string",
      "iconUrl": "string",
      "categories": [
        "string"
      ]
    },
    "valuesYaml": "string",
    "overridesYaml": "string"
  }
}

Try it now

200 OK

Successful operation

type

BlockChart

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "publishBlockChart": {
      "id": "string",
      "name": "string",
      "version": "string",
      "availableVersions": [
        "string"
      ],
      "categories": [
        "string"
      ],
      "description": "string",
      "chartYaml": "string",
      "displayName": "string",
      "valuesSchema": "string",
      "overridesYaml": "string",
      "vendor": "string",
      "logoUrl": "string"
    }
  }
}

Charts

Delete Block Chart

Delete an existing Block Chart based on an existing template

name:

string

(no description)

version:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation deleteBlockChart($name: String!, $version: String!){
  deleteBlockChart(name: $name, version: $version)
}

Variables

{
  "name": "string",
  "version": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "deleteBlockChart": "string"
  }
}

Charts

Provision Chart

Fetch the baremetal / software values of a Provisioning Chart

name:

string

(no description)

version:

string

(no description)

Example

Request Content-Types: application/json

Query

query provisionChart($name: String!, $version: String!){
  provisionChart(name: $name, version: $version){
    name
    version
    availableVersions
  }
}

Variables

{
  "name": "string",
  "version": "string"
}

Try it now

200 OK

Successful operation

type

ProvisionChart

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "provisionChart": {
      "name": "string",
      "version": "string",
      "availableVersions": [
        "string"
      ]
    }
  }
}

Charts

Provision Charts

Fetch a list of all versions of all Provision Charts

Example

Request Content-Types: application/json

Query

query provisionCharts{
  provisionCharts{
    name
    version
  }
}

Try it now

200 OK

Successful operation

type

ChartKey

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "provisionCharts": [
      {
        "name": "string",
        "version": "string"
      }
    ]
  }
}

Charts

Cloud Resource Chart

Fetch the default config of a Cloud Resource Chart

name:

string

(no description)

version:

string

(no description)

Example

Request Content-Types: application/json

Query

query cloudResourceChart($name: String!, $version: String!){
  cloudResourceChart(name: $name, version: $version){
    name
    version
  }
}

Variables

{
  "name": "string",
  "version": "string"
}

Try it now

200 OK

Successful operation

type

CloudResourceChart

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "cloudResourceChart": {
      "name": "string",
      "version": "string"
    }
  }
}

Charts

Cloud Resource Charts

Fetch a list of the latest versions of all Cloud Resource Charts

Example

Request Content-Types: application/json

Query

query cloudResourceCharts{
  cloudResourceCharts{
    displayName
  }
}

Try it now

200 OK

Successful operation

type

CloudResourceChartListing

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "cloudResourceCharts": [
      {
        "displayName": "string"
      }
    ]
  }
}

Charts

Publisher Template

Fetch the latest versions of all Publisher Templates

category:

string

(no description)

vendors:

string[]

(no description)

Example

Request Content-Types: application/json

Query

query templateCharts($category: String, $vendors: [ID!]){
  templateCharts(category: $category, vendors: $vendors){
    id
    name
    version
    availableVersions
    categories
    description
    chartYaml
    displayName
    valuesYaml
    overridesYaml
    vendor
    logoUrl
  }
}

Variables

{
  "category": "string",
  "vendors": [
    "string"
  ]
}

Try it now

200 OK

Successful operation

type

TemplateChart

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "templateCharts": [
      {
        "id": "string",
        "name": "string",
        "version": "string",
        "availableVersions": [
          "string"
        ],
        "categories": [
          "string"
        ],
        "description": "string",
        "chartYaml": "string",
        "displayName": "string",
        "valuesYaml": "string",
        "overridesYaml": "string",
        "vendor": "string",
        "logoUrl": "string"
      }
    ]
  }
}

Connections

View connections from a device or service

Connections

Fetch Connections

List all connections from a given service or device

entities:

string[]

List of parent entity (service or device) to filter by

Example

Request Content-Types: application/json

Query

query connections($entities: [ID!]){
  connections(entities: $entities){
    id
    category
    description
    kind
    name
    source
  }
}

Variables

{
  "entities": [
    "string"
  ]
}

Try it now

200 OK

Successful operation

type

Connection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "connections": [
      {
        "id": "string",
        "category": "string",
        "description": "string",
        "kind": "string",
        "name": "string",
        "source": "string"
      }
    ]
  }
}

Crossplane Provisions

Create and update Cloud Resource provisions

Crossplane Provisions

Cloud Resource Provision

Provision a Cloud Resource

input:

CloudResourceInput

(no description)

Example

Request Content-Types: application/json

Query

mutation cloudResource($input: CloudResourceInput!){
  cloudResource(input: $input){
    id
    tags
    displayName
    specs
    status
    site
    metadata
    deviceType
  }
}

Variables

{
  "input": {
    "chartName": "string",
    "chartVersion": "string",
    "controllerSite": "object",
    "config": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "displayName": "string",
    "position": {
      "lat": "number",
      "lng": "number"
    },
    "deviceSite": "object"
  }
}

Try it now

200 OK

Successful operation

type

Device

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "cloudResource": {
      "id": "string",
      "tags": [
        "string"
      ],
      "displayName": "string",
      "specs": "string",
      "site": "string",
      "metadata": "string",
      "deviceType": "string"
    }
  }
}

Crossplane Provisions

Update Cloud Resource

update a provisioned Cloud Resource

input:

UpdateCloudResourceInput

(no description)

Example

Request Content-Types: application/json

Query

mutation updateCloudResource($input: UpdateCloudResourceInput!){
  updateCloudResource(input: $input){
    id
    tags
    displayName
    specs
    status
    site
    metadata
    deviceType
  }
}

Variables

{
  "input": {
    "id": "object",
    "blockVersion": "string",
    "displayName": "string",
    "providerConfig": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "position": {
      "lat": "number",
      "lng": "number"
    },
    "deviceSite": "object"
  }
}

Try it now

200 OK

Successful operation

type

Device

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateCloudResource": {
      "id": "string",
      "tags": [
        "string"
      ],
      "displayName": "string",
      "specs": "string",
      "site": "string",
      "metadata": "string",
      "deviceType": "string"
    }
  }
}

Devices

View, register and remove devices

Devices

List devices

Query one or more registered devices

id:

string

Device ID (overrides other parameters)

tags:

TagInput

List of tag filters

bbox:

BBox

Geographic bounding box. Results outside this box will not be returned

searchTerm:

string

Free text search field to filter by device display name, IP address and/or MAC address

Example

Request Content-Types: application/json

Query

query devices($id: ID, $tags: [TagInput!], $bbox: BBox, $searchTerm: String){
  devices(id: $id, tags: $tags, bbox: $bbox, searchTerm: $searchTerm){
    devices{
      id
      tags
      displayName
      specs
      status
      site
      metadata
      deviceType
    }
    hits
  }
}

Variables

{
  "id": "string",
  "tags": [
    {
      "key": "string",
      "inc": "boolean"
    }
  ],
  "bbox": {
    "nw": {
      "lat": "number",
      "lng": "number"
    },
    "se": {
      "lat": "number",
      "lng": "number"
    }
  },
  "searchTerm": "string"
}

Try it now

200 OK

Successful operation

type

DevicesResult

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "devices": {
      "hits": "integer"
    }
  }
}

Devices

Register device

dev:

DeviceInput

Properties of the new device to be registered

Example

Request Content-Types: application/json

Query

mutation device($dev: DeviceInput!){
  device(dev: $dev){
    id
    tags
    displayName
    specs
    status
    site
    metadata
    deviceType
  }
}

Variables

{
  "dev": {
    "connections": [
      {
        "category": "string",
        "kind": "string",
        "name": "string",
        "source": "string"
      }
    ],
    "tags": [
      "string"
    ],
    "displayName": "string",
    "kubeconfig": "string",
    "managedNamespace": "string",
    "position": {
      "lat": "number",
      "lng": "number"
    },
    "site": "string"
  }
}

Try it now

200 OK

Successful operation

type

Device

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "device": {
      "id": "string",
      "tags": [
        "string"
      ],
      "displayName": "string",
      "specs": "string",
      "site": "string",
      "metadata": "string",
      "deviceType": "string"
    }
  }
}

Devices

Remove device

Unregister a device

id:

string

ID of device to remove

Example

Request Content-Types: application/json

Query

mutation removeDevice($id: ID!){
  removeDevice(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "removeDevice": "string"
  }
}

Federation

View, create and manage guest accounts and federation hosts

Federation

Federation Guests

List all Federation Guest accounts within an org

Example

Request Content-Types: application/json

Query

query federationGuests{
  federationGuests{
    id
    federationName
    operatorName
    countryCode
    mcc
    mncs
    parentSite
    status
  }
}

Try it now

200 OK

Successful operation

type

FederationGuest

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "federationGuests": [
      {
        "id": "string",
        "federationName": "string",
        "operatorName": "string",
        "countryCode": "string",
        "mcc": "string",
        "mncs": [
          "string"
        ],
        "parentSite": "string"
      }
    ]
  }
}

Federation

Federation Guest

Fetch a single Federation Guest account

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query federationGuest($id: ID!){
  federationGuest(id: $id){
    id
    federationName
    operatorName
    countryCode
    mcc
    mncs
    parentSite
    status
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

FederationGuest

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "federationGuest": {
      "id": "string",
      "federationName": "string",
      "operatorName": "string",
      "countryCode": "string",
      "mcc": "string",
      "mncs": [
        "string"
      ],
      "parentSite": "string"
    }
  }
}

Federation

Federation Hosts

List all Federation Hosts within an org

Example

Request Content-Types: application/json

Query

query federationHosts{
  federationHosts{
    id
    federationName
    operatorName
    countryCode
    mcc
    mncs
    hostUrl
    siteId
    status
  }
}

Try it now

200 OK

Successful operation

type

FederationHost

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "federationHosts": [
      {
        "id": "string",
        "federationName": "string",
        "operatorName": "string",
        "countryCode": "string",
        "mcc": "string",
        "mncs": [
          "string"
        ],
        "hostUrl": "string",
        "siteId": "string"
      }
    ]
  }
}

Federation

Federation Host

Fetch a single Federation Host

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query federationHost($id: ID!){
  federationHost(id: $id){
    id
    federationName
    operatorName
    countryCode
    mcc
    mncs
    hostUrl
    siteId
    status
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

FederationHost

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "federationHost": {
      "id": "string",
      "federationName": "string",
      "operatorName": "string",
      "countryCode": "string",
      "mcc": "string",
      "mncs": [
        "string"
      ],
      "hostUrl": "string",
      "siteId": "string"
    }
  }
}

Federation

Edit Federation

Edit a federation

id:

string

(no description)

fed:

FederationInput

(no description)

Example

Request Content-Types: application/json

Query

mutation editFederation($id: ID!, $fed: FederationInput!){
  editFederation(id: $id, fed: $fed){
    id
    displayName
    description
  }
}

Variables

{
  "id": "string",
  "fed": {
    "operatorName": "string",
    "countryCode": "string",
    "mcc": "string",
    "mncs": [
      "string"
    ],
    "federationUrl": "string"
  }
}

Try it now

200 OK

Successful operation

type

Org

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "editFederation": {
      "id": "string",
      "displayName": "string",
      "description": "string"
    }
  }
}

Federation

Create Federation Guest

Create a Federation Guest account

guest:

FederationGuestInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createFederationGuest($guest: FederationGuestInput!){
  createFederationGuest(guest: $guest){
  }
}

Variables

{
  "guest": {
    "federationName": "string",
    "operatorName": "string",
    "countryCode": "string",
    "mcc": "string",
    "mncs": [
      "string"
    ],
    "parentSite": "string"
  }
}

Try it now

200 OK

Successful operation

type

NewFederationGuest

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createFederationGuest": {}
  }
}

Federation

Edit Federation Guest

Edit an existing Federation Guest account

info:

EditFederationGuestInput

(no description)

Example

Request Content-Types: application/json

Query

mutation editFederationGuest($info: EditFederationGuestInput!){
  editFederationGuest(info: $info){
    id
    federationName
    operatorName
    countryCode
    mcc
    mncs
    parentSite
    status
  }
}

Variables

{
  "info": {
    "id": "object",
    "countryCode": "string",
    "mcc": "string",
    "mncs": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

FederationGuest

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "editFederationGuest": {
      "id": "string",
      "federationName": "string",
      "operatorName": "string",
      "countryCode": "string",
      "mcc": "string",
      "mncs": [
        "string"
      ],
      "parentSite": "string"
    }
  }
}

Federation

Remove Federation Guest

Remove an existing Federation Guest account

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation removeFederationGuest($id: ID!){
  removeFederationGuest(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "removeFederationGuest": "string"
  }
}

Federation

Set Federation Guest status

Disable / enable a federation guest account

status:

SetFederationGuestStatusInput

(no description)

Example

Request Content-Types: application/json

Query

mutation setFederationGuestStatus($status: SetFederationGuestStatusInput!){
  setFederationGuestStatus(status: $status){
    id
    federationName
    operatorName
    countryCode
    mcc
    mncs
    parentSite
    status
  }
}

Variables

{
  "status": {
    "id": "object",
    "status": "string"
  }
}

Try it now

200 OK

Successful operation

type

FederationGuest

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "setFederationGuestStatus": {
      "id": "string",
      "federationName": "string",
      "operatorName": "string",
      "countryCode": "string",
      "mcc": "string",
      "mncs": [
        "string"
      ],
      "parentSite": "string"
    }
  }
}

Federation

Create Federation Host

Create a Federation Host

host:

FederationHostInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createFederationHost($host: FederationHostInput!){
  createFederationHost(host: $host){
    id
    federationName
    operatorName
    countryCode
    mcc
    mncs
    hostUrl
    siteId
    status
  }
}

Variables

{
  "host": {
    "federationName": "string",
    "operatorName": "string",
    "countryCode": "string",
    "mcc": "string",
    "mncs": [
      "string"
    ],
    "hostUrl": "string",
    "siteId": "string",
    "clientId": "string",
    "clientSecret": "string"
  }
}

Try it now

200 OK

Successful operation

type

FederationHost

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createFederationHost": {
      "id": "string",
      "federationName": "string",
      "operatorName": "string",
      "countryCode": "string",
      "mcc": "string",
      "mncs": [
        "string"
      ],
      "hostUrl": "string",
      "siteId": "string"
    }
  }
}

Federation

Edit Federation Host

Edit an existing Federation Host

host:

EditFederationHostInput

(no description)

Example

Request Content-Types: application/json

Query

mutation editFederationHost($host: EditFederationHostInput!){
  editFederationHost(host: $host){
    id
    federationName
    operatorName
    countryCode
    mcc
    mncs
    hostUrl
    siteId
    status
  }
}

Variables

{
  "host": {
    "id": "object",
    "federationName": "string",
    "operatorName": "string",
    "countryCode": "string",
    "mcc": "string",
    "mncs": [
      "string"
    ],
    "hostUrl": "string",
    "siteId": "string",
    "clientId": "string",
    "clientSecret": "string"
  }
}

Try it now

200 OK

Successful operation

type

FederationHost

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "editFederationHost": {
      "id": "string",
      "federationName": "string",
      "operatorName": "string",
      "countryCode": "string",
      "mcc": "string",
      "mncs": [
        "string"
      ],
      "hostUrl": "string",
      "siteId": "string"
    }
  }
}

Federation

Remove Federation Host

Remove an existing Federation Host

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation removeFederationHost($id: ID!){
  removeFederationHost(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "removeFederationHost": "string"
  }
}

Management

Endpoints for managing your installation

Management

API Tokens

Fetch API Tokens

Example

Request Content-Types: application/json

Query

query apiTokens{
  apiTokens{
    id
    googleMaps
    mapbox
  }
}

Try it now

200 OK

Successful operation

type

ApiTokens

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "apiTokens": {
      "id": "string",
      "googleMaps": "string",
      "mapbox": "string"
    }
  }
}

Management

Version

Fetch the version of NearbyOne

Example

Request Content-Types: application/json

Query

query version{
  version{
    app
    build
  }
}

Try it now

200 OK

Successful operation

type

Version

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "version": {
      "app": "string",
      "build": "string"
    }
  }
}

Okto Resources

View information on Okto Resources

Provisions

View, create and manage provisions

Provisions

List all Provisions in a site

site:

string

(no description)

Example

Request Content-Types: application/json

Query

query provisions($site: ID!){
  provisions(site: $site){
    id
    displayName
    inventory
    lastUpdated
    status
  }
}

Variables

{
  "site": "string"
}

Try it now

200 OK

Successful operation

type

Provision

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "provisions": [
      {
        "id": "string",
        "displayName": "string",
        "inventory": "string"
      }
    ]
  }
}

Provisions

Provision

Create a provision

input:

ProvisionInput

(no description)

Example

Request Content-Types: application/json

Query

mutation provision($input: ProvisionInput!){
  provision(input: $input){
    id
    tags
    displayName
    specs
    status
    site
    metadata
    deviceType
  }
}

Variables

{
  "input": {
    "chartName": "string",
    "chartVersion": "string",
    "provisionerSite": "object",
    "provisionInventory": "string",
    "displayName": "string",
    "position": {
      "lat": "number",
      "lng": "number"
    },
    "site": "object"
  }
}

Try it now

200 OK

Successful operation

type

Device

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "provision": {
      "id": "string",
      "tags": [
        "string"
      ],
      "displayName": "string",
      "specs": "string",
      "site": "string",
      "metadata": "string",
      "deviceType": "string"
    }
  }
}

Services

View information on currently deployed services

Services

Okto resource logs

View the logs for a single Okto resource

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query oktoResourceLogs($id: ID!){
  oktoResourceLogs(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "oktoResourceLogs": "string"
  }
}

Services

Service chain

Fetch service chain by ID

id:

string

Service chain ID

Example

Request Content-Types: application/json

Query

query serviceChain($id: ID!){
  serviceChain(id: $id){
    id
    revision
    name
    status
    org
    owner
    createdAt
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

ServiceChain

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "serviceChain": {
      "id": "string",
      "revision": "integer",
      "name": "string",
      "org": "string",
      "owner": "string"
    }
  }
}

Services

Service chains

List all service chains

org:

string

optional org to search within. If null, will use currently selected org from context

sites:

string[]

(no description)

Example

Request Content-Types: application/json

Query

query serviceChains($org: ID, $sites: [ID!]){
  serviceChains(org: $org, sites: $sites){
    id
    revision
    name
    status
    org
    owner
    createdAt
  }
}

Variables

{
  "org": "string",
  "sites": [
    "string"
  ]
}

Try it now

200 OK

Successful operation

type

ServiceChain

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "serviceChains": [
      {
        "id": "string",
        "revision": "integer",
        "name": "string",
        "org": "string",
        "owner": "string"
      }
    ]
  }
}

Services

Deploy service chain

Deploy a chain of connected services

name:

string

Display name of the service chain

blocks:

BlockInput

List of blocks in the service chain

Example

Request Content-Types: application/json

Query

mutation deployServiceChain($name: String!, $blocks: [BlockInput!]){
  deployServiceChain(name: $name, blocks: $blocks){
    id
    revision
    name
    status
    org
    owner
    createdAt
  }
}

Variables

{
  "name": "string",
  "blocks": [
    {
      "id": "object",
      "displayName": "string",
      "blockChartName": "string",
      "blockChartVersion": "string",
      "values": "string"
    }
  ]
}

Try it now

200 OK

Successful operation

type

ServiceChain

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "deployServiceChain": {
      "id": "string",
      "revision": "integer",
      "name": "string",
      "org": "string",
      "owner": "string"
    }
  }
}

Services

Update service chain

Modify a service chain that is already running

id:

string

ID of service chain ID to update

name:

string

New name for the service chain

blocks:

BlockInput

New list of blocks in the service chain

Example

Request Content-Types: application/json

Query

mutation updateServiceChain($id: ID!, $name: String!, $blocks: [BlockInput!]){
  updateServiceChain(id: $id, name: $name, blocks: $blocks){
    id
    revision
    name
    status
    org
    owner
    createdAt
  }
}

Variables

{
  "id": "string",
  "name": "string",
  "blocks": [
    {
      "id": "object",
      "displayName": "string",
      "blockChartName": "string",
      "blockChartVersion": "string",
      "values": "string"
    }
  ]
}

Try it now

200 OK

Successful operation

type

ServiceChain

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "updateServiceChain": {
      "id": "string",
      "revision": "integer",
      "name": "string",
      "org": "string",
      "owner": "string"
    }
  }
}

Services

Rollback service chain

Revert to a previous revision of a service chain

id:

string

ID of service chain ID to rollback

revision:

integer

version to rollback to

Example

Request Content-Types: application/json

Query

mutation rollbackServiceChain($id: ID!, $revision: Int!){
  rollbackServiceChain(id: $id, revision: $revision){
    id
    revision
    name
    status
    org
    owner
    createdAt
  }
}

Variables

{
  "id": "string",
  "revision": "integer"
}

Try it now

200 OK

Successful operation

type

ServiceChain

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "rollbackServiceChain": {
      "id": "string",
      "revision": "integer",
      "name": "string",
      "org": "string",
      "owner": "string"
    }
  }
}

Services

Remove service chain

Undeploy a running service chain

id:

string

ID of the service chain to remove

Example

Request Content-Types: application/json

Query

mutation removeServiceChain($id: ID!){
  removeServiceChain(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "removeServiceChain": "string"
  }
}

Services

Set Block Control

Set a control value on a block connection

id:

string

ID of the connection

value:

string

New value of the Control

Example

Request Content-Types: application/json

Query

mutation setControlValue($id: ID!, $value: String!){
  setControlValue(id: $id, value: $value){
    id
    displayName
    value
    options
  }
}

Variables

{
  "id": "string",
  "value": "string"
}

Try it now

200 OK

Successful operation

type

BlockControl

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "setControlValue": {
      "id": "string",
      "displayName": "string",
      "value": "string",
      "options": [
        "string"
      ]
    }
  }
}

Settings

Fetch the settings for the currently logged in user

Settings

Fetch settings

Example

Request Content-Types: application/json

Query

query settings{
  settings{
  }
}

Try it now

200 OK

Successful operation

type

Settings

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "settings": {}
  }
}

Settings

Set default map position

Set the default position and zoom of the map shown in the dashboard

center:

LatLngInput

Default (Lat, Lng) to initially center the map at

zoom:

integer

Default initial zoom level

Example

Request Content-Types: application/json

Query

mutation setDefaultMapPosition($center: LatLngInput!, $zoom: Int!){
  setDefaultMapPosition(center: $center, zoom: $zoom){
    zoom
  }
}

Variables

{
  "center": {
    "lat": "number",
    "lng": "number"
  },
  "zoom": "integer"
}

Try it now

200 OK

Successful operation

type

MapSettings

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "setDefaultMapPosition": {
      "zoom": "integer"
    }
  }
}

Settings

Set block repo

Set credentials for block chart repo

repo:

RepoInput

(no description)

Example

Request Content-Types: application/json

Query

mutation setBlockRepo($repo: RepoInput!){
  setBlockRepo(repo: $repo)
}

Variables

{
  "repo": {
    "url": "string",
    "username": "string",
    "password": "string"
  }
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "setBlockRepo": "string"
  }
}

Settings

Set provision repo

Set credentials for provision chart repo

repo:

RepoInput

(no description)

Example

Request Content-Types: application/json

Query

mutation setProvisionRepo($repo: RepoInput!){
  setProvisionRepo(repo: $repo)
}

Variables

{
  "repo": {
    "url": "string",
    "username": "string",
    "password": "string"
  }
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "setProvisionRepo": "string"
  }
}

Settings

Set template repo

Set credentials for template chart repo

repo:

RepoInput

(no description)

Example

Request Content-Types: application/json

Query

mutation setTemplateRepo($repo: RepoInput!){
  setTemplateRepo(repo: $repo)
}

Variables

{
  "repo": {
    "url": "string",
    "username": "string",
    "password": "string"
  }
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "setTemplateRepo": "string"
  }
}

Settings

Custom Completions

Example

Request Content-Types: application/json

Query

query customCompletions{
  customCompletions
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "customCompletions": "string"
  }
}

Settings

Set Custom Completions

Set custom completions for an org

completions:

string

JSON-serialised completions

Example

Request Content-Types: application/json

Query

mutation setCustomCompletions($completions: String!){
  setCustomCompletions(completions: $completions)
}

Variables

{
  "completions": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "setCustomCompletions": "string"
  }
}

Sites and Organizations

View and update information related to a site/organization

Sites and Organizations

Organization

Fetch an organization by ID

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query org($id: ID!){
  org(id: $id){
    id
    displayName
    description
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

Org

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "org": {
      "id": "string",
      "displayName": "string",
      "description": "string"
    }
  }
}

Sites and Organizations

Site

Fetch a site by ID

id:

string

(no description)

Example

Request Content-Types: application/json

Query

query site($id: ID!){
  site(id: $id){
    id
    displayName
    description
  }
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

Site

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "site": {
      "id": "string",
      "displayName": "string",
      "description": "string"
    }
  }
}

Sites and Organizations

Create site

Create a new site

site:

SiteInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createSite($site: SiteInput!){
  createSite(site: $site){
    id
    displayName
    description
  }
}

Variables

{
  "site": {
    "displayName": "string",
    "description": "string",
    "ancestors": [
      "object"
    ]
  }
}

Try it now

200 OK

Successful operation

type

Site

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createSite": {
      "id": "string",
      "displayName": "string",
      "description": "string"
    }
  }
}

Sites and Organizations

Edit site

Modify an existing site

id:

string

(no description)

site:

SiteInput

(no description)

Example

Request Content-Types: application/json

Query

mutation editSite($id: ID!, $site: SiteInput!){
  editSite(id: $id, site: $site){
    id
    displayName
    description
  }
}

Variables

{
  "id": "string",
  "site": {
    "displayName": "string",
    "description": "string",
    "ancestors": [
      "object"
    ]
  }
}

Try it now

200 OK

Successful operation

type

Site

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "editSite": {
      "id": "string",
      "displayName": "string",
      "description": "string"
    }
  }
}

Sites and Organizations

Remove site

Remove a site

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation removeSite($id: ID!){
  removeSite(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "removeSite": "string"
  }
}

Sites and Organizations

Create org

Create a new org

org:

OrgInput

(no description)

Example

Request Content-Types: application/json

Query

mutation createOrg($org: OrgInput!){
  createOrg(org: $org){
    id
    displayName
    description
  }
}

Variables

{
  "org": {
    "displayName": "string",
    "description": "string"
  }
}

Try it now

200 OK

Successful operation

type

Org

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createOrg": {
      "id": "string",
      "displayName": "string",
      "description": "string"
    }
  }
}

Sites and Organizations

Edit org

Modify an existing org

id:

string

(no description)

org:

OrgInput

(no description)

Example

Request Content-Types: application/json

Query

mutation editOrg($id: ID!, $org: OrgInput!){
  editOrg(id: $id, org: $org){
    id
    displayName
    description
  }
}

Variables

{
  "id": "string",
  "org": {
    "displayName": "string",
    "description": "string"
  }
}

Try it now

200 OK

Successful operation

type

Org

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "editOrg": {
      "id": "string",
      "displayName": "string",
      "description": "string"
    }
  }
}

Sites and Organizations

Remove org

Remove an org

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation removeOrg($id: ID!){
  removeOrg(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "removeOrg": "string"
  }
}

Users

Manage dashboard user accounts

Users

List all users

group:

string

Filter by Group ID

Example

Request Content-Types: application/json

Query

query users($group: ID){
  users(group: $group){
    id
    name
    email
  }
}

Variables

{
  "group": "string"
}

Try it now

200 OK

Successful operation

type

User

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "users": [
      {
        "id": "string",
        "name": "string",
        "email": "string"
      }
    ]
  }
}

Users

Create user

name:

string

(no description)

email:

string

(no description)

org:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation createUser($name: String!, $email: String!, $org: ID!){
  createUser(name: $name, email: $email, org: $org){
  }
}

Variables

{
  "name": "string",
  "email": "string",
  "org": "string"
}

Try it now

200 OK

Successful operation

type

CreateUserResponse

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "createUser": {}
  }
}

Users

Remove user

Remove a user

id:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation removeUser($id: ID!){
  removeUser(id: $id)
}

Variables

{
  "id": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "removeUser": "string"
  }
}

Users

Recruit user

Recruit an existing user to another org

user:

string

(no description)

org:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation recruitUser($user: ID!, $org: ID!){
  recruitUser(user: $user, org: $org){
    id
    name
    email
  }
}

Variables

{
  "user": "string",
  "org": "string"
}

Try it now

200 OK

Successful operation

type

User

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "recruitUser": {
      "id": "string",
      "name": "string",
      "email": "string"
    }
  }
}

Users

Dismiss user

Remove a user from a specific org

userId:

string

(no description)

orgId:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation dismissUser($userId: ID!, $orgId: ID!){
  dismissUser(userId: $userId, orgId: $orgId)
}

Variables

{
  "userId": "string",
  "orgId": "string"
}

Try it now

200 OK

Successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "dismissUser": "string"
  }
}

Users

Generate recovery link

Generate a link for a user to reset their credentials

user:

string

(no description)

Example

Request Content-Types: application/json

Query

mutation generateRecoveryLink($user: ID!){
  generateRecoveryLink(user: $user){
    link
    expiresAt
  }
}

Variables

{
  "user": "string"
}

Try it now

200 OK

Successful operation

type

RecoveryLink

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "generateRecoveryLink": {
      "link": "string"
    }
  }
}

Schema Definitions

ApiTokens: object

id: object
return: ID arguments: object
googleMaps: object
return: String arguments: object
mapbox: object
return: String arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "googleMaps": {
    "return": "string",
    "arguments": {}
  },
  "mapbox": {
    "return": "string",
    "arguments": {}
  }
}

AuditLogEntity: object

id: object
return: ID arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  }
}

AuditLogEntityType: string

object UNKNOWN
object CHAIN
object DEVICE
object PROVISION
object SITE
object ORG
object USER
object CLOUDRESOURCE
object FEDERATIONGUEST
object FEDERATIONHOST
object BLOCKCHART

AuditLogEntry: object

time: object
return: Time arguments: object
type: object
return: AuditLogEventType arguments: object
reason: object
return: String arguments: object
message: object
return: String arguments: object
entityType: object
return: AuditLogEntityType arguments: object
entity: object
return: AuditLogEntity arguments: object
user: object
return: User arguments: object
org: object
return: Org arguments: object

Example

{
  "time": {
    "return": "object",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "reason": {
    "return": "string",
    "arguments": {}
  },
  "message": {
    "return": "string",
    "arguments": {}
  },
  "entityType": {
    "return": "string",
    "arguments": {}
  },
  "entity": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "user": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "email": {
        "return": "string",
        "arguments": {}
      },
      "orgs": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "displayName": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "sites": {
              "return": [
                {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "displayName": {
                    "return": "string",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "org": {
                    "return": {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "displayName": {
                        "return": "string",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "sites": {
                        "return": [
                          {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "displayName": {}
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

AuditLogEntryEdge: object

node: object
return: AuditLogEntry arguments: object
cursor: object
return: String arguments: object

Example

{
  "node": {
    "return": {
      "time": {
        "return": "object",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      },
      "reason": {
        "return": "string",
        "arguments": {}
      },
      "message": {
        "return": "string",
        "arguments": {}
      },
      "entityType": {
        "return": "string",
        "arguments": {}
      },
      "entity": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "user": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "email": {
            "return": "string",
            "arguments": {}
          },
          "orgs": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "displayName": {
                  "return": "string",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "sites": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "displayName": {
                        "return": "string",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "org": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "displayName": {
                            "return": "string",
                            "arguments": {}
                          },
                          "description": {
                            "return": "string",
                            "arguments": {}
                          },
                          "sites": {
                            "return": [
                              {
                                "id": {}
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

AuditLogEventType: string

object UNKNOWN
object NORMAL
object WARNING

AuditLogKind: string

object CHAIN
object BLOCK
object DEVICE

AuditLogs: object

totalCount: object
return: Int arguments: object
edges: object
return: AuditLogEntryEdge arguments: object
pageInfo: object
return: PageInfo arguments: object

Example

{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "edges": {
    "return": [
      {
        "node": {
          "return": {
            "time": {
              "return": "object",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "reason": {
              "return": "string",
              "arguments": {}
            },
            "message": {
              "return": "string",
              "arguments": {}
            },
            "entityType": {
              "return": "string",
              "arguments": {}
            },
            "entity": {
              "return": {
                "id": {
                  "return": "object",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "user": {
              "return": {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "email": {
                  "return": "string",
                  "arguments": {}
                },
                "orgs": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "displayName": {
                        "return": "string",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "sites": {
                        "return": [
                          {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "displayName": {
                              "return": "string",
                              "arguments": {}
                            },
                            "description": {
                              "return": "string",
                              "arguments": {}
                            },
                            "org": {
                              "return": {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "displayName": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "description": {}
                              }
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}

BBox: object

nw: LatLngInput: Northwesternmost point of a bounding box
se: LatLngInput: Southeasternmost point of a bounding box

Example

{
  "nw": {
    "lat": "number",
    "lng": "number"
  },
  "se": {
    "lat": "number",
    "lng": "number"
  }
}

Block: object

id: object
return: ID arguments: object
chainRevision: object
return: Int arguments: object
displayName: object
return: String arguments: object
values: object
return: String arguments: object
selectedVersion: object
return: String arguments: object
chart: object
return: BlockChart arguments: object
status: object
return: Status arguments: object
connections: object
return: Connection arguments: object
logEndpoints: object
return: LogEndpoint arguments: object
logEndpoint: object
return: LogEndpoint arguments: object id: ID hash: String
resources: object
return: OktoResource arguments: object
controls: object
return: BlockControl arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "chainRevision": {
    "return": "number",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "values": {
    "return": "string",
    "arguments": {}
  },
  "selectedVersion": {
    "return": "string",
    "arguments": {}
  },
  "chart": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "version": {
        "return": "string",
        "arguments": {}
      },
      "availableVersions": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "categories": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "chartYaml": {
        "return": "string",
        "arguments": {}
      },
      "displayName": {
        "return": "string",
        "arguments": {}
      },
      "valuesSchema": {
        "return": "string",
        "arguments": {}
      },
      "overridesYaml": {
        "return": "string",
        "arguments": {}
      },
      "vendor": {
        "return": "string",
        "arguments": {}
      },
      "logoUrl": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "connections": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "category": {
          "return": "string",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "kind": {
          "return": "string",
          "arguments": {}
        },
        "name": {}
      }
    ]
  }
}

BlockChart: object

id: object: Chart digest, used for client caching. Cannot fetch by ID!
return: ID arguments: object
name: object: Unique chart name in Helm repo. name field in Chart.yaml
return: String arguments: object
version: object: version field in Chart.yaml
return: String arguments: object
availableVersions: object
return: String arguments: object
categories: object: keywords field in Chart.yaml
return: String arguments: object
description: object: description field in Chart.yaml
return: String arguments: object
chartYaml: object: full contents of Chart.yaml
return: String arguments: object
displayName: object: annotations.displayName in Chart.yaml
return: String arguments: object
valuesSchema: object: values.json.schema parsed as json string. Introspected from overrides if file does not exist. Includes values as defaults
return: String arguments: object
overridesYaml: object: overrides.yaml, values.yaml if it doesn't exist
return: String arguments: object
vendor: object: annotations.vendor field in Chart.yaml
return: String arguments: object
logoUrl: object: icon field in Chart.yaml
return: String arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "version": {
    "return": "string",
    "arguments": {}
  },
  "availableVersions": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "categories": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "chartYaml": {
    "return": "string",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "valuesSchema": {
    "return": "string",
    "arguments": {}
  },
  "overridesYaml": {
    "return": "string",
    "arguments": {}
  },
  "vendor": {
    "return": "string",
    "arguments": {}
  },
  "logoUrl": {
    "return": "string",
    "arguments": {}
  }
}

BlockChartType: string

object SERVICE
object MEC

BlockConnectionInput: object

name: String: Field name
connId: ID: Connection ID

Example

{
  "name": "string",
  "connId": "object"
}

BlockControl: object

id: object
return: ID arguments: object
displayName: object
return: String arguments: object
value: object
return: String arguments: object
options: object
return: String arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  },
  "options": {
    "return": [
      "string"
    ],
    "arguments": {}
  }
}

BlockInput: object

id: ID: ID of a previously-deployed block to update. Providing this parameter implies an update to an existing block, whereas inputs with no ID will be treated as new blocks.
displayName: String: Display name of the block
blockChartName: String: Chart name in Helm repo
blockChartVersion: String: Chart semantic version number
values: String: Override values in YAML format

Example

{
  "id": "object",
  "displayName": "string",
  "blockChartName": "string",
  "blockChartVersion": "string",
  "values": "string"
}

Boolean: boolean

The Boolean scalar type represents true or false.

Example

boolean

ChartConfigField: object

label: object
return: String arguments: object
value: object
return: String arguments: object
type: object
return: String arguments: object
required: object
return: Boolean arguments: object
redacted: object
return: Boolean arguments: object

Example

{
  "label": {
    "return": "string",
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "required": {
    "return": "boolean",
    "arguments": {}
  },
  "redacted": {
    "return": "boolean",
    "arguments": {}
  }
}

ChartKey: object

name: object: Unique chart name in Helm repo. name field in Chart.yaml
return: String arguments: object
version: object: version field in Chart.yaml
return: String arguments: object

Example

{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "version": {
    "return": "string",
    "arguments": {}
  }
}

ChartKeyInput: object

name: String: Unique chart name in Helm repo. name field in Chart.yaml
version: String: version field in Chart.yaml

Example

{
  "name": "string",
  "version": "string"
}

ChartMetaInput: object

name: String
version: String
displayName: String
vendor: String
description: String
iconUrl: String
categories: String

Example

{
  "name": "string",
  "version": "string",
  "displayName": "string",
  "vendor": "string",
  "description": "string",
  "iconUrl": "string",
  "categories": [
    "string"
  ]
}

ClientCredentials: object

clientId: object
return: String arguments: object
clientSecret: object
return: String arguments: object

Example

{
  "clientId": {
    "return": "string",
    "arguments": {}
  },
  "clientSecret": {
    "return": "string",
    "arguments": {}
  }
}

CloudResourceChart: object

name: object: Unique chart name in Helm repo. name field in Chart.yaml
return: String arguments: object
version: object: version field in Chart.yaml
return: String arguments: object
originalConfig: object: This comes from the values yaml that come from the original chart
return: ValuesField arguments: object
latestConfig: object: These are the last deployed values
return: ValuesField arguments: object

Example

{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "version": {
    "return": "string",
    "arguments": {}
  },
  "originalConfig": {
    "return": [
      {
        "label": {
          "return": "string",
          "arguments": {}
        },
        "value": {
          "return": "string",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        },
        "required": {
          "return": "boolean",
          "arguments": {}
        },
        "redacted": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "latestConfig": {
    "return": [
      {
        "label": {
          "return": "string",
          "arguments": {}
        },
        "value": {
          "return": "string",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        },
        "required": {
          "return": "boolean",
          "arguments": {}
        },
        "redacted": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

CloudResourceChartListing: object

key: object
return: ChartKey arguments: object
displayName: object
return: String arguments: object

Example

{
  "key": {
    "return": {
      "name": {
        "return": "string",
        "arguments": {}
      },
      "version": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  }
}

CloudResourceConfigFieldInput: object

label: String
value: String

Example

{
  "label": "string",
  "value": "string"
}

CloudResourceInput: object

chartName: String: Chart name in Helm repo
chartVersion: String: Chart semantic version number
controllerSite: ID: Site selector for controller
config: CloudResourceConfigFieldInput: Array of key value pairs for the Device configuration
displayName: String: Display name of device to be shown in the UI
position: LatLngInput: Geographical position of device
deviceSite: ID: Site that device belongs to

Example

{
  "chartName": "string",
  "chartVersion": "string",
  "controllerSite": "object",
  "config": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "displayName": "string",
  "position": {
    "lat": "number",
    "lng": "number"
  },
  "deviceSite": "object"
}

ConfigFieldInput: object

label: String
value: String

Example

{
  "label": "string",
  "value": "string"
}

Connection: object

id: object
return: ID arguments: object
category: object
return: String arguments: object
description: object
return: String arguments: object
kind: object
return: String arguments: object
name: object
return: String arguments: object
source: object
return: String arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "category": {
    "return": "string",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "kind": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "source": {
    "return": "string",
    "arguments": {}
  }
}

ConnectionInput: object

category: String
kind: String
name: String
source: String

Example

{
  "category": "string",
  "kind": "string",
  "name": "string",
  "source": "string"
}

CreateMecSiteInput: object

displayName: String
description: String
cluster: ID
chart: ChartKeyInput
tags: String
config: ConfigFieldInput: Array of key value pairs passed into mecsite block as value overrides

Example

{
  "displayName": "string",
  "description": "string",
  "cluster": "object",
  "chart": {
    "name": "string",
    "version": "string"
  },
  "tags": [
    "string"
  ],
  "config": [
    {
      "label": "string",
      "value": "string"
    }
  ]
}

CreateUserResponse: object

user: object
return: User arguments: object
error: object
return: Error arguments: object

Example

{
  "user": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "email": {
        "return": "string",
        "arguments": {}
      },
      "orgs": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "displayName": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "sites": {
              "return": [
                {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "displayName": {
                    "return": "string",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "org": {
                    "return": {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "displayName": {
                        "return": "string",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "sites": {
                        "return": [
                          {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "displayName": {
                              "return": "string",
                              "arguments": {}
                            },
                            "description": {
                              "return": "string",
                              "arguments": {}
                            },
                            "org": {
                              "return": {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "displayName": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "description": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "sites": {
                                  "return": [
                                    {
                                      "id": {}
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

DeployTargetInput: object

master: ID
host: ID

Example

{
  "master": "object",
  "host": "object"
}

Device: object

id: object
return: ID arguments: object
tags: object
return: String arguments: object
displayName: object
return: String arguments: object
position: object
return: LatLng arguments: object
specs: object
return: String arguments: object
status: object
return: DeviceStatus arguments: object
progress: object
return: Progress arguments: object
connections: object
return: Connection arguments: object
site: object
return: String arguments: object
metadata: object
return: String arguments: object
telemetryUrl: object
return: TelemetryUrl arguments: object
cloudResourceChart: object
return: CloudResourceChart arguments: object
deviceType: object
return: String arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "tags": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "position": {
    "return": {
      "lat": {
        "return": "number",
        "arguments": {}
      },
      "lng": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "specs": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "progress": {
    "return": {
      "step": {
        "return": "number",
        "arguments": {}
      },
      "goal": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "connections": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "category": {
          "return": "string",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "kind": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "source": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "site": {
    "return": "string",
    "arguments": {}
  },
  "metadata": {
    "return": "string",
    "arguments": {}
  },
  "telemetryUrl": {
    "return": [
      {
        "displayName": {
          "return": "string",
          "arguments": {}
        },
        "url": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "cloudResourceChart": {
    "return": {
      "name": {}
    }
  }
}

DeviceInput: object

Properties of a new device to be registered

connections: ConnectionInput: List of connections (e.g. video streams, APIs) available on the device
tags: String: List of tags that describe the device
displayName: String: Display name of device to be shown in the UI
kubeconfig: String: Configuration file used to connect to Kubenetes Control Plane of a Cloudlet
managedNamespace: String: Optional namespace for a Cloudlet
position: LatLngInput: Geographical position of device
site: String: Site that device belongs to

Example

{
  "connections": [
    {
      "category": "string",
      "kind": "string",
      "name": "string",
      "source": "string"
    }
  ],
  "tags": [
    "string"
  ],
  "displayName": "string",
  "kubeconfig": "string",
  "managedNamespace": "string",
  "position": {
    "lat": "number",
    "lng": "number"
  },
  "site": "string"
}

DeviceStatus: string

object UNKNOWN
object READY
object DEPLOYING
object ERROR

DevicesResult: object

devices: object
return: Device arguments: object
hits: object
return: Int arguments: object

Example

{
  "devices": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "tags": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "displayName": {
          "return": "string",
          "arguments": {}
        },
        "position": {
          "return": {
            "lat": {
              "return": "number",
              "arguments": {}
            },
            "lng": {
              "return": "number",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "specs": {
          "return": "string",
          "arguments": {}
        },
        "status": {
          "return": "string",
          "arguments": {}
        },
        "progress": {
          "return": {
            "step": {
              "return": "number",
              "arguments": {}
            },
            "goal": {
              "return": "number",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "connections": {
          "return": [
            {
              "id": {
                "return": "object",
                "arguments": {}
              },
              "category": {
                "return": "string",
                "arguments": {}
              },
              "description": {
                "return": "string",
                "arguments": {}
              },
              "kind": {
                "return": "string",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "source": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "site": {
          "return": "string",
          "arguments": {}
        },
        "metadata": {
          "return": "string",
          "arguments": {}
        },
        "telemetryUrl": {
          "return": [
            {
              "displayName": {
                "return": "string",
                "arguments": {}
              },
              "url": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        }
      }
    ]
  }
}

EditConnectionInput: object

id: ID
category: String
kind: String
name: String
source: String

Example

{
  "id": "object",
  "category": "string",
  "kind": "string",
  "name": "string",
  "source": "string"
}

EditDeviceInput: object

displayName: String: Display name of device to be shown in the UI
tags: String: List of tags that describe the device
position: LatLngInput: Geographical position of device
connections: EditConnectionInput
deletedConnections: ID
site: String: Site that device belongs to

Example

{
  "displayName": "string",
  "tags": [
    "string"
  ],
  "position": {
    "lat": "number",
    "lng": "number"
  },
  "connections": [
    {
      "id": "object",
      "category": "string",
      "kind": "string",
      "name": "string",
      "source": "string"
    }
  ],
  "deletedConnections": [
    "object"
  ],
  "site": "string"
}

EditFederationGuestInput: object

id: ID
countryCode: String
mcc: String
mncs: String

Example

{
  "id": "object",
  "countryCode": "string",
  "mcc": "string",
  "mncs": [
    "string"
  ]
}

EditFederationHostInput: object

id: ID
federationName: String
operatorName: String
countryCode: String
mcc: String
mncs: String
hostUrl: String
siteId: String
clientId: String
clientSecret: String

Example

{
  "id": "object",
  "federationName": "string",
  "operatorName": "string",
  "countryCode": "string",
  "mcc": "string",
  "mncs": [
    "string"
  ],
  "hostUrl": "string",
  "siteId": "string",
  "clientId": "string",
  "clientSecret": "string"
}

EntityType: string

object UNKNOWN
object BLOCK
object DEVICE

Error: object

code: object
return: Int arguments: object
message: object
return: String arguments: object

Example

{
  "code": {
    "return": "number",
    "arguments": {}
  },
  "message": {
    "return": "string",
    "arguments": {}
  }
}

EventLogEntry: object

time: object
return: Time arguments: object
type: object
return: EventLogType arguments: object
reason: object
return: String arguments: object
message: object
return: String arguments: object
resource: object
return: OktoResource arguments: object

Example

{
  "time": {
    "return": "object",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "reason": {
    "return": "string",
    "arguments": {}
  },
  "message": {
    "return": "string",
    "arguments": {}
  },
  "resource": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "kind": {
        "return": "string",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "namespace": {
        "return": "string",
        "arguments": {}
      },
      "manifest": {
        "return": "string",
        "arguments": {}
      },
      "logs": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

EventLogEntryEdge: object

node: object
return: EventLogEntry arguments: object
cursor: object
return: String arguments: object

Example

{
  "node": {
    "return": {
      "time": {
        "return": "object",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      },
      "reason": {
        "return": "string",
        "arguments": {}
      },
      "message": {
        "return": "string",
        "arguments": {}
      },
      "resource": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "kind": {
            "return": "string",
            "arguments": {}
          },
          "status": {
            "return": "string",
            "arguments": {}
          },
          "namespace": {
            "return": "string",
            "arguments": {}
          },
          "manifest": {
            "return": "string",
            "arguments": {}
          },
          "logs": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "cursor": {
    "return": "string",
    "arguments": {}
  }
}

EventLogType: string

object UNKNOWN
object NORMAL
object WARNING

EventLogs: object

totalCount: object
return: Int arguments: object
edges: object
return: EventLogEntryEdge arguments: object
pageInfo: object
return: PageInfo arguments: object

Example

{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "edges": {
    "return": [
      {
        "node": {
          "return": {
            "time": {
              "return": "object",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "reason": {
              "return": "string",
              "arguments": {}
            },
            "message": {
              "return": "string",
              "arguments": {}
            },
            "resource": {
              "return": {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "kind": {
                  "return": "string",
                  "arguments": {}
                },
                "status": {
                  "return": "string",
                  "arguments": {}
                },
                "namespace": {
                  "return": "string",
                  "arguments": {}
                },
                "manifest": {
                  "return": "string",
                  "arguments": {}
                },
                "logs": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "cursor": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      },
      "endCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

Federation: object

operatorName: object
return: String arguments: object
countryCode: object
return: String arguments: object
mcc: object
return: String arguments: object
mncs: object
return: String arguments: object
federationUrl: object
return: String arguments: object

Example

{
  "operatorName": {
    "return": "string",
    "arguments": {}
  },
  "countryCode": {
    "return": "string",
    "arguments": {}
  },
  "mcc": {
    "return": "string",
    "arguments": {}
  },
  "mncs": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "federationUrl": {
    "return": "string",
    "arguments": {}
  }
}

FederationGuest: object

id: object
return: ID arguments: object
federationName: object
return: String arguments: object
operatorName: object
return: String arguments: object
countryCode: object
return: String arguments: object
mcc: object
return: String arguments: object
mncs: object
return: String arguments: object
parentSite: object
return: String arguments: object
status: object
return: FederationPartnerStatus arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "federationName": {
    "return": "string",
    "arguments": {}
  },
  "operatorName": {
    "return": "string",
    "arguments": {}
  },
  "countryCode": {
    "return": "string",
    "arguments": {}
  },
  "mcc": {
    "return": "string",
    "arguments": {}
  },
  "mncs": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "parentSite": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  }
}

FederationGuestInput: object

federationName: String
operatorName: String
countryCode: String
mcc: String
mncs: String
parentSite: String

Example

{
  "federationName": "string",
  "operatorName": "string",
  "countryCode": "string",
  "mcc": "string",
  "mncs": [
    "string"
  ],
  "parentSite": "string"
}

FederationHost: object

id: object
return: ID arguments: object
federationName: object
return: String arguments: object
operatorName: object
return: String arguments: object
countryCode: object
return: String arguments: object
mcc: object
return: String arguments: object
mncs: object
return: String arguments: object
hostUrl: object
return: String arguments: object
siteId: object
return: String arguments: object
status: object
return: FederationPartnerStatus arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "federationName": {
    "return": "string",
    "arguments": {}
  },
  "operatorName": {
    "return": "string",
    "arguments": {}
  },
  "countryCode": {
    "return": "string",
    "arguments": {}
  },
  "mcc": {
    "return": "string",
    "arguments": {}
  },
  "mncs": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "hostUrl": {
    "return": "string",
    "arguments": {}
  },
  "siteId": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  }
}

FederationHostInput: object

federationName: String
operatorName: String
countryCode: String
mcc: String
mncs: String
hostUrl: String
siteId: String
clientId: String
clientSecret: String

Example

{
  "federationName": "string",
  "operatorName": "string",
  "countryCode": "string",
  "mcc": "string",
  "mncs": [
    "string"
  ],
  "hostUrl": "string",
  "siteId": "string",
  "clientId": "string",
  "clientSecret": "string"
}

FederationInput: object

operatorName: String
countryCode: String
mcc: String
mncs: String
federationUrl: String

Example

{
  "operatorName": "string",
  "countryCode": "string",
  "mcc": "string",
  "mncs": [
    "string"
  ],
  "federationUrl": "string"
}

FederationPartnerStatus: string

object ENABLED
object DISABLED

FieldParam: object

name: object
return: String arguments: object
value: object
return: String arguments: object

Example

{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  }
}

Float: number

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

number

GenericAuditLogEntity: object

id: object
return: ID arguments: object
name: object
return: String arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  }
}

ID: object

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

object

InfraBlockChart: object

name: object: Unique chart name in Helm repo. name field in Chart.yaml
return: String arguments: object
version: object: version field in Chart.yaml
return: String arguments: object
type: object
return: InfraChartType arguments: object
overridesYaml: object: nearbyone/overrides.yaml if present, values.yaml if not
return: String arguments: object
valuesSchema: object: contents of values.schema.json, with defaults set to values from values.yaml
return: String arguments: object
config: object
return: ChartConfigField arguments: object

Example

{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "version": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "overridesYaml": {
    "return": "string",
    "arguments": {}
  },
  "valuesSchema": {
    "return": "string",
    "arguments": {}
  },
  "config": {
    "return": [
      {
        "label": {
          "return": "string",
          "arguments": {}
        },
        "value": {
          "return": "string",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        },
        "required": {
          "return": "boolean",
          "arguments": {}
        },
        "redacted": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

InfraChartType: string

object UNKNOWN
object MN_NETWORK
object MN_CORE_MANAGER
object MN_RAN_MANAGER
object MN_CORE
object MN_GNB
object MEC_SITE
object IP_POOL
object SUBNET

Int: number

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

number

LatLng: object

lat: object
return: Float arguments: object
lng: object
return: Float arguments: object

Example

{
  "lat": {
    "return": "number",
    "arguments": {}
  },
  "lng": {
    "return": "number",
    "arguments": {}
  }
}

LatLngInput: object

lat: Float: Degrees latitude
lng: Float: Degrees longitude

Example

{
  "lat": "number",
  "lng": "number"
}

LogEndpoint: object

id: object
return: ID arguments: object
hash: object: Hash of the log endpoint data hidden to the client
return: String arguments: object
description: object
return: String arguments: object
name: object
return: String arguments: object
sources: object
return: LogSource arguments: object
source: object
return: LogSource arguments: object id: String

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "hash": {
    "return": "string",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "sources": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "logs": {
          "return": [
            {
              "offset": {
                "return": "number",
                "arguments": {}
              },
              "log": {
                "return": "string",
                "arguments": {}
              },
              "metadata": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {
            "size": "number",
            "before": "boolean",
            "offset": "number",
            "logFilterSimpleQuery": "string"
          }
        }
      }
    ],
    "arguments": {}
  },
  "source": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "logs": {
        "return": [
          {
            "offset": {
              "return": "number",
              "arguments": {}
            },
            "log": {
              "return": "string",
              "arguments": {}
            },
            "metadata": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {
          "size": "number",
          "before": "boolean",
          "offset": "number",
          "logFilterSimpleQuery": "string"
        }
      }
    },
    "arguments": {
      "id": "string"
    }
  }
}

LogEntry: object

offset: object
return: Int arguments: object
log: object
return: String arguments: object
metadata: object
return: String arguments: object

Example

{
  "offset": {
    "return": "number",
    "arguments": {}
  },
  "log": {
    "return": "string",
    "arguments": {}
  },
  "metadata": {
    "return": "string",
    "arguments": {}
  }
}

LogEventType: string

object NORMAL
object WARNING

LogSource: object

id: object
return: String arguments: object
name: object
return: String arguments: object
logs: object
return: LogEntry arguments: object size: Int before: Boolean offset: Int logFilterSimpleQuery: String

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "logs": {
    "return": [
      {
        "offset": {
          "return": "number",
          "arguments": {}
        },
        "log": {
          "return": "string",
          "arguments": {}
        },
        "metadata": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {
      "size": "number",
      "before": "boolean",
      "offset": "number",
      "logFilterSimpleQuery": "string"
    }
  }
}

MapSettings: object

center: object
return: LatLng arguments: object
zoom: object
return: Int arguments: object

Example

{
  "center": {
    "return": {
      "lat": {
        "return": "number",
        "arguments": {}
      },
      "lng": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "zoom": {
    "return": "number",
    "arguments": {}
  }
}

MecSite: object

id: object
return: ID arguments: object
displayName: object
return: String arguments: object
description: object
return: String arguments: object
cluster: object
return: Device arguments: object
chart: object
return: ChartKey arguments: object
tags: object
return: String arguments: object
status: object
return: Status arguments: object
liveData: object
return: Connection arguments: object org: ID Optional org to search connection labels by. If empty, defaults to org from user context

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "cluster": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "tags": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "displayName": {
        "return": "string",
        "arguments": {}
      },
      "position": {
        "return": {
          "lat": {
            "return": "number",
            "arguments": {}
          },
          "lng": {
            "return": "number",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "specs": {
        "return": "string",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "progress": {
        "return": {
          "step": {
            "return": "number",
            "arguments": {}
          },
          "goal": {
            "return": "number",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "connections": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "category": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "kind": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "source": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "site": {
        "return": "string",
        "arguments": {}
      },
      "metadata": {
        "return": "string",
        "arguments": {}
      },
      "telemetryUrl": {
        "return": [
          null
        ]
      }
    }
  }
}

NewFederationGuest: object

federationGuest: object
return: FederationGuest arguments: object
clientCredentials: object
return: ClientCredentials arguments: object

Example

{
  "federationGuest": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "federationName": {
        "return": "string",
        "arguments": {}
      },
      "operatorName": {
        "return": "string",
        "arguments": {}
      },
      "countryCode": {
        "return": "string",
        "arguments": {}
      },
      "mcc": {
        "return": "string",
        "arguments": {}
      },
      "mncs": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "parentSite": {
        "return": "string",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "clientCredentials": {
    "return": {
      "clientId": {
        "return": "string",
        "arguments": {}
      },
      "clientSecret": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

OktoResource: object

id: object
return: ID arguments: object
name: object
return: String arguments: object
kind: object
return: String arguments: object
status: object
return: Status arguments: object
namespace: object
return: String arguments: object
manifest: object
return: String arguments: object
logs: object
return: String arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "kind": {
    "return": "string",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "namespace": {
    "return": "string",
    "arguments": {}
  },
  "manifest": {
    "return": "string",
    "arguments": {}
  },
  "logs": {
    "return": "string",
    "arguments": {}
  }
}

Org: object

id: object
return: ID arguments: object
displayName: object
return: String arguments: object
description: object
return: String arguments: object
sites: object
return: Site arguments: object
users: object
return: User arguments: object
devices: object: fetch the devices of this site and all descendent sites
return: DevicesResult arguments: object
federation: object
return: Federation arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "sites": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "displayName": {
          "return": "string",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "org": {
          "return": {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "displayName": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "sites": {
              "return": [
                {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "displayName": {
                    "return": "string",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "org": {
                    "return": {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "displayName": {
                        "return": "string",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "sites": {
                        "return": [
                          {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "displayName": {
                              "return": "string",
                              "arguments": {}
                            },
                            "description": {
                              "return": "string",
                              "arguments": {}
                            },
                            "org": {
                              "return": {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "displayName": {}
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

OrgInput: object

displayName: String
description: String

Example

{
  "displayName": "string",
  "description": "string"
}

PageInfo: object

hasNextPage: object
return: Boolean arguments: object
hasPreviousPage: object
return: Boolean arguments: object
startCursor: object
return: String arguments: object
endCursor: object
return: String arguments: object

Example

{
  "hasNextPage": {
    "return": "boolean",
    "arguments": {}
  },
  "hasPreviousPage": {
    "return": "boolean",
    "arguments": {}
  },
  "startCursor": {
    "return": "string",
    "arguments": {}
  },
  "endCursor": {
    "return": "string",
    "arguments": {}
  }
}

PaginationInput: object

beforeCursor: String
afterCursor: String
pageSize: Int

Example

{
  "beforeCursor": "string",
  "afterCursor": "string",
  "pageSize": "number"
}

Progress: object

step: object
return: Int arguments: object
goal: object
return: Int arguments: object

Example

{
  "step": {
    "return": "number",
    "arguments": {}
  },
  "goal": {
    "return": "number",
    "arguments": {}
  }
}

Provision: object

id: object
return: ID arguments: object
displayName: object
return: String arguments: object
siteTreeItem: object
return: SiteTreeItem arguments: object
chart: object
return: ProvisionChart arguments: object
inventory: object
return: String arguments: object
phases: object
return: ProvisionPhase arguments: object
lastUpdated: object
return: Time arguments: object
status: object
return: DeviceStatus arguments: object
resources: object
return: OktoResource arguments: object
logEndpoints: object
return: LogEndpoint arguments: object
logEndpoint: object
return: LogEndpoint arguments: object id: ID hash: String

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "siteTreeItem": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "displayName": {
        "return": "string",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "sites": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "displayName": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "org": {
              "return": {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "displayName": {
                  "return": "string",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "sites": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "displayName": {
                        "return": "string",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "org": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "displayName": {
                            "return": "string",
                            "arguments": {}
                          },
                          "description": {
                            "return": "string",
                            "arguments": {}
                          },
                          "sites": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "displayName": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "description": {}
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

ProvisionChart: object

name: object: Unique chart name in Helm repo. name field in Chart.yaml
return: String arguments: object
version: object: version field in Chart.yaml
return: String arguments: object
phases: object: phases parsed from values.yaml e.g. baremetal software etc.
return: ProvisionPhase arguments: object
availableVersions: object
return: String arguments: object

Example

{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "version": {
    "return": "string",
    "arguments": {}
  },
  "phases": {
    "return": [
      {
        "name": {
          "return": "string",
          "arguments": {}
        },
        "values": {
          "return": "string",
          "arguments": {}
        },
        "enabled": {
          "return": "boolean",
          "arguments": {}
        },
        "progress": {
          "return": {
            "step": {
              "return": "number",
              "arguments": {}
            },
            "goal": {
              "return": "number",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "resources": {
          "return": [
            {
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "kind": {
                "return": "string",
                "arguments": {}
              },
              "status": {
                "return": "string",
                "arguments": {}
              },
              "namespace": {
                "return": "string",
                "arguments": {}
              },
              "manifest": {
                "return": "string",
                "arguments": {}
              },
              "logs": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "availableVersions": {
    "return": [
      "string"
    ],
    "arguments": {}
  }
}

ProvisionInput: object

chartName: String: Chart name in Helm repo
chartVersion: String: Chart semantic version number
provisionerSite: ID: Site selector for Provisioner block deployment
provisionInventory: String
displayName: String: Display name of device to be shown in the UI
position: LatLngInput: Geographical position of device
site: ID: Site that device belongs to

Example

{
  "chartName": "string",
  "chartVersion": "string",
  "provisionerSite": "object",
  "provisionInventory": "string",
  "displayName": "string",
  "position": {
    "lat": "number",
    "lng": "number"
  },
  "site": "object"
}

ProvisionPhase: object

name: object
return: String arguments: object
values: object
return: String arguments: object
enabled: object
return: Boolean arguments: object
progress: object
return: Progress arguments: object
resources: object
return: OktoResource arguments: object

Example

{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "values": {
    "return": "string",
    "arguments": {}
  },
  "enabled": {
    "return": "boolean",
    "arguments": {}
  },
  "progress": {
    "return": {
      "step": {
        "return": "number",
        "arguments": {}
      },
      "goal": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "resources": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "kind": {
          "return": "string",
          "arguments": {}
        },
        "status": {
          "return": "string",
          "arguments": {}
        },
        "namespace": {
          "return": "string",
          "arguments": {}
        },
        "manifest": {
          "return": "string",
          "arguments": {}
        },
        "logs": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

PublishBlockChartInput: object

templateName: String
templateVersion: String
chartMeta: ChartMetaInput
valuesYaml: String
overridesYaml: String

Example

{
  "templateName": "string",
  "templateVersion": "string",
  "chartMeta": {
    "name": "string",
    "version": "string",
    "displayName": "string",
    "vendor": "string",
    "description": "string",
    "iconUrl": "string",
    "categories": [
      "string"
    ]
  },
  "valuesYaml": "string",
  "overridesYaml": "string"
}

RecoveryLink: object

link: object
return: String arguments: object
expiresAt: object
return: Time arguments: object

Example

{
  "link": {
    "return": "string",
    "arguments": {}
  },
  "expiresAt": {
    "return": "object",
    "arguments": {}
  }
}

RepoInput: object

url: String
username: String
password: String

Example

{
  "url": "string",
  "username": "string",
  "password": "string"
}

RepoSettings: object

url: object
return: String arguments: object
credentialsSet: object
return: Boolean arguments: object

Example

{
  "url": {
    "return": "string",
    "arguments": {}
  },
  "credentialsSet": {
    "return": "boolean",
    "arguments": {}
  }
}

ServiceChain: object

id: object
return: ID arguments: object
revision: object
return: Int arguments: object
name: object
return: String arguments: object
blocks: object
return: Block arguments: object
history: object
return: ServiceChain arguments: object revision: Int
status: object
return: Status arguments: object
org: object
return: String arguments: object
owner: object
return: String arguments: object
createdAt: object
return: Time arguments: object
mecSite: object
return: MecSite arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "revision": {
    "return": "number",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "blocks": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "chainRevision": {
          "return": "number",
          "arguments": {}
        },
        "displayName": {
          "return": "string",
          "arguments": {}
        },
        "values": {
          "return": "string",
          "arguments": {}
        },
        "selectedVersion": {
          "return": "string",
          "arguments": {}
        },
        "chart": {
          "return": {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "version": {
              "return": "string",
              "arguments": {}
            },
            "availableVersions": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "categories": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "chartYaml": {
              "return": "string",
              "arguments": {}
            },
            "displayName": {
              "return": "string",
              "arguments": {}
            },
            "valuesSchema": {
              "return": "string",
              "arguments": {}
            },
            "overridesYaml": {
              "return": "string",
              "arguments": {}
            },
            "vendor": {
              "return": "string",
              "arguments": {}
            },
            "logoUrl": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "status": {
          "return": "string",
          "arguments": {}
        },
        "connections": {
          "return": [
            {
              "id": {}
            }
          ]
        }
      }
    ]
  }
}

ServiceParam: object

name: object
return: String arguments: object
type: object
return: String arguments: object

Example

{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

SetFederationGuestStatusInput: object

id: ID
status: FederationPartnerStatus

Example

{
  "id": "object",
  "status": "string"
}

Settings: object

map: object
return: MapSettings arguments: object
block: object
return: RepoSettings arguments: object
provision: object
return: RepoSettings arguments: object
template: object
return: RepoSettings arguments: object

Example

{
  "map": {
    "return": {
      "center": {
        "return": {
          "lat": {
            "return": "number",
            "arguments": {}
          },
          "lng": {
            "return": "number",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "zoom": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "block": {
    "return": {
      "url": {
        "return": "string",
        "arguments": {}
      },
      "credentialsSet": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "provision": {
    "return": {
      "url": {
        "return": "string",
        "arguments": {}
      },
      "credentialsSet": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "template": {
    "return": {
      "url": {
        "return": "string",
        "arguments": {}
      },
      "credentialsSet": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

Site: object

id: object
return: ID arguments: object
displayName: object
return: String arguments: object
description: object
return: String arguments: object
org: object
return: Org arguments: object
ancestors: object
return: Site arguments: object
sites: object
return: Site arguments: object
devices: object: fetch the devices of this site and all descendent sites
return: DevicesResult arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "org": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "displayName": {
        "return": "string",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "sites": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "displayName": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "org": {
              "return": {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "displayName": {
                  "return": "string",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "sites": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "displayName": {
                        "return": "string",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "org": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "displayName": {
                            "return": "string",
                            "arguments": {}
                          },
                          "description": {
                            "return": "string",
                            "arguments": {}
                          },
                          "sites": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "displayName": {}
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SiteInput: object

displayName: String
description: String
ancestors: ID

Example

{
  "displayName": "string",
  "description": "string",
  "ancestors": [
    "object"
  ]
}

SiteTreeItem: object

id: object
return: ID arguments: object
displayName: object
return: String arguments: object
description: object
return: String arguments: object
sites: object
return: Site arguments: object
devices: object
return: DevicesResult arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "sites": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "displayName": {
          "return": "string",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "org": {
          "return": {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "displayName": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "sites": {
              "return": [
                {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "displayName": {
                    "return": "string",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "org": {
                    "return": {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "displayName": {
                        "return": "string",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "sites": {
                        "return": [
                          {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "displayName": {
                              "return": "string",
                              "arguments": {}
                            },
                            "description": {
                              "return": "string",
                              "arguments": {}
                            },
                            "org": {
                              "return": {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "displayName": {}
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

Status: string

object IN_SYNC
object PROGRESSING
object DELETING
object ERROR
object UNKNOWN
object PENDING

String: string

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Tag: object

key: object
return: String arguments: object
inc: object
return: Boolean arguments: object

Example

{
  "key": {
    "return": "string",
    "arguments": {}
  },
  "inc": {
    "return": "boolean",
    "arguments": {}
  }
}

TagInput: object

key: String
inc: Boolean

Example

{
  "key": "string",
  "inc": "boolean"
}

TelemetryUrl: object

displayName: object
return: String arguments: object
url: object
return: String arguments: object

Example

{
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "url": {
    "return": "string",
    "arguments": {}
  }
}

TemplateChart: object

id: object: Chart digest, used for client caching. Cannot fetch by ID!
return: ID arguments: object
name: object: Unique chart name in Helm repo. name field in Chart.yaml
return: String arguments: object
version: object: version field in Chart.yaml
return: String arguments: object
availableVersions: object
return: String arguments: object
categories: object: keywords field in Chart.yaml
return: String arguments: object
description: object: description field in Chart.yaml
return: String arguments: object
chartYaml: object: full contents of Chart.yaml
return: String arguments: object
displayName: object: annotations.displayName in Chart.yaml
return: String arguments: object
valuesYaml: object: values.yaml
return: String arguments: object
overridesYaml: object: overrides.yaml, values.yaml if it doesn't exist
return: String arguments: object
vendor: object: annotations.vendor field in Chart.yaml
return: String arguments: object
logoUrl: object: icon field in Chart.yaml
return: String arguments: object

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "version": {
    "return": "string",
    "arguments": {}
  },
  "availableVersions": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "categories": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "chartYaml": {
    "return": "string",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "valuesYaml": {
    "return": "string",
    "arguments": {}
  },
  "overridesYaml": {
    "return": "string",
    "arguments": {}
  },
  "vendor": {
    "return": "string",
    "arguments": {}
  },
  "logoUrl": {
    "return": "string",
    "arguments": {}
  }
}

Time: object

An ISO 8601 formatted Date and Time

Example

object

UpdateCloudResourceInput: object

id: ID
blockVersion: String
displayName: String
providerConfig: CloudResourceConfigFieldInput
position: LatLngInput
deviceSite: ID

Example

{
  "id": "object",
  "blockVersion": "string",
  "displayName": "string",
  "providerConfig": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "position": {
    "lat": "number",
    "lng": "number"
  },
  "deviceSite": "object"
}

UpdateProvisionInput: object

id: ID
displayName: String: Display name of device to be shown in the UI
position: LatLngInput: Geographical position of device
chartVersion: String: Chart semantic version number to update
provisionerSite: ID: Site selector for Provisioner block deployment to update
provisionInventory: String: Provision inventory to update

Example

{
  "id": "object",
  "displayName": "string",
  "position": {
    "lat": "number",
    "lng": "number"
  },
  "chartVersion": "string",
  "provisionerSite": "object",
  "provisionInventory": "string"
}

User: object

id: object
return: ID arguments: object
name: object
return: String arguments: object
email: object
return: String arguments: object
orgs: object
return: Org arguments: object org: ID optional filter to return only a specific org

Example

{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "email": {
    "return": "string",
    "arguments": {}
  },
  "orgs": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "displayName": {
          "return": "string",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "sites": {
          "return": [
            {
              "id": {
                "return": "object",
                "arguments": {}
              },
              "displayName": {
                "return": "string",
                "arguments": {}
              },
              "description": {
                "return": "string",
                "arguments": {}
              },
              "org": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "displayName": {
                    "return": "string",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "sites": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "displayName": {
                          "return": "string",
                          "arguments": {}
                        },
                        "description": {
                          "return": "string",
                          "arguments": {}
                        },
                        "org": {
                          "return": {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "displayName": {
                              "return": "string",
                              "arguments": {}
                            },
                            "description": {
                              "return": "string",
                              "arguments": {}
                            },
                            "sites": {
                              "return": [
                                {
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "displayName": {}
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

ValuesField: object

label: object
return: String arguments: object
value: object
return: String arguments: object
type: object
return: String arguments: object
required: object
return: Boolean arguments: object
redacted: object
return: Boolean arguments: object

Example

{
  "label": {
    "return": "string",
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "required": {
    "return": "boolean",
    "arguments": {}
  },
  "redacted": {
    "return": "boolean",
    "arguments": {}
  }
}

Version: object

app: object
return: String arguments: object
build: object
return: String arguments: object

Example

{
  "app": {
    "return": "string",
    "arguments": {}
  },
  "build": {
    "return": "string",
    "arguments": {}
  }
}

Documentation by DociQL