Cambrionix connect
Developers
Hardware API

Computers

List Hardware Computers

GET

/hardware/v1/computers

List hardware sync records for the organization's computers: installed Hub API, recorder and relay versions.

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
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/hardware/v1/computers" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Get Hardware Computer

GET

/hardware/v1/computers/{computerId}

Get the hardware sync record (installed Hub API, recorder and relay versions) for one computer 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
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/hardware/v1/computers/{computerId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN"

Upsert Hardware Computer

PUT

/hardware/v1/computers/{computerId}

Create or replace Hardware computer details 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
detailsobjectrequired

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 PUT "https://connect.cambrionix.com/api/hardware/v1/computers/{computerId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "details": {
    "api": {
      "version": {
        "host": "string",
        "recorder": "string",
        "relay": "string"
      }
    }
  }
}'

Update Hardware Computer

PATCH

/hardware/v1/computers/{computerId}

Update Hardware computer details 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
detailsobject

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 PATCH "https://connect.cambrionix.com/api/hardware/v1/computers/{computerId}" \
  -H "Authorization: Bearer $CONNECT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "details": {
    "api": {
      "version": {
        "host": "string",
        "recorder": "string",
        "relay": "string"
      }
    }
  }
}'