Skip to main content
API docs by Redocly

Peridio Device API (1.0.0)

Download OpenAPI specification:Download

License: Peridio

The Peridio Device API facilitates device-based operations within Peridio Core.

Devices

get device me

Returns information about the device identified by the request's authentication.

Expandable

This endpoint has an expandable response. See expanding responses.

Authorizations:
MutualTLS
query Parameters
expand
Array of strings

See expanding responses.

Expandable Fields

For more information on each field, reference the response.

  • cohort

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get device update

This functionality has been superceded by get update.

Returns information regarding whether an update is available via a deployment.

If an update is available, additional information describing the update is returned including a presigned URL to acquire the update.

Authorizations:
MutualTLS
query Parameters
preflight
boolean
Default: false

When false

The request will count towards update attempts. firmware_url in the response will be set to a presigned URL.

When true

The request will not count towards update attempts. firmware_url in the response will be null.

For example, one may use true to check if an update is available when you don't yet intend to consume the update so that a device does not rack up a number of incomplete updates and eventually get quarantined (pending the failure configuration set on the relevant deployment).

header Parameters
x-peridio-uuid
required
string <uuid> (firmware-uuid)

The UUID of the currently active firmware on the device.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

get update

Returns information regarding whether an update is available via a release.

Expandable

This endpoint has an expandable response. By default, only the status field is returned. See expanding responses.

Authorizations:
MutualTLS
query Parameters
expand
Array of strings

See expanding responses.

Expandable Fields

For more information on each field, reference the response.

  • bundle
  • release
  • manifest
    • artifact
    • artifact_version
    • url
header Parameters
peridio-release-prn
string (prn)
Example: prn:1:a1ed0c4e-f222-4bb3-89dc-48320018875d:release:e4bf3021-b8d7-42d5-a1bd-52121427ebd0

See release resolution. Informs Peridio of what release is currently active on the device. The preference should always be to supply this header with a valid value. If you supply this header, you should not supply the peridio-release-version header.

peridio-release-version
string (release-version)
Example: 1.0.0

See release resolution. This header is only used in exceptional cases when you don't have a PRN to supply via peridio-release-prn. In that case, you may supply this header and you should not supply the peridio-release-prn header.

Responses

Response samples

Content type
application/json
{
  • "status": "update",
  • "release": {
    },
  • "bundle": {
    },
  • "manifest": [
    ]
}