Create a bulk-operation

POST

/bulk-operations

• Current canonical versioned path (F3.API.01)

Authorizations

• bearerAuth
• apiTokenAuth

Request Body ^required

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:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

executed_by

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

executed_at

string format: date-time

payload

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

Responses

200

Created

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:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

executed_by

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

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

400

Validation error

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)