Skip to content
Oclavex is in private preview, available to selected users. Public signup is blocked. Request access at [email protected].

Pre-registers a device, so an activation code that requires a pre-configured device admits it.

POST
/api/v1/provision/operational/entitlements/{entitlementId}/devices
curl --request POST \
--url https://example.com/api/v1/provision/operational/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/devices \
--header 'Content-Type: application/json' \
--data '{ "fingerprint": "example", "deviceName": "example" }'
entitlementId
required
string format: uuid

The entitlement.

The device.

Pre-registers a device on an entitlement.

object
fingerprint
required

The device fingerprint the application sends when it activates.

string
>= 1 characters <= 100 characters
deviceName

A name to recognize the device by.

null | string
0 <= 100 characters
Examplegenerated
{
"fingerprint": "example",
"deviceName": "example"
}

OK

A device the vendor listed on an entitlement: pre-registered, so an activation code that requires a pre-configured device admits it, or blocked, so no activation admits it.

object
id

The entry’s id, used to unblock or unregister the device.

string format: uuid
entitlementId

The entitlement the device is listed on.

string format: uuid
fingerprint

The device fingerprint the application sends when it activates.

string
deviceName

A name to recognize the device by.

null | string
isPreRegistered

The device may activate under an activation code that requires a pre-configured device.

boolean
isBlocked

The device may not activate this entitlement.

boolean
blockedAt

When the device was blocked; null while it is not blocked.

null | string format: date-time
lastActivatedAt

When the device last activated as a pre-registered device; null if it never did.

null | string format: date-time

Bad Request

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Not Found

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string