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

Resets every device on each of up to 100 entitlements, in one transaction. An id that names no entitlement, or an offer, is reported in its result and changes nothing.

POST
/api/v1/provision/operational/entitlements/devices/reset
curl --request POST \
--url https://example.com/api/v1/provision/operational/entitlements/devices/reset \
--header 'Content-Type: application/json' \
--data '{ "entitlementIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

The entitlements whose devices to reset.

Resets every device on several entitlements at once.

object
entitlementIds
required

The entitlements whose devices to reset; at most 100.

Array<string>
>= 1 items <= 100 items
Examplegenerated
{
"entitlementIds": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
]
}

OK

What a bulk device reset did, per entitlement.

object
results

One result per distinct entitlement id in the request, in request order.

Array<object>

What resetting an entitlement’s devices did.

object
entitlementId

The entitlement whose devices were reset.

string format: uuid
devicesReset

How many activations were reset.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
transferCount

The entitlement’s transfer count after the reset.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
error

In a bulk reset: why this entitlement was not reset; null when it was.

null | string

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