Some endpoints are able to return more data than they normally do by expanding their response. When this is possible the endpoint will specify the expand
field and will document which fields can be expanded. The expand field takes an array of string field names that identify which fields you wish to expand.
To expand a single field, you may specify it as part of the query.
For example:
/example-endpoint?expand[]=bar
This will cause the bar
key and its value to be included in the response. If bar
itself has expandable fields, see path expands.
If the field you wish to expand is not a top level key within the response, you may specify it using dot notation.
For example:
/example-endpoint?expand[]=foo.bar
If foo
itself is not an expandable field, this will work like a normal field expand. The bar
key and its value will be included in the response nested under the foo
key.
If foo
is an expandable field, see nested expands.
To expand more than one field, you may add additional expands to the query.
For example:
/example-endpoint?expand[]=bar&expand[]=baz
If you are already expanding a field, foo
, and it has its own expandable field(s), bar
, you may additionally expand bar as follows.
/example-endpoint?expand[]=foo&expand[]=foo.bar
The foo
key and its value will be included in the response. Additionally, The bar
key and its value will be included in the response nested under the foo
key.
If you wish to expand the bar
key, but are not interested in the other keys on foo
, see granular expands.
If foo
is an expandable field whose keys you are not interested in except for its own expandable field bar
, you may do the following.
/example-endpoint?expand[]=foo.bar
The foo
key will exist, but its value will only have the bar
key, discluding all other sibling keys you did not explicitly ask for.
Some endpoints specify a search
parameter. The value of this parameter must be a string that
contains a valid query as defined by this search query language.
A query consists of at least one and at most five clauses joined by the and
keyword.
For example:
inserted_at>='2023-01-01T00:00:00Z' and description~'east blue'
A clause consists of a key, an operator, and a value.
For example:
inserted_at>='2023-01-01T00:00:00Z'
When performing a search, the set of valid keys is defined by the relevant endpoint's search
parameter's documentation.
Each key an endpoint specifies as searchable will be associated with a set of operators that are valid to use with it. Below are all possible operators and their associated operation:
Keyword | Operation |
---|---|
: |
equals (case-sensitive) |
- |
substring (case-insensitive) |
~ |
substring (case-sensitive) |
< |
less than |
<= |
less than or equal to |
> |
greater than |
>= |
greater than or equal to |
Each key will specify which type of value it acepts.
String
You must use single quotes when supplying a string. You can escape single quotes inside of
single quotes with a backslash (\
).
For example:
summary~'zoro\'s three sword style'
Boolean
Boolean values are supplied either true
or false
without single quotes.
For example:
archived:true
Date-Time
You must use single quotes when supplying a date-time and you must use the following
representation: '[YYYY]-[MM]-[DD]T[HH]:[MM]:[SS]Z'
. The timezone is always UTC.
For example:
inserted_at:'2023-01-01T00:00:00Z'
Numeric
Numeric values are supplied as-is without single quotes.
For example:
berries:100000000
Add an organization user
Authorizations:
path Parameters
organization_name required | string |
Request Body schema: application/json
role required | any (role-name) Enum: "admin" "read" "read" "write" |
username required | string (user-username) |
Responses
Request samples
- Payload
{- "role": "admin",
- "username": "string"
}
Response samples
- 201
{- "data": {
- "email": "user@example.com",
- "role": "admin",
- "username": "string"
}
}
Update an organization user
Authorizations:
path Parameters
organization_name required | string (organization-name) |
user_username required | string (user-username) |
Request Body schema: application/json
role required | any (role-name) Enum: "admin" "read" "read" "write" |
Responses
Request samples
- Payload
{- "role": "admin"
}
Response samples
- 200
{- "data": {
- "email": "user@example.com",
- "role": "admin",
- "username": "string"
}
}
List product users
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Responses
Response samples
- 200
{- "data": [
- {
- "email": "user@example.com",
- "role": "admin",
- "username": "string"
}
]
}
Add a product user
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Request Body schema: application/json
role required | any (role-name) Enum: "admin" "read" "read" "write" |
username required | string (user-username) |
Responses
Request samples
- Payload
{- "role": "admin",
- "username": "string"
}
Response samples
- 200
{- "data": {
- "email": "user@example.com",
- "role": "admin",
- "username": "string"
}
}
Retrieve a product user
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
user_username required | string (user-username) |
Responses
Response samples
- 200
{- "data": {
- "email": "user@example.com",
- "role": "admin",
- "username": "string"
}
}
Update a product user
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
user_username required | string (user-username) |
Request Body schema: application/json
role required | any (role-name) Enum: "admin" "read" "read" "write" |
Responses
Request samples
- Payload
{- "role": "admin"
}
Response samples
- 200
{- "data": {
- "email": "user@example.com",
- "role": "admin",
- "username": "string"
}
}
Authenticate a user
Authorizations:
Request Body schema: application/json
string <email> (email) | |
password required | string (user-password) |
username required | string |
Responses
Request samples
- Payload
{- "email": "user@example.com",
- "password": "string",
- "username": "string"
}
Response samples
- 200
{- "data": {
- "email": "user@example.com",
- "username": "string"
}
}
Login a user
Authorizations:
Request Body schema: application/json
string <email> (email) | |
note required | string |
password required | string (user-password) |
username required | string |
Responses
Request samples
- Payload
{- "email": "user@example.com",
- "note": "string",
- "password": "string",
- "username": "string"
}
Response samples
- 200
{- "data": {
- "email": "user@example.com",
- "token": "string",
- "username": "string"
}
}
Register a user
Authorizations:
Request Body schema: application/json
email required | string <email> (email) |
password required | string (user-password) |
username required | string (user-username) |
Responses
Request samples
- Payload
{- "email": "user@example.com",
- "password": "string",
- "username": "string"
}
Response samples
- 200
- 403
{- "data": {
- "email": "user@example.com",
- "username": "string"
}
}
Create an artifact
Authorizations:
Request Body schema: application/json
description | string (artifact-description) [ 1 .. 256 ] characters |
name required | string (artifact-name) [ 1 .. 128 ] characters |
organization_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Request samples
- Payload
{- "description": "string",
- "name": "string",
- "organization_prn": "string"
}
Response samples
- 201
{- "artifact": {
- "description": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
List artifacts
Authorizations:
query Parameters
limit | integer [ 1 .. 100 ] Default: 10 Specifies the max length of the returned results. | |||||||||||||||
order | string Enum: "asc" "desc" Controls whether the order of results is ascending or descending by | |||||||||||||||
search | string A search query per the search query language.
| |||||||||||||||
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
{- "artifacts": [
- {
- "description": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "next_page": "string"
}
Retrieve an artifact
Authorizations:
path Parameters
artifact_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Response samples
- 200
{- "artifact": {
- "description": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Update an artifact
Authorizations:
path Parameters
artifact_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Request Body schema: application/json
description | string (artifact-description) [ 1 .. 256 ] characters |
name | string (artifact-name) [ 1 .. 128 ] characters |
Responses
Request samples
- Payload
{- "description": "string",
- "name": "string"
}
Response samples
- 200
{- "artifact": {
- "description": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Create an artifact version
Authorizations:
Request Body schema: application/json
artifact_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
description | string (artifact-version-description) [ 1 .. 256 ] characters |
version required | string (artifact-version-version) [ 5 .. 16 ] characters |
Responses
Request samples
- Payload
{- "artifact_prn": "string",
- "description": "string",
- "version": "string"
}
Response samples
- 201
{- "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"
}
}
List artifact versions
Authorizations:
query Parameters
limit | integer [ 1 .. 100 ] Default: 10 Specifies the max length of the returned results. | |||||||||||||||
order | string Enum: "asc" "desc" Controls whether the order of results is ascending or descending by | |||||||||||||||
search | string A search query per the search query language.
| |||||||||||||||
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
{- "artifact_versions": [
- {
- "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"
}
], - "next_page": "string"
}
Retrieve artifact version
Authorizations:
path Parameters
artifact_version_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Response samples
- 200
{- "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"
}
}
Update an artifact version
Authorizations:
path Parameters
artifact_version_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Request Body schema: application/json
description | string (artifact-version-description) [ 1 .. 256 ] characters |
Responses
Request samples
- Payload
{- "description": "string"
}
Response samples
- 200
{- "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"
}
}
Create a binary
Create a binary record.
Authorizations:
Request Body schema: application/json
artifact_version_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
description | string (binary-description) [ 1 .. 256 ] characters |
hash required | string (binary-hash) The base64 encoding of the SHA256 hash of the binary's data. |
size required | integer (binary-size) [ 0 .. 53687091200000 ] The expected size in bytes of the binary. |
target required | string (target-triplet) [ 1 .. 128 ] characters A target triplet string that specifies compaitibility between binaries and devices. |
Responses
Request samples
- Payload
{- "artifact_version_prn": "string",
- "description": "string",
- "hash": "string",
- "size": 1800000,
- "target": "arm-linux-androideabi"
}
Response samples
- 201
{- "binary": {
- "artifact_version_prn": "string",
- "description": "string",
- "hash": "string",
- "organization_prn": "string",
- "prn": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "signatures": null,
- "size": 1800000,
- "state": "uploadable",
- "target": "arm-linux-androideabi",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
List binaries
Authorizations:
query Parameters
limit | integer [ 1 .. 100 ] Default: 10 Specifies the max length of the returned results. | |||||||||||||||
order | string Enum: "asc" "desc" Controls whether the order of results is ascending or descending by | |||||||||||||||
search | string A search query per the search query language.
| |||||||||||||||
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
{- "binaries": [
- {
- "artifact_version_prn": "string",
- "description": "string",
- "hash": "string",
- "organization_prn": "string",
- "prn": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "signatures": null,
- "size": 1800000,
- "state": "uploadable",
- "target": "arm-linux-androideabi",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "next_page": "string"
}
Retrieve a binary
Authorizations:
path Parameters
binary_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Response samples
- 200
{- "binary": {
- "artifact_version_prn": "string",
- "description": "string",
- "hash": "string",
- "organization_prn": "string",
- "prn": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "signatures": null,
- "size": 1800000,
- "state": "uploadable",
- "target": "arm-linux-androideabi",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Update a binary
Authorizations:
path Parameters
binary_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Request Body schema: application/json
description | string (binary-description) [ 1 .. 256 ] characters |
state | string (binary-state) Enum: "uploadable" "hashable" "hashing" "signable" "signed" "destroyed" The binary state |
Responses
Request samples
- Payload
{- "description": "string",
- "state": "uploadable"
}
Response samples
- 200
{- "binary": {
- "artifact_version_prn": "string",
- "description": "string",
- "hash": "string",
- "organization_prn": "string",
- "prn": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "signatures": null,
- "size": 1800000,
- "state": "uploadable",
- "target": "arm-linux-androideabi",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Create a Binary Part
Create a binary part.
Authorizations:
path Parameters
binary_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
index required | integer (binary-part-index) The binary part index order |
Request Body schema: application/json
expected_binary_size required | integer (binary-part-size) [ 5242880 .. 5368709120 ] The expected size in bytes of the binary part. |
hash required | string (binary-part-hash) The base64 encoding of the SHA256 hash of the binary part's data. |
size required | integer (binary-part-size) [ 5242880 .. 5368709120 ] The expected size in bytes of the binary part. |
Responses
Request samples
- Payload
{- "expected_binary_size": 1800000,
- "hash": "string",
- "size": 1800000
}
Response samples
- 201
{- "binary_part": {
- "binary_prn": "string",
- "hash": "string",
- "index": 0,
- "inserted_at": "2019-08-24T14:15:22Z",
- "organization_prn": "string",
- "prn": "string",
- "size": 1800000,
- "state": "uploadable",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
List binary parts
Authorizations:
path Parameters
binary_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Response samples
- 200
{- "binary_parts": [
- {
- "binary_prn": "string",
- "hash": "string",
- "index": 0,
- "inserted_at": "2019-08-24T14:15:22Z",
- "organization_prn": "string",
- "prn": "string",
- "size": 1800000,
- "state": "uploadable",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Create a binary signature
Attach a signature to a binary.
This endpoint must be used against a binary that is already uploaded completely. The request will fail if the signature is invalid.
Authorizations:
Request Body schema: application/json
binary_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
signing_key_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
signature required | string (binary-signature-signature) The uppercase hex encoding of the ed25519 signature of the base64 encoding of the SHA256 hash of the binary. |
Responses
Request samples
- Payload
{- "binary_prn": "string",
- "signing_key_prn": "string",
- "signature": "string"
}
Response samples
- 201
{- "binary_signature": {
- "binary_prn": "string",
- "organization_prn": "string",
- "prn": "string",
- "signature": "string",
- "signing_key_prn": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Delete a binary signature
Authorizations:
path Parameters
binary_signature_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Use signing keys instead.
Create a key Deprecated
Authorizations:
path Parameters
organization_name required | string (organization-name) |
Request Body schema: application/json
key required | string (key-key) |
name required | string (key-name) |
Responses
Request samples
- Payload
{- "key": "string",
- "name": "string"
}
Response samples
- 201
{- "data": {
- "key": "string",
- "name": "string"
}
}
Create a signing key
Authorizations:
Request Body schema: application/json
value required | string (signing-key-value) [ 1 .. 256 ] characters |
name required | string (signing-key-name) [ 1 .. 128 ] characters |
organization_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Request samples
- Payload
{- "value": "string",
- "name": "string",
- "organization_prn": "string"
}
Response samples
- 201
{- "signing_key": {
- "value": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
List signing keys
Authorizations:
query Parameters
limit | integer [ 1 .. 100 ] Default: 10 Specifies the max length of the returned results. | |||||||||||||||
order | string Enum: "asc" "desc" Controls whether the order of results is ascending or descending by | |||||||||||||||
search | string A search query per the search query language.
| |||||||||||||||
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
{- "signing_keys": [
- {
- "value": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "next_page": "string"
}
Retrieve a signing key
Authorizations:
path Parameters
signing_key_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Response samples
- 200
{- "signing_key": {
- "value": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Update a signing key
Authorizations:
path Parameters
signing_key_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Request Body schema: application/json
value | string (signing-key-value) [ 1 .. 256 ] characters |
name | string (signing-key-name) [ 1 .. 128 ] characters |
Responses
Request samples
- Payload
{- "value": "string",
- "name": "string"
}
Response samples
- 200
{- "signing_key": {
- "value": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Delete a signing key
Authorizations:
path Parameters
signing_key_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Response samples
- 204
{- "signing_key": {
- "value": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "organization_prn": "string",
- "prn": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
This functionality has been superceded by artifacts, artifact versions, and binaries.
List firmware
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Responses
Response samples
- 200
{- "data": [
- {
- "architecture": "string",
- "author": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "platform": "string",
- "product": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "vcs_identifier": "d670460b4b4aece5915caf5c68d12f560a9fe3e4",
- "version": "1.0.0-alpha.3"
}
]
}
Create a firmware
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Request Body schema: multipart/form-data
firmware required | string <binary> Reference firmware file requirements. |
ttl | integer |
Responses
Response samples
- 201
- 500
{- "data": {
- "architecture": "string",
- "author": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "platform": "string",
- "product": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "vcs_identifier": "d670460b4b4aece5915caf5c68d12f560a9fe3e4",
- "version": "1.0.0-alpha.3"
}
}
Delete a firmware
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
firmware_uuid required | string <uuid> (firmware-uuid) Uniquely identifies a firmware. |
Responses
Response samples
- 204
{- "architecture": "string",
- "author": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "platform": "string",
- "product": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "vcs_identifier": "d670460b4b4aece5915caf5c68d12f560a9fe3e4",
- "version": "1.0.0-alpha.3"
}
Retrieve a firmware
Expandable
This endpoint has an expandable response. See expanding responses.
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
firmware_uuid required | string <uuid> (firmware-uuid) Uniquely identifies a firmware. |
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": {
- "architecture": "string",
- "author": "string",
- "inserted_at": "2019-08-24T14:15:22Z",
- "platform": "string",
- "product": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "vcs_identifier": "d670460b4b4aece5915caf5c68d12f560a9fe3e4",
- "version": "1.0.0-alpha.3",
- "url": "string"
}
}
List CA certificates
Authorizations:
path Parameters
organization_name required | string (organization-name) |
Responses
Response samples
- 200
{- "data": [
- {
- "description": "string",
- "not_after": "2019-08-24T14:15:22Z",
- "not_before": "2019-08-24T14:15:22Z",
- "serial": "522154175989108335861639249273408275957749326848"
}
]
}
Create a CA certificate
Authorizations:
path Parameters
organization_name required | string (organization-name) |
Request Body schema: application/json
certificate required | string Base64 encoded CA certificate. |
verification_certificate required | string Base64 encoded verification certificate. See: create-a-ca-verification-code |
description | string |
object (ca-jitp) |
Responses
Request samples
- Payload
{- "certificate": "string",
- "verification_certificate": "string",
- "description": "string",
- "jitp": {
- "description": "string",
- "product_name": "string",
- "tags": [
- "string"
], - "cohort_prn": "string"
}
}
Response samples
- 201
{- "data": {
- "description": "string",
- "not_after": "2019-08-24T14:15:22Z",
- "not_before": "2019-08-24T14:15:22Z",
- "serial": "522154175989108335861639249273408275957749326848"
}
}
Retrieve a CA certificate
Authorizations:
path Parameters
organization_name required | string (organization-name) |
ca_certificate_serial required | string (ca-certificate-serial) Example: 522154175989108335861639249273408275957749326848 |
Responses
Response samples
- 200
{- "data": {
- "description": "string",
- "not_after": "2019-08-24T14:15:22Z",
- "not_before": "2019-08-24T14:15:22Z",
- "serial": "522154175989108335861639249273408275957749326848"
}
}
Update CA certificate
Authorizations:
path Parameters
organization_name required | string (organization-name) |
ca_certificate_serial required | string (ca-certificate-serial) Example: 522154175989108335861639249273408275957749326848 |
Request Body schema: application/json
description | string |
object (ca-jitp) |
Responses
Request samples
- Payload
{- "description": "string",
- "jitp": {
- "description": "string",
- "product_name": "string",
- "tags": [
- "string"
], - "cohort_prn": "string"
}
}
Response samples
- 200
{- "data": {
- "description": "string",
- "not_after": "2019-08-24T14:15:22Z",
- "not_before": "2019-08-24T14:15:22Z",
- "serial": "522154175989108335861639249273408275957749326848"
}
}
Create a cohort
Authorizations:
Request Body schema: application/json
description | string (cohort-description) [ 1 .. 256 ] characters |
name required | string (cohort-name) [ 1 .. 128 ] characters |
organization_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
product_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Request samples
- Payload
{- "description": "string",
- "name": "string",
- "organization_prn": "string",
- "product_prn": "string"
}
Response samples
- 201
{- "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"
}
}
List cohorts
Authorizations:
query Parameters
limit | integer [ 1 .. 100 ] Default: 10 Specifies the max length of the returned results. | |||||||||||||||
order | string Enum: "asc" "desc" Controls whether the order of results is ascending or descending by | |||||||||||||||
search | string A search query per the search query language.
| |||||||||||||||
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
{- "cohorts": [
- {
- "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"
}
], - "next_page": "string"
}
Retrieve a cohort
Authorizations:
path Parameters
cohort_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Response samples
- 200
{- "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"
}
}
Update a cohort
Authorizations:
path Parameters
cohort_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Request Body schema: application/json
description | string (cohort-description) [ 1 .. 256 ] characters |
name | string (cohort-name) [ 1 .. 128 ] characters |
Responses
Request samples
- Payload
{- "description": "string",
- "name": "string"
}
Response samples
- 200
{- "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"
}
}
List device certificates
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
device_identifier required | string (device-identifier) Uniquely identifies a device within an organization. |
Responses
Response samples
- 200
{- "data": [
- {
- "not_after": "2019-08-24T14:15:22Z",
- "not_before": "2019-08-24T14:15:22Z",
- "serial": "522154175989108335861639249273408275957749326848"
}
]
}
Create a device certificate
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
device_identifier required | string (device-identifier) Uniquely identifies a device within an organization. |
Request Body schema: application/json
cert required | string (device-certificate-pem-base64) Base64 encoded device certificate pem. |
Responses
Request samples
- Payload
{- "cert": "string"
}
Response samples
- 201
{- "data": {
- "not_after": "2019-08-24T14:15:22Z",
- "not_before": "2019-08-24T14:15:22Z",
- "serial": "522154175989108335861639249273408275957749326848"
}
}
Retrieve a device certificate
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
device_identifier required | string (device-identifier) Uniquely identifies a device within an organization. |
certificate_serial required | string (device-certificate-serial) Example: 522154175989108335861639249273408275957749326848 |
Responses
Response samples
- 200
{- "data": {
- "not_after": "2019-08-24T14:15:22Z",
- "not_before": "2019-08-24T14:15:22Z",
- "serial": "522154175989108335861639249273408275957749326848"
}
}
Delete a device certificate
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
device_identifier required | string (device-identifier) Uniquely identifies a device within an organization. |
certificate_serial required | string (device-certificate-serial) Example: 522154175989108335861639249273408275957749326848 |
Responses
List devices
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Responses
Response samples
- 200
{- "data": [
- {
- "description": { },
- "firmware_metadata": { },
- "healthy": { },
- "identifier": "string",
- "last_communication": "never",
- "status": "offline",
- "tags": { },
- "version": "1.0.0-alpha.3"
}
]
}
Create a device
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Request Body schema: application/json
description | string (device-description) |
healthy | boolean (device-healthy) |
identifier required | string (device-identifier) Uniquely identifies a device within an organization. |
last_communication | string <date-time> (device-last-communication) |
tags | Array of strings (array-of-device-tags) |
target | string (target-triplet) [ 1 .. 128 ] characters A target triplet string that specifies compaitibility between binaries and devices. |
Responses
Request samples
- Payload
{- "description": "string",
- "healthy": true,
- "identifier": "string",
- "last_communication": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "target": "arm-linux-androideabi"
}
Response samples
- 201
{- "description": { },
- "firmware_metadata": { },
- "healthy": { },
- "identifier": "string",
- "last_communication": "never",
- "status": "offline",
- "tags": { },
- "version": "1.0.0-alpha.3"
}
Delete a device
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
device_identifier required | string (device-identifier) Uniquely identifies a device within an organization. |
Responses
Retrieve a device
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
device_identifier required | string (device-identifier) Uniquely identifies a device within an organization. |
Responses
Response samples
- 200
{- "data": {
- "description": { },
- "firmware_metadata": { },
- "healthy": { },
- "identifier": "string",
- "last_communication": "never",
- "status": "offline",
- "tags": { },
- "version": "1.0.0-alpha.3"
}
}
Update a device
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
device_identifier required | string (device-identifier) Uniquely identifies a device within an organization. |
Request Body schema: application/json
description | string (device-description) |
healthy | boolean (device-healthy) |
last_communication | string <date-time> (device-last-communication) |
tags | Array of strings (array-of-device-tags) |
target | string (target-triplet) [ 1 .. 128 ] characters A target triplet string that specifies compaitibility between binaries and devices. |
Responses
Request samples
- Payload
{- "description": "string",
- "healthy": true,
- "last_communication": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "target": "arm-linux-androideabi"
}
Response samples
- 200
{- "data": {
- "description": { },
- "firmware_metadata": { },
- "healthy": { },
- "identifier": "string",
- "last_communication": "never",
- "status": "offline",
- "tags": { },
- "version": "1.0.0-alpha.3"
}
}
Authenticate device
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Request Body schema: application/json
certificate required | string (device-certificate-pem-base64) Base64 encoded device certificate pem. |
Responses
Request samples
- Payload
{- "certificate": "string"
}
Response samples
- 200
{- "data": {
- "description": { },
- "firmware_metadata": { },
- "healthy": { },
- "identifier": "string",
- "last_communication": "never",
- "status": "offline",
- "tags": { },
- "version": "1.0.0-alpha.3"
}
}
Create a product
Authorizations:
path Parameters
organization_name required | string (organization-name) |
Request Body schema: application/json
name required | string (product-name) Uniquely identifies a product within an organization. |
Responses
Request samples
- Payload
{- "name": "string"
}
Response samples
- 201
{- "data": {
- "name": "string",
- "prn": "string"
}
}
Retrieve a product
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Responses
Response samples
- 200
{- "data": {
- "name": "string",
- "prn": "string"
}
}
Update a product
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Request Body schema: application/json
required | object | ||
|
Responses
Request samples
- Payload
{- "product": {
- "name": "string"
}
}
Response samples
- 200
{- "data": {
- "name": "string",
- "prn": "string"
}
}
Create a bundle
Authorizations:
Request Body schema: application/json
organization_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
artifact_version_prns required | Array of strings (array-of-artifact-version-prns) |
Responses
Request samples
- Payload
{- "organization_prn": "string",
- "artifact_version_prns": [
- "string"
]
}
Response samples
- 201
{- "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"
}
}
list bundles
Authorizations:
query Parameters
limit | integer [ 1 .. 100 ] Default: 10 Specifies the max length of the returned results. | |||||||||||||||
order | string Enum: "asc" "desc" Controls whether the order of results is ascending or descending by | |||||||||||||||
search | string A search query per the search query language.
| |||||||||||||||
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
{- "bundles": [
- {
- "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"
}
], - "next_page": "string"
}
Retrieve a bundle
Authorizations:
path Parameters
bundle_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Response samples
- 200
{- "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"
}
}
List deployments
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Responses
Response samples
- 200
{- "data": [
- {
- "conditions": {
- "tags": [
- "string"
], - "version": "== 1.0.0"
}, - "delta_updatable": true,
- "firmware_uuid": "ad4e7819-9176-4c88-8ecc-459ee9868725",
- "is_active": true,
- "name": "string",
- "state": "on"
}
]
}
Create a deployment
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
Request Body schema: application/json
required | object (deployment-conditions) |
delta_updatable | boolean (delta-updatable) Default: false |
firmware required | string <uuid> (firmware-uuid) Uniquely identifies a firmware. |
is_active required | boolean (deployment-is-active) Must be |
name required | string (deployment-name) |
Responses
Request samples
- Payload
{- "conditions": {
- "tags": [
- "string"
], - "version": "== 1.0.0"
}, - "delta_updatable": true,
- "firmware": "a3a072e2-291e-4454-88c4-f2689e9ad8c7",
- "is_active": true,
- "name": "string"
}
Response samples
- 201
{- "data": {
- "conditions": {
- "tags": [
- "string"
], - "version": "== 1.0.0"
}, - "delta_updatable": true,
- "firmware_uuid": "ad4e7819-9176-4c88-8ecc-459ee9868725",
- "is_active": true,
- "name": "string",
- "state": "on"
}
}
Retrieve a deployment
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
deployment_name required | string (deployment-name) |
Responses
Response samples
- 200
{- "data": {
- "conditions": {
- "tags": [
- "string"
], - "version": "== 1.0.0"
}, - "delta_updatable": true,
- "firmware_uuid": "ad4e7819-9176-4c88-8ecc-459ee9868725",
- "is_active": true,
- "name": "string",
- "state": "on"
}
}
Update a deployment
Authorizations:
path Parameters
organization_name required | string (organization-name) |
product_name required | string (product-name) Uniquely identifies a product within an organization. |
deployment_name required | string (deployment-name) |
Request Body schema: application/json
required | object | ||||||||||
|
Responses
Request samples
- Payload
{- "deployment": {
- "name": "string",
- "conditions": {
- "tags": [
- "string"
], - "version": "== 1.0.0"
}, - "delta_updatable": true,
- "firmware": "a3a072e2-291e-4454-88c4-f2689e9ad8c7",
- "is_active": true
}
}
Response samples
- 200
{- "data": {
- "conditions": {
- "tags": [
- "string"
], - "version": "== 1.0.0"
}, - "delta_updatable": true,
- "firmware_uuid": "ad4e7819-9176-4c88-8ecc-459ee9868725",
- "is_active": true,
- "name": "string",
- "state": "on"
}
}
Create a release
Authorizations:
Request Body schema: application/json
bundle_prn required | string (prn) The bundle the release will distribute to devices. |
phase_value required | number (release-phase-value) [ 0 .. 100 ] The phase value controls the distribution of the update to your fleet. Decimals in Integers >= 2 are treated as absolute device counts, e.g., to allow 40 of the cohort's devices to update, you would specifiy NOTE: A release with a NOTE: There can only ever be a single release that is phased at a time within a cohort. Because of this, if there is already a phased release, it must be "completed" by setting the phase to |
cohort_prn required | string (prn) The cohort to create the release within, and in turn the cohort it will distribute its bundle to. |
string or null (release-description) | |
name required | string (release-name) |
next_release_prn | string (prn) If omitted, the release will be created as latest within the cohort. If there is already at least one release in the cohort, then the latest release in that cohort would have its If supplied, the release will be created prior to the release identified by |
previous_release_prn | string (prn) If omitted, If supplied, |
organization_prn required | string (prn) The organization to create the release within. |
required required | boolean (release-required) If If |
schedule_date required | string <date-time> (release-schedule-availability) Before this date-time, the release will not be resolvable when checking for updates. You may use this to schedule a future release. |
version | string (release-version) The release version. If provided, it has to be a valid version. Used in dynamic release resolution. |
version-requirement | string (release-version-requirement) The release version requirement. If provided, it has to be a valid requirement. Used in dynamic release resolution. |
Responses
Request samples
- Payload
{- "bundle_prn": "string",
- "phase_value": 100,
- "cohort_prn": "string",
- "description": null,
- "name": "string",
- "next_release_prn": "string",
- "previous_release_prn": "string",
- "organization_prn": "string",
- "required": true,
- "schedule_date": "2019-08-24T14:15:22Z",
- "version": "1.0.0",
- "version-requirement": "== 1.0.0"
}
Response samples
- 201
{- "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"
}
}
List Releases
Authorizations:
query Parameters
limit | integer [ 1 .. 100 ] Default: 10 Specifies the max length of the returned results. | |||||||||||||||
order | string Enum: "asc" "desc" Controls whether the order of results is ascending or descending by | |||||||||||||||
search | string A search query per the search query language.
| |||||||||||||||
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
{- "next_page": "string",
- "releases": [
- {
- "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"
}
]
}
Retrieve a release
Authorizations:
path Parameters
release_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Responses
Response samples
- 200
{- "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"
}
}
Update a release
Authorizations:
path Parameters
release_prn required | string (prn) Peridio Resource Names (PRNs) uniquely identify Peridio resources. |
Request Body schema: application/json
string or null (release-description) | |
name | string (release-name) |
phase_value | number (release-phase-value) [ 0 .. 100 ] The phase value controls the distribution of the update to your fleet. Decimals in Integers >= 2 are treated as absolute device counts, e.g., to allow 40 of the cohort's devices to update, you would specifiy NOTE: A release with a NOTE: There can only ever be a single release that is phased at a time within a cohort. Because of this, if there is already a phased release, it must be "completed" by setting the phase to |
required | boolean (release-required) If If |
schedule_date | string <date-time> (release-schedule-availability) Before this date-time, the release will not be resolvable when checking for updates. You may use this to schedule a future release. |
version | string (release-version) The release version. If provided, it has to be a valid version. Used in dynamic release resolution. |
version-requirement | string (release-version-requirement) The release version requirement. If provided, it has to be a valid requirement. Used in dynamic release resolution. |
Responses
Request samples
- Payload
{- "description": null,
- "name": "string",
- "phase_value": 100,
- "required": true,
- "schedule_date": "2019-08-24T14:15:22Z",
- "version": "1.0.0",
- "version-requirement": "== 1.0.0"
}
Response samples
- 200
{- "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"
}
}