Skip to main content
ZStack
Platform Operations/Platform Misc

ListSupportedBatchActions

List all supported batch action types and their constraints.

GET/api/v1/batch/supported-actions

Operation ID

ListSupportedBatchActions

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of supported batch action definitions

    Example: (nested array)

    • resourceType
      String

      Resource type this batch action applies to

      Example: platform

    • action
      String

      Action name identifier

      Example: delete

    • description
      String

      Human-readable description of what this action does

      Example: Delete multiple platforms in a single request

    • maxBatchSize
      Integer

      Maximum number of items allowed in one batch request

      Example: 100

  • total
    Integer

    Total number of supported actions

    Example: 8

  • limit
    Integer

    Maximum number of items per page

    Example: 20

  • offset
    Integer

    Number of items skipped

    Example: 20