API docs by Redocly

Network Optix Device API (1.0.1)

Download OpenAPI specification:Download

The Scailable Device API handles managing of the Edge Devices.

What can you do with this API

With the calls in this API devices can be registered and the settings for these devices can be managed.

In the Admin Cloud the devices can be grouped and setting can be remotely read and changed.

The private endpoints in the Admin and IPC sections are used in the internal admin tools. These are not visible in the public documentation.

Quick start

Browse devices by sending a GET request to /devices and use query parameters to search specific devices.

Get all available devcie groups by sending a GET request to /groups and then get the devices in a specific group with a GET request to /devices with the group as a query parameter.

Use a POST request to /devices to add a new device.

Technical environment

The Device API is part of the Scailable Cloud and handles the management of devices.

System

[admin] Return state information

[Admin] Return state information.

Time-out set to 10s.

Responses

Response samples

Content type
application/json
{ }

Plugin unauthenticated self-register

Plugin unauthenticated self-register.

Time-out set to 10s.

Request Body schema: application/json
ServerId
required
string <uuid>

Identifier for server

Source
object or null

of type map

SystemId
required
string <uuid>

Identifier for system

Responses

Request samples

Content type
application/json
{
  • "ServerId": "542c5d7f-e13a-493f-863d-563287923a2f",
  • "Source": { },
  • "SystemId": "8be1b147-4346-48ff-8868-a1ea78cf78de"
}

Response samples

Content type
application/json
{
  • "Key": "string",
  • "ServerAdmin": "string",
  • "SiteId": "2ee62ea7-ea8b-4a01-be17-6f02722940c2",
  • "SystemAdmin": "string",
  • "SystemId": "8be1b147-4346-48ff-8868-a1ea78cf78de"
}

Plugin authenticated configure

Plugin authenticated configure.

Time-out set to 10s.

path Parameters
nxid
required
any

Use reset-id

Request Body schema: application/json
AuthenticationKey
required
string
Devices
required
Array of strings <uuid>
ServerId
required
string <uuid>

Identifier for server

Responses

Request samples

Content type
application/json
{
  • "AuthenticationKey": "string",
  • "Devices": [
    ],
  • "ServerId": "542c5d7f-e13a-493f-863d-563287923a2f"
}

Response samples

Content type
application/json
{
  • "AuthorizationInvalid": true,
  • "BackendMessage": "string",
  • "Email": "string",
  • "Field": {
    },
  • "Message": "string",
  • "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}

Return a system

Return a system.

Time-out set to 5s.

path Parameters
nxid
required
any

Use system-id

Responses

Response samples

Content type
application/json
{
  • "Cdb": {
    },
  • "Customization": "string",
  • "Name": "string",
  • "NxID": "5dbc598a-f218-41fd-a782-df6afd3e95ca",
  • "Permissions": {
    },
  • "StateOfHealth": "string",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "V2": {
    },
  • "V3": {
    },
  • "Version": "string"
}

Return aggegrated run-time, pre- and postprocessors information

Return aggegrated run-time, pre- and postprocessors information.

Time-out set to 5s.

path Parameters
nxid
required
any

Use system-id

Responses

Response samples

Content type
application/json
{ }

Put pipelines to multiple devices

Put pipelines to multiple devices.

Time-out set to 10s.

path Parameters
nxid
required
any

Use system-id

Request Body schema: application/json
Devices
required
Array of strings <uuid>
Functions
required
Array of strings <uuid>
Pipelines
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "Devices": [
    ],
  • "Functions": [
    ],
  • "Pipelines": [
    ]
}

Response samples

Content type
application/json
{
  • "AuthorizationInvalid": true,
  • "BackendMessage": "string",
  • "Email": "string",
  • "Field": {
    },
  • "Message": "string",
  • "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}

Return a list of systems

Return a list of systems.

Time-out set to 10s.

query Parameters
Offset
integer

Number of items to skip from beginning of list (base 0)

Limit
integer

Number of items to return

OrderBy
string
Enum: "-Version" "Name" "UpdatedAt" "InsertedAt"

Order the list by these fields. Add a '-' in front of the field to reverse sort and to sort on multiple fields separate them by a comma.

StateOfHealth
string

filter by stateofhealth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return a list of online systems

Return a list of online systems.

Time-out set to 10s.

query Parameters
Offset
integer

Number of items to skip from beginning of list (base 0)

Limit
integer

Number of items to return

OrderBy
string
Enum: "-Version" "Name" "UpdatedAt" "InsertedAt"

Order the list by these fields. Add a '-' in front of the field to reverse sort and to sort on multiple fields separate them by a comma.

StateOfHealth
string

filter by stateofhealth

Responses

Response samples

Content type
application/json
{ }

Admin

[admin] Return various statistics

[Admin] Return various statistics.

Time-out set to 10s.

Responses

Response samples

Content type
application/json
{ }

K8s

Return pod-information

Return pod-information.

Time-out set to 5s.

Responses

Response samples

Content type
application/json
{
  • "Hostname": "string",
  • "IPS": [
    ]
}

Return state information

Return state information.

Time-out set to 5s.

Responses

Response samples

Content type
application/json
{ }

Listen

Listen to events

Listen to events.

Time-out set to 15m0s.

Responses

Response samples

Content type
application/json
{
  • "Message": "string"
}

Request token for listening

Request token for listening.

Time-out set to 30m0s.

Responses

Response samples

Content type
application/json
{ }

Cloud

Return the online status of the service

Return the online status of the service.

Responses

Response samples

Content type
application/json
{
  • "Online": true,
  • "Services": { }
}

Device

Return a system device

Return a system device.

Time-out set to 30s.

path Parameters
nxid
required
any

Use system-id

nxid2
required
any

Use device-id

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "NxID": "5dbc598a-f218-41fd-a782-df6afd3e95ca",
  • "Parameters": { },
  • "Server": {
    },
  • "System": {
    },
  • "V2": {
    },
  • "V3": {
    }
}

Get a list of available pipelines for a device. Assumes the /reset/ endpoint is used at least once for this server.

Get a list of available pipelines for a device. Assumes the /reset/ endpoint is used at least once for this server.

Time-out set to 30s.

path Parameters
nxid
required
any

Use system-id

nxid2
required
any

Use device-id

Responses

Response samples

Content type
application/json
[
  • { }
]

Delete a model from a device

Delete a model from a device.

Time-out set to 10s.

path Parameters
nxid
required
any

Use system-id

nxid2
required
any

Use device-id

uuid
required
any

Use function uuid

Responses

Response samples

Content type
application/json
{
  • "AuthorizationInvalid": true,
  • "BackendMessage": "string",
  • "Email": "string",
  • "Field": {
    },
  • "Message": "string",
  • "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}

Replace a model on a device

Replace a model on a device.

Time-out set to 10s.

path Parameters
nxid
required
any

Use system-id

nxid2
required
any

Use device-id

uuid
required
any

Use function uuid

Request Body schema: application/json
object (PostDeviceFunctionsRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "AuthorizationInvalid": true,
  • "BackendMessage": "string",
  • "Email": "string",
  • "Field": {
    },
  • "Message": "string",
  • "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}

Add a new model to a device

Add a new model to a device.

Time-out set to 10s.

path Parameters
nxid
required
any

Use system-id

nxid2
required
any

Use device-id

Request Body schema: application/json
object (PostDeviceFunctionsRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "AuthorizationInvalid": true,
  • "BackendMessage": "string",
  • "Email": "string",
  • "Field": {
    },
  • "Message": "string",
  • "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}

Update the pipeline for this device

Update the pipeline for this device.

Time-out set to 10s.

path Parameters
nxid
required
any

Use system-id

nxid2
required
any

Use device-id

Request Body schema: application/json
Functions
required
Array of strings <uuid>
Pipelines
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "Functions": [
    ],
  • "Pipelines": [
    ]
}

Response samples

Content type
application/json
{
  • "AuthorizationInvalid": true,
  • "BackendMessage": "string",
  • "Email": "string",
  • "Field": {
    },
  • "Message": "string",
  • "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}

Return devices of a system

Return devices of a system.

Time-out set to 10s.

path Parameters
nxid
required
any

Use system-id

query Parameters
Offset
integer

Number of items to skip from beginning of list (base 0)

Limit
integer

Number of items to return

OrderBy
string
Enum: "System" "Server" "Name" "PluginVersion" "CustomGroupId"

Order the list by these fields. Add a '-' in front of the field to reverse sort and to sort on multiple fields separate them by a comma.

ServerNxID
any

filter by servernxid

CustomGroupId
string

filter by customgroupid

ServerStatus
string

filter by serverstatus

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post new models to a selection of devices

Post new models to a selection of devices.

Time-out set to 10s.

path Parameters
nxid
required
any

Use system-id

Request Body schema: application/json
object (PostDevicesFunctionsRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "AuthorizationInvalid": true,
  • "BackendMessage": "string",
  • "Email": "string",
  • "Field": {
    },
  • "Message": "string",
  • "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}

Replace new models to a selection of devices

Replace new models to a selection of devices.

Time-out set to 10s.

path Parameters
nxid
required
any

Use system-id

Request Body schema: application/json
object (PutDevicesFunctionsRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "AuthorizationInvalid": true,
  • "BackendMessage": "string",
  • "Email": "string",
  • "Field": {
    },
  • "Message": "string",
  • "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}

Server

Return a system server

Return a system server.

Time-out set to 5s.

path Parameters
nxid
required
any

Use system-id

nxid2
required
any

Use server-id

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "NxID": "5dbc598a-f218-41fd-a782-df6afd3e95ca",
  • "Parameters": { },
  • "PluginAvailable": true,
  • "Postprocessors": { },
  • "Preprocessors": { },
  • "RuntimeArchitectures": [
    ],
  • "Status": "string",
  • "Supports": {
    },
  • "System": {
    },
  • "V2Server": {
    },
  • "V3Server": {
    },
  • "Version": "string"
}

Return servers of a system

Return servers of a system.

Time-out set to 10s.

path Parameters
nxid
required
any

Use system-id

Responses

Response samples

Content type
application/json
[
  • {
    }
]