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.
|
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"
}, - "identifier": "string",
- "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) The UUID of the currently active firmware on the device. |
Responses
Response samples
- 200
{- "data": {
- "update_available": true,
- "firmware_url": { },
- "firmware_meta": { },
- "deployment_id": { }
}
}
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:
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) 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 | 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 |
Responses
Response samples
- 200
{- "status": "update",
- "release": {
- "bundle_prn": "string",
- "cohort_prn": "string",
- "description": null,
- "name": "string",
- "next_release_prn": { },
- "organization_prn": "string",
- "phase_type": "static",
- "phase_value": 100,
- "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
}
], - "organization_prn": "string",
- "prn": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "manifest": [
- {
- "artifact": {
- "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",
- "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",
- "url": "string",
- "signatures": null
}
]
}