v1

latestOpenAPI 3.0.0Apache 2.02026-07-177719.4 KB
access

Create a device access request.

Endpoint to create (device) access requests. The response contains the href to poll for the status of the request.

post/access/requests

Request body

clientIdstring required

Client identifier.

descriptionstring required

Description of device.

Example request

{
  "clientId": "1234-45653-343453",
  "description": "humidity sensor"
}

Response

Request status

state'PENDING' | 'FAILED' | 'COMPLETED' required
hrefstring

Path where the status of the request can be checked.

Example response

{
  "href": "/signalk/v1/requests/358b5f32-76bf-4b33-8b23-10a330827185"
}
All 7 operations