Skip to content

Get a single bulk-operation by id

GET
/bulk-operations/{id}
id
required
string

DocumentId

OK

object
data
object
name
required

Human-readable operation name, e.g. ‘Apply security patches to web tier’

string
operation_type
required
string
Allowed values: patch tag_apply security_group_update policy_apply
target_resource_type

E.g. cloud-instance, fleet-agent

string
target_filters

Filter criteria for targeting resources, e.g. {tags: [‘web-tier’], providers: [‘hetzner’]}

dry_run_result

Preview result: {affected_count, affected_tenants: [{org_name, resource_count}], skipped_tenants: [{org_name, reason}]}

execution_result

Per-tenant results after execution

status
required
string
Allowed values: draft dry_running dry_ran executing completed failed cancelled
tenant_count

Number of targeted managed tenants

integer
resource_count

Total resources targeted

integer
skipped_count

Tenants skipped due to missing capability

integer
operator_org
One of:

DocumentId reference to api::organisation.organisation

string
executed_by
One of:

DocumentId reference to plugin::users-permissions.user

string
executed_at
string format: date-time
payload

Operation-specific parameters (patch version, tag key/value, etc.)

documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Missing or invalid authentication

Not authorized (tenant scope or capability)

Not found