Skip to main content
ZStack
Platform Operations/Platform Misc

ExecuteBatch

Execute a batch operation on multiple resources of the same type.

POST/api/v1/batch

Operation ID

ExecuteBatch

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

application/json

Body Fields

  • request
    ObjectRequired

    The batch request payload containing resource type, action, and items

    • resourceType
      String

      Type of resource this batch operation targets

      Example: platform

    • action
      String

      Action to perform on each item (e.g. delete, enable, disable)

      Example: delete

    • items
      List

      List of items to process in this batch

      Example: (nested array)

      • id
        String

        Unique identifier of this batch item

        Example: item-001

      • params
        LinkedHashMap

        Additional parameters as key-value pairs

        Example: (nested object)

    • dryRun
      Boolean

      Whether to preview the operation without executing it

      Example: false

    • failFast
      Boolean

      Whether to abort the entire batch on the first failure

      Example: false

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • resourceType
    String

    Resource type that was processed

    Example: platform

  • action
    String

    Action that was performed

    Example: delete

  • totalCount
    Integer

    Total number of items submitted

    Example: 10

  • successCount
    Integer

    Number of items that succeeded

    Example: 9

  • failureCount
    Integer

    Number of items that failed

    Example: 1

  • dryRun
    Boolean

    Whether this was a dry-run execution

    Example: false

  • results
    List

    Per-item results

    Example: (nested array)

    • id
      String

      Identifier of the batch item this result corresponds to

      Example: item-001

    • success
      Boolean

      Whether the operation on this item succeeded

      Example: true

    • httpStatus
      Integer

      HTTP status code equivalent for this item result

      Example: 200

    • error
      String

      Error message if this item failed

      Example: resource not found

    • dryRunEstimate
      String

      Estimated impact description for dry-run mode

      Example: Would delete 1 platform

  • processedAt
    String

    Processed at

    Example: 2026-01-15T08:00:00Z