Cambrionix connect
Developers
Authentication API

Services

Add, remove and list Services in a your organization.

Add Service

POST

/service

Add a Service to the given organization.

Requires a bearer access token for this API with the Organization.Service.Write permission. See Authentication.

Request body

one of

Option 1: one of

Option 2: object

Responses

200
object
_metadataobject

Metadata for paginated responses. This includes total count, limit, and continuation token.

resultone ofrequired
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
403

Forbidden: the token is valid but does not allow this request

object
codeintegerrequired
messagestringrequired
detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

curl -X POST "https://connect.cambrionix.com/api/v1/service" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "activated": true,
  "detail": {
    "description": "string",
    "name": "string"
  },
  "id": "string",
  "address": {
    "hostName": "string",
    "port": 0
  },
  "computer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "type": "host"
}'

Add or Update an Service

PUT

/service

Update a Service in the given organization, or add a new one if none exists.

Requires a bearer access token for this API with the Organization.Service.Write permission. See Authentication.

Request body

one of

Option 1: object

Option 2: object

Option 3: object

Responses

200
object
_metadataobject

Metadata for paginated responses. This includes total count, limit, and continuation token.

resultone ofrequired
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
403

Forbidden: the token is valid but does not allow this request

object
codeintegerrequired
messagestringrequired
detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

curl -X PUT "https://connect.cambrionix.com/api/v1/service" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "activated": true,
  "detail": {
    "description": "string",
    "name": "string"
  },
  "entity": {
    "id": "string"
  },
  "id": "string",
  "address": {
    "hostName": "string",
    "port": 0
  },
  "computer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "type": "host",
  "organization": {
    "id": "string",
    "name": "string"
  },
  "secret": "string"
}'

Update Service

PATCH

/service

Update a Service in the given organization.

Requires a bearer access token for this API with the Organization.Service.Write permission. See Authentication.

Request body

object
activatedboolean
addressobject
detailobject
idstringrequired

Responses

200
object
_metadataobject

Metadata for paginated responses. This includes total count, limit, and continuation token.

resultone ofrequired
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
403

Forbidden: the token is valid but does not allow this request

object
codeintegerrequired
messagestringrequired
detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

curl -X PATCH "https://connect.cambrionix.com/api/v1/service" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "activated": true,
  "address": {
    "hostName": "string",
    "port": 0
  },
  "detail": {
    "description": "string",
    "name": "string"
  },
  "id": "string"
}'

Get Services

GET

/services

List the organization's services: local Hub API, device, recorder, relay and workflow services on each computer, plus custom and remote API services.

Requires a bearer access token for this API with the Organization.Service.Read permission. See Authentication.

Parameters

filterstringquery

Returns only the items that match, written as (path::operator::value), such as (name::co::Lab). Operators are eq, co, sw, ew, gt and pr, and the case-insensitive ieq, ico, isw and iew. Combine conditions as ((a)::and::(b)) or ((a)::or::(b)).

sortstringquery

Orders the items, written as (path::asc) or (path::desc). Combine orders as ((a)::and::(b)).

limitintegerquery

The maximum number of items to return.

tokenstringquery

Returns the next page: the _metadata.continuationToken of the previous response.

Responses

200
object
_metadataobject

Metadata for paginated responses. This includes total count, limit, and continuation token.

resultone of[]required
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
403

Forbidden: the token is valid but does not allow this request

object
codeintegerrequired
messagestringrequired
detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

curl -X GET "https://connect.cambrionix.com/api/v1/services" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Get Service

GET

/services/{serviceId}

Get one organization service by id.

Requires a bearer access token for this API with the Organization.Service.Read permission. See Authentication.

Parameters

serviceIdstringpathrequired

Path parameter

Responses

200
object
_metadataobject

Metadata for paginated responses. This includes total count, limit, and continuation token.

resultone ofrequired
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
403

Forbidden: the token is valid but does not allow this request

object
codeintegerrequired
messagestringrequired
detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

curl -X GET "https://connect.cambrionix.com/api/v1/services/{serviceId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Update Service

PATCH

/services/{serviceId}

Update a Service by id.

Requires a bearer access token for this API with the Organization.Service.Write permission. See Authentication.

Parameters

serviceIdstringpathrequired

Path parameter

Request body

object
activatedboolean
addressobject
detailobject

Responses

200
object
_metadataobject

Metadata for paginated responses. This includes total count, limit, and continuation token.

resultone ofrequired
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
403

Forbidden: the token is valid but does not allow this request

object
codeintegerrequired
messagestringrequired
detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

curl -X PATCH "https://connect.cambrionix.com/api/v1/services/{serviceId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "activated": true,
  "address": {
    "hostName": "string",
    "port": 0
  },
  "detail": {
    "description": "string",
    "name": "string"
  }
}'

Delete Service

DELETE

/services/{serviceId}

Delete a Service by id.

Requires a bearer access token for this API with the Organization.Service.Delete permission. See Authentication.

Parameters

serviceIdstringpathrequired

Path parameter

Responses

200
object
_metadataobject

Metadata for paginated responses. This includes total count, limit, and continuation token.

resultobjectrequired
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
403

Forbidden: the token is valid but does not allow this request

object
codeintegerrequired
messagestringrequired
detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

curl -X DELETE "https://connect.cambrionix.com/api/v1/services/{serviceId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Create Service Secret

POST

/services/{serviceId}/secret

Create a new secret for a service. The secret is returned in the response.

Requires a bearer access token for this API with the Organization.Service.Secret.Write permission. See Authentication.

Parameters

serviceIdstringpathrequired

Path parameter

Responses

200
object
_metadataobject

Metadata for paginated responses. This includes total count, limit, and continuation token.

resultobjectrequired
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
403

Forbidden: the token is valid but does not allow this request

object
codeintegerrequired
messagestringrequired
detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

curl -X POST "https://connect.cambrionix.com/api/v1/services/{serviceId}/secret" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Get All Service Secrets

GET

/services/{serviceId}/secrets

Get all API service secrets (metadata only, not the actual secret values).

Requires a bearer access token for this API with the Organization.Service.Secret.Read permission. See Authentication.

Parameters

serviceIdstringpathrequired

Path parameter

Responses

200
object
_metadataobject

Metadata for paginated responses. This includes total count, limit, and continuation token.

resultobject[]required
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
403

Forbidden: the token is valid but does not allow this request

object
codeintegerrequired
messagestringrequired
detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

curl -X GET "https://connect.cambrionix.com/api/v1/services/{serviceId}/secrets" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Delete Service Secret

DELETE

/services/{serviceId}/secrets/{secretId}

Delete a specific service secret by ID.

Requires a bearer access token for this API with the Organization.Service.Secret.Write permission. See Authentication.

Parameters

serviceIdstringpathrequired

Path parameter

secretIdstringpathrequired

Path parameter

Responses

200
object
_metadataobject

Metadata for paginated responses. This includes total count, limit, and continuation token.

resultobjectrequired
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
403

Forbidden: the token is valid but does not allow this request

object
codeintegerrequired
messagestringrequired
detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

curl -X DELETE "https://connect.cambrionix.com/api/v1/services/{serviceId}/secrets/{secretId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"