Cambrionix connect
Developers
Authentication API

Computers

Add, remove and list Computers in a your organization.

Get Computers

GET

/computer

Get all computers

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

Responses

200

Response schema with result and metadata

object
_metadataobject

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

resultComputer[]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/computer" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Add Computer

POST

/computer

Add a new computer

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

Request body

object
detailobject
idstringrequired

The unique identifier for a computer

namestringrequired
connectionobjectrequired
locationobject
metadatamap of any

Responses

200

Response schema with result and metadata

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/computer" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "detail": {
    "cpu": {
      "arch": "string",
      "cores": 0,
      "features": [],
      "name": "string"
    },
    "os": "string"
  },
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "connection": {
    "status": "disconnected",
    "updated": 0
  },
  "location": {
    "id": "string"
  }
}'

Add or Update Computer

PUT

/computer

Add a new computer or update an existing one

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

Request body

object
detailobject
idstringrequired

The unique identifier for a computer

namestringrequired
connectionobjectrequired
locationobject
metadatamap of any

Responses

200

Response schema with result and metadata

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 PUT "https://connect.cambrionix.com/api/v1/computer" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "detail": {
    "cpu": {
      "arch": "string",
      "cores": 0,
      "features": [],
      "name": "string"
    },
    "os": "string"
  },
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "connection": {
    "status": "disconnected",
    "updated": 0
  },
  "location": {
    "id": "string"
  }
}'

Update Computer

PATCH

/computer

Update a computer by id

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

Request body

object
detailobject
idstringrequired

The unique identifier for a computer

locationobject
metadatamap of any
namestring

Responses

200

Response schema with result and metadata

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 PATCH "https://connect.cambrionix.com/api/v1/computer" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "detail": {
    "cpu": {
      "arch": "string",
      "cores": 0,
      "features": [],
      "name": "string"
    },
    "os": "string"
  },
  "id": "00000000-0000-0000-0000-000000000000",
  "location": {
    "id": "string"
  },
  "name": "string"
}'

Delete Computer

DELETE

/computer

Delete a computer by id

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

Request body

object
idstringrequired

The unique identifier for a computer

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/computer" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "00000000-0000-0000-0000-000000000000"
}'

Get Computers

GET

/computers

List the organization's registered computers: name, OS and CPU, connection status, location, and the local services each one runs (with their service ids).

Requires a bearer access token for this API with the Organization.Computer.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

Response schema with result and metadata

object
_metadataobject

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

resultComputer[]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/computers" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Get Computer

GET

/computers/{computerId}

Get one registered computer (name, OS and CPU, connection status, local services) by id.

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

Parameters

computerIdstringpathrequired

The unique identifier for a computer

Responses

200

Response schema with result and metadata

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 GET "https://connect.cambrionix.com/api/v1/computers/{computerId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Add or Update Computer

PUT

/computers/{computerId}

Add a new computer or update an existing one

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

Parameters

computerIdstringpathrequired

The unique identifier for a computer

Request body

object
detailobject
namestringrequired
connectionobjectrequired
locationobject
metadatamap of any

Responses

200

Response schema with result and metadata

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 PUT "https://connect.cambrionix.com/api/v1/computers/{computerId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "detail": {
    "cpu": {
      "arch": "string",
      "cores": 0,
      "features": [],
      "name": "string"
    },
    "os": "string"
  },
  "name": "string",
  "connection": {
    "status": "disconnected",
    "updated": 0
  },
  "location": {
    "id": "string"
  }
}'

Update Computer

PATCH

/computers/{computerId}

Update a computer by id

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

Parameters

computerIdstringpathrequired

The unique identifier for a computer

Request body

object
detailobject
locationobject
metadatamap of any
namestring

Responses

200

Response schema with result and metadata

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 PATCH "https://connect.cambrionix.com/api/v1/computers/{computerId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "detail": {
    "cpu": {
      "arch": "string",
      "cores": 0,
      "features": [],
      "name": "string"
    },
    "os": "string"
  },
  "location": {
    "id": "string"
  },
  "name": "string"
}'

Delete Computer

DELETE

/computers/{computerId}

Delete a computer by id

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

Parameters

computerIdstringpathrequired

The unique identifier for a computer

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/computers/{computerId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Get Organization Computers

GET

/organizations/{organizationId}/computers

Get all computers in the given organization by organization ID

Requires a bearer access token for this API. See Authentication.

Parameters

organizationIdstringpathrequired

The Organization id.

tokenstringquery

Continuation token

limitintegerquery

Number of records to return

Responses

200

The Computers in the given organization.

object
_metadataobject

Paging details for the list.

resultComputer[]required
401

Unauthorized

object
codeintegerrequired

One of: 401

messagestringrequired

One of: "Unauthorized"

detailstringrequired
default

Error

object
codeintegerrequired

One of: 500

messagestringrequired

One of: "Unauthorized"

detailstringrequired

Try it

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