Skip to main content
API Explorer|API Explorer
Platform Operations/Platform Misc
POSTPlatformSince 1.0SynchronousAuth Required

ExecuteBatch

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • requestObjectRequired

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

    • resourceTypeString

      Type of resource this batch operation targets

      Example: platform

    • actionString

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

      Example: delete

    • itemsList

      List of items to process in this batch

      Example: (nested array)

      • idString

        Unique identifier of this batch item

        Example: item-001

      • paramsLinkedHashMap

        Additional parameters as key-value pairs

        Example: (nested object)

    • dryRunBoolean

      Whether to preview the operation without executing it

      Example: false

    • failFastBoolean

      Whether to abort the entire batch on the first failure

      Example: false

Responses

200 OK

On success, this API returns the following response structure.

  • resourceTypeString

    Resource type that was processed

    Example: platform

  • actionString

    Action that was performed

    Example: delete

  • totalCountInteger

    Total number of items submitted

    Example: 10

  • successCountInteger

    Number of items that succeeded

    Example: 9

  • failureCountInteger

    Number of items that failed

    Example: 1

  • dryRunBoolean

    Whether this was a dry-run execution

    Example: false

  • resultsList

    Per-item results

    Example: (nested array)

    • idString

      Identifier of the batch item this result corresponds to

      Example: item-001

    • successBoolean

      Whether the operation on this item succeeded

      Example: true

    • httpStatusInteger

      HTTP status code equivalent for this item result

      Example: 200

    • errorString

      Error message if this item failed

      Example: resource not found

    • dryRunEstimateString

      Estimated impact description for dry-run mode

      Example: Would delete 1 platform

  • processedAtString

    Processed at

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

Endpoint

POST/api/v1/batch

/api/v1/batch

Operation ID

ExecuteBatch

Permalink

Request Example

curl -X POST '{host}/api/v1/batch' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"request":{"resourceType":"platform","action":"delete","items":"(nested array)","dryRun":false,"failFast":false}}'

Response Example

200
{
  "resourceType": "platform",
  "action": "delete",
  "totalCount": 10,
  "successCount": 9,
  "failureCount": 1,
  "dryRun": false,
  "results": [
    {}
  ],
  "processedAt": "example"
}

Change History

This API has no change history records yet.

View all change history