Skip to main content
PATCH
Enable, disable or rename an engine

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key; a retry with the same key and body replays the first answer.

Path Parameters

engineId
string
required

An engine in the registry.

Body

application/json
displayName
string
Maximum string length: 128
enabled
boolean
participants
string[]

Replaces the engine's participant set.

Pattern: ^[0-9]{8}$
pixDelivery
object

Replaces where the Courier delivers this engine's Pix messages; an empty baseUrl removes it. https in production, and it needs the admin grant (engines pix-delivery:write).

reason
string

Recorded on the change. Required for a disable.

Maximum string length: 512

Response

OK

createdAt
string<date-time>
required
credentialSubject
string
required
Maximum string length: 256
displayName
string
required
Maximum string length: 128
enabled
boolean
required
engineId
string
required
Pattern: ^[a-z0-9-]{1,32}$
participants
string[]
required
Pattern: ^[0-9]{8}$
disabledAt
string<date-time> | null
pixDelivery
object