Skip to content
OTA-Pulse Docs

Create Provisioning Token

POST
/api/provisioning-tokens

Create a new provisioning token for fleet onboarding.

This token should be baked into your Yocto image. When devices boot, they use this token to register and receive a unique API key.

Authorizations

Parameters

Query Parameters

organization_id
required
string format: uuid

Request Body required

Create a provisioning token for fleet onboarding

object
allowed_hardware_versions

Allowed hardware versions (empty = all)

Array<string>
default_scopes

Scopes to assign to generated API keys

Array<string>
description
Any of:
string
expires_at
Any of:
string format: date-time
max_devices
Any of:
integer
>= 1
name
required

Human-readable name for the token

string
>= 1 characters <= 255 characters

Responses

201

Successful Response

Response when provisioning token is created (includes full token)

object
allowed_hardware_versions
required
Array<string>
created_at
required
string format: date-time
created_by_id
required
Any of:
string format: uuid
default_scopes
required
Array<string>
description
required
Any of:
string
devices_provisioned
required
integer
expires_at
required
Any of:
string format: date-time
id
required
string format: uuid
is_active
required
boolean
last_used_at
required
Any of:
string format: date-time
max_devices
required
Any of:
integer
name
required
string
organization_id
required
string format: uuid
token
required
string
token_prefix
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string