Download OpenAPI specification:Download
The Scailable Device API handles managing of the Edge Devices.
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.
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.
The Device API is part of the Scailable Cloud and handles the management of devices.
Get a function in nxAI/models format.
Time-out set to 5s.
uuid required | any Use function uuid |
{- "Documentation": "string",
- "Downloads": [
- {
- "LastModified": "2019-08-24T14:15:22Z",
- "MD5": "string",
- "RuntimeArchitecture": "string",
- "Size": 0,
- "Url": "string"
}
], - "InputDriver": "string",
- "InputDriverDetails": { },
- "Name": "string",
- "NamedInput": { },
- "NamedOutput": { },
- "OutputDriver": "string",
- "OutputDriverDetails": { },
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
Plugin unauthenticated self-register.
Time-out set to 10s.
ServerId required | string <uuid> Identifier for server |
Source | object or null of type map |
SystemId required | string <uuid> Identifier for system |
{- "ServerId": "542c5d7f-e13a-493f-863d-563287923a2f",
- "Source": { },
- "SystemId": "8be1b147-4346-48ff-8868-a1ea78cf78de"
}
{- "Key": "string",
- "ServerAdmin": "string",
- "ServerId": "542c5d7f-e13a-493f-863d-563287923a2f",
- "SystemId": "8be1b147-4346-48ff-8868-a1ea78cf78de"
}
Delete a new model from a server.
Time-out set to 10s. Requires an authenticated user.
nxid required | any Use nxid |
nxid2 required | any Use nxid2 |
uuid required | any Use function uuid |
{- "AuthorizationInvalid": true,
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Replace a model on a server.
Time-out set to 10s. Requires an authenticated user.
nxid required | any Use nxid |
nxid2 required | any Use nxid2 |
uuid required | any Use function uuid |
{ }
{- "AuthorizationInvalid": true,
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Add a new model to a server.
Time-out set to 10s. Requires an authenticated user.
nxid required | any Use nxid |
nxid2 required | any Use nxid2 |
{ }
{- "AuthorizationInvalid": true,
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Delete a license to a server.
Time-out set to 10s. Requires an authenticated user.
nxid required | any Use nxid |
nxid2 required | any Use nxid2 |
{- "AuthorizationInvalid": true,
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Add a license to a server.
Time-out set to 10s. Requires an authenticated user.
nxid required | any Use nxid |
nxid2 required | any Use nxid2 |
{- "AuthorizationInvalid": true,
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Update settings for a server.
Time-out set to 10s. Requires an authenticated user.
nxid required | any Use nxid |
nxid2 required | any Use nxid2 |
{- "AuthorizationInvalid": true,
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Post new models to a selection of servers.
Time-out set to 10s. Requires an authenticated user.
nxid required | any Use nxid |
{ }
{- "AuthorizationInvalid": true,
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Post new models to a selection of servers.
Time-out set to 10s. Requires an authenticated user.
nxid required | any Use nxid |
{ }
{- "AuthorizationInvalid": true,
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Return a list of systems.
Time-out set to 10s. Requires an authenticated user.
Offset | integer Number of items to skip from beginning of list (base 0) |
Limit | integer Number of items to return |
OrderBy | string Enum: "Name" "Version" "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. |
[- { }
]