Skip to content
Authrim

Process one bounded custom Dynamic Worker plugin rollout batch.

POST
/api/admin/platform/plugins/{id}/rollout
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/platform/plugins/example/rollout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "batch_size": 1 }'

Starts or resumes a rollout to the platform active immutable plugin version. The same Idempotency-Key resumes the same server-owned cursor. A batch size of one can be used as the first observed batch; a dedicated canary tenant is not required.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
/^[a-z0-9][a-z0-9._-]{0,127}$/

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
required
string
>= 1 characters <= 256 characters

Request Body required

Section titled “Request Body required ”
Media type application/json
object
batch_size
required
integer
default: 1 >= 1 <= 25
key
additional properties

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Bounded rollout batch result, resumable aggregate status, and audit ID.

Media type application/json
object
operationId
required
string
pluginId
required
string
targetVersionDigest
required
string
/^[a-f0-9]{64}$/
state
required
string
Allowed values: running completed completed_with_errors blocked
cursorInstallationId
required
string | null
processedThisBatch
required
integer
<= 25
succeededCount
required
integer
blockedCount
required
integer
failedCount
required
integer
hasMore
required
boolean
lastErrorCode
required
string | null
auditId
required
string
key
additional properties
Example 
{
  "state": "running"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}