Skip to content
Authrim

Create an immutable target-snapshotted Bulk Plan.

POST
/api/admin/agent-bulk-plans
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/agent-bulk-plans \
  --header 'Content-Type: application/json' \
  --cookie authrim_admin_session=<authrim_admin_session> \
  --data '{ "grant_id": "example", "machine_credential_id": "example", "definition": { "schemaVersion": "authrim-agent-bulk-plan-v1", "targetTenantIds": [ "example" ], "canaryTenantIds": [ "example" ], "plan": { "schemaVersion": "authrim-agent-plan-v1", "steps": [ { "id": "example", "operation": "example", "toolContractVersion": "example", "input": {}, "resourcePrecondition": "per-tenant-validation" } ] }, "rollout": { "canarySize": 1, "waveSize": 1, "waveFailureThresholdBasisPoints": 1 } } }'

Requires a platform Admin human session, an active Agent Grant, explicit target and canary tenant IDs, Bulk Plan permission, and every underlying operation permission.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
grant_id
required
string
machine_credential_id
required
string
definition
required
object
schemaVersion
required
string
Allowed value: authrim-agent-bulk-plan-v1
targetTenantIds
required
Array<string>
>= 1 items <= 1000 items unique items
canaryTenantIds
required
Array<string>
>= 1 items <= 5 items unique items
plan
required
object
schemaVersion
required
string
Allowed value: authrim-agent-plan-v1
steps
required
Array<object>
>= 1 items <= 100 items
object
id
required
string
operation
required
string
toolContractVersion
required
string
input
required
object
resourcePrecondition
required
string
Allowed value: per-tenant-validation
key
additional properties
key
additional properties
rollout
object
canarySize
integer
>= 1 <= 5
waveSize
integer
>= 1 <= 25
waveFailureThresholdBasisPoints
integer
<= 500
key
additional properties
key
additional properties
key
additional properties

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Draft Bulk Plan and tenant child records created atomically.

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"
}