The following headers may be supplied when requesting any route.
For critical context about how Peridio Cloud will interpret these headers, refer to the device integration section of the bundle distribution reference.
For context regarding deprecated headers, see deployment eligibility.
key | value | description |
---|---|---|
peridio-release-prn | A release PRN. | Informs Peridio of what release is currently active on the device. |
peridio-bundle-prn | A bundle PRN. | Informs Peridio of what bundle is currently active on the device. |
peridio-release-version | A release version. | Informs Peridio of what release version is representative of the device's state. |
x-peridio-architecture | A firmware architecture. | Deprecated. See deployment eligibility. The architecture of the device's currently active firmware. When supplying any x-peridio header, you should supply all x-peridio headers. |
x-peridio-platform | A firmware platform. | Deprecated. See deployment eligibility. The platform of the device's currently active firmware. When supplying any x-peridio header, you should supply all x-peridio headers. |
x-peridio-product | A firmware product. | Deprecated. See deployment eligibility. The product of the device's currently active firmware. When supplying any x-peridio header, you should supply all x-peridio headers. |
x-peridio-uuid | A firmware UUID. | Deprecated. See deployment eligibility. The UUID of the device's currently active firmware. When supplying any x-peridio header, you should supply all x-peridio headers. |
x-peridio-version | A firmware version. | Deprecated. See deployment eligibility. The version of the device's currently active firmware. When supplying any x-peridio header, you should supply all x-peridio headers. |
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:
query Parameters
expand | Array of strings See expanding responses. Expandable Fields For more information on each field, reference the response.
|
header Parameters
peridio-release-prn | string (prn) Examples: prn:1:a1ed0c4e-f222-4bb3-89dc-48320018875d:release:e4bf3021-b8d7-42d5-a1bd-52121427ebd0 See global headers. |
peridio-release-version |
Responses
Response samples
- 200
{- "data": {
- "cohort": {
- "description": "string",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "product_prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "manifest": [
- {
- "artifact": {
- "custom_metadata": { },
- "description": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "artifact_version": {
- "artifact_prn": "string",
- "custom_metadata": { },
- "description": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "organization_prn": "string",
- "prn": "string",
- "version": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "binary_prn": "string",
- "hash": "string",
- "signatures": null,
- "size": 1800000,
- "target": "arm-linux-androideabi",
- "url": "string"
}
], - "identifier": "sn1234",
- "quarantined": true
}
}
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:
query Parameters
preflight | boolean Default: false When The request will count towards update attempts. When The request will not count towards update attempts. For example, one may use |
header Parameters
x-peridio-uuid required | string <uuid> (firmware-uuid) See global headers. |
peridio-release-prn | string (prn) Examples: prn:1:a1ed0c4e-f222-4bb3-89dc-48320018875d:release:e4bf3021-b8d7-42d5-a1bd-52121427ebd0 See global headers. |
peridio-release-version |
Responses
Response samples
- 200
{- "data": {
- "update_available": true,
- "firmware_url": { },
- "firmware_meta": { },
- "deployment_id": null
}
}
get update
Returns information regarding whether an update is available via a release or bundle override.
Expandable
This endpoint has an expandable response. By default, only the status
field is returned. See expanding responses.
Authorizations:
query Parameters
expand | Array of strings See expanding responses. Expandable Fields For more information on each field, reference the response.
|
header Parameters
peridio-release-prn | string (prn) Examples: prn:1:a1ed0c4e-f222-4bb3-89dc-48320018875d:release:e4bf3021-b8d7-42d5-a1bd-52121427ebd0 See global headers. |
peridio-bundle-prn | string (prn) Examples: prn:1:a1ed0c4e-f222-4bb3-89dc-48320018875d:bundle:ddd32c59-fc35-4202-a520-a4eddaa11fb3 See global headers. |
peridio-release-version |
Responses
Response samples
- 200
{- "status": "update",
- "source_type": "release",
- "release": {
- "bundle_prn": "string",
- "cohort_prn": "string",
- "description": null,
- "disabled": true,
- "name": "string",
- "next_release_prn": { },
- "organization_prn": "string",
- "phase_mode": "tags",
- "phase_tags": [
- "string"
], - "phase_type": "static",
- "phase_value": 1000000000,
- "required": true,
- "schedule_date": "2019-08-24T14:15:22Z",
- "schedule_complete": true,
- "prn": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "version": "1.0.0",
- "version_requirement": "== 1.0.0"
}, - "bundle": {
- "artifact_versions": [
- {
- "prn": "string",
- "index": 0
}
], - "name": { },
- "organization_prn": "string",
- "prn": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "custom_metadata": { },
- "manifest": [
- {
- "artifact": {
- "custom_metadata": { },
- "description": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "artifact_version": {
- "artifact_prn": "string",
- "custom_metadata": { },
- "description": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "organization_prn": "string",
- "prn": "string",
- "version": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "binary_prn": "string",
- "hash": "string",
- "signatures": null,
- "size": 1800000,
- "target": "arm-linux-androideabi",
- "url": "string"
}
]
}
List tunnels
This only returns :requested
and :open
tunnels.
For list options, we only support pagination params.
Authorizations:
query Parameters
page | string A cursor for pagination across multiple pages of results. Don't include this parameter on
the first call. Use the |
Responses
Response samples
- 200
{- "tunnels": [
- {
- "cidr_block_allowlist": [
- "10.0.0.1/16",
- "172.154.0.1/16"
], - "device_proxy_ip_address": "10.0.1.1",
- "device_proxy_port": 47539,
- "device_public_key": "Y4nCIXdpb+f3WgPi0377FDPCAfP+st82s98lTRepHEk=",
- "device_tunnel_port": 22,
- "server_proxy_ip_address": "10.0.0.1",
- "server_proxy_port": 49293,
- "server_public_key": "2+h9vwIwg/1zTW9XLFzUmiTwCRRq7mzLgDnZfWEislY=",
- "server_tunnel_ip_address": "3.82.23.99",
- "server_tunnel_port": 47532,
- "expires_at": "2019-08-24T14:15:22Z",
- "state": "requested",
- "device_prn": "prn:1:be4d30b4-de6b-47cd-85ea-a75e23fd63ef:device:b3f1f699-3bc8-4c77-bda2-b974595d5e3f",
- "organization_prn": "string",
- "prn": "prn:1:be4d30b4-de6b-47cd-85ea-a75e23fd63ef:tunnel:b3f1f699-3bc8-4c77-bda2-b974595d5e3f",
- "inserted_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "next_page": "string"
}
Configure a tunnel
Configures a tunnel with device networking data.
If successful, the tunnel's state will be open
. Only tunnels with a state of requested
can be configured.
Authorizations:
Request Body schema: application/jsonrequired
tunnel_prn required | string (tunnel-prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
cidr_blocks required | Array of strings (cidrs) A set of CIDR blocks that the device has available for use with remote access. The device's wireguard peer IP as well as wireguard interface IP will be choosen from this set so it must contain at least two distinct IPs. |
port_ranges required | Array of strings (port-ranges) A set of port ranges that the device has available for use with remote access. The device can use this to constrain the pool of ports from which Peridio will choose the wireguard server listen port, that is, the port on which the server is listening for wireguard UDP traffic. |
device_proxy_port required | number The port on which the device is listening for wireguard UDP traffic. |
device_public_key required | string The device's public key for wireguard. |
Responses
Request samples
- Payload
{- "tunnel_prn": "prn:1:be4d30b4-de6b-47cd-85ea-a75e23fd63ef:tunnel:b3f1f699-3bc8-4c77-bda2-b974595d5e3f",
- "cidr_blocks": [
- "10.0.0.1/16",
- "172.154.0.1/16"
], - "port_ranges": [
- "string"
], - "device_proxy_port": 53000,
- "device_public_key": "Y4nCIXdpb+f3WgPi0377FDPCAfP+st82s98lTRepHEk="
}
Response samples
- 200
{- "data": {
- "cidr_block_allowlist": [
- "10.0.0.1/16",
- "172.154.0.1/16"
], - "device_proxy_ip_address": "10.0.1.1",
- "device_proxy_port": 47539,
- "device_public_key": "Y4nCIXdpb+f3WgPi0377FDPCAfP+st82s98lTRepHEk=",
- "device_tunnel_port": 22,
- "server_proxy_ip_address": "10.0.0.1",
- "server_proxy_port": 49293,
- "server_public_key": "2+h9vwIwg/1zTW9XLFzUmiTwCRRq7mzLgDnZfWEislY=",
- "server_tunnel_ip_address": "3.82.23.99",
- "server_tunnel_port": 47532,
- "expires_at": "2019-08-24T14:15:22Z",
- "state": "open",
- "device_prn": "prn:1:be4d30b4-de6b-47cd-85ea-a75e23fd63ef:device:b3f1f699-3bc8-4c77-bda2-b974595d5e3f",
- "organization_prn": "string",
- "prn": "prn:1:be4d30b4-de6b-47cd-85ea-a75e23fd63ef:tunnel:b3f1f699-3bc8-4c77-bda2-b974595d5e3f",
- "inserted_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Update a tunnel
Update a tunnel currently only allows changing a tunnel to a closed state.
Authorizations:
path Parameters
tunnel_prn required | string (tunnel-prn) Example: prn:1:be4d30b4-de6b-47cd-85ea-a75e23fd63ef:tunnel:b3f1f699-3bc8-4c77-bda2-b974595d5e3f Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Request Body schema: application/jsonrequired
state | string The state we want the tunnel to be in. Only accepts "closed". |
Responses
Request samples
- Payload
{- "state": "closed"
}
Response samples
- 200
{- "data": {
- "cidr_block_allowlist": [
- "10.0.0.1/16",
- "172.154.0.1/16"
], - "device_proxy_ip_address": "10.0.1.1",
- "device_proxy_port": 47539,
- "device_public_key": "Y4nCIXdpb+f3WgPi0377FDPCAfP+st82s98lTRepHEk=",
- "device_tunnel_port": 22,
- "server_proxy_ip_address": "10.0.0.1",
- "server_proxy_port": 49293,
- "server_public_key": "2+h9vwIwg/1zTW9XLFzUmiTwCRRq7mzLgDnZfWEislY=",
- "server_tunnel_ip_address": "3.82.23.99",
- "server_tunnel_port": 47532,
- "expires_at": "2019-08-24T14:15:22Z",
- "state": "closed",
- "device_prn": "prn:1:be4d30b4-de6b-47cd-85ea-a75e23fd63ef:device:b3f1f699-3bc8-4c77-bda2-b974595d5e3f",
- "organization_prn": "string",
- "prn": "prn:1:be4d30b4-de6b-47cd-85ea-a75e23fd63ef:tunnel:b3f1f699-3bc8-4c77-bda2-b974595d5e3f",
- "inserted_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}