Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Zaku
POSTZakuSince 1.0SynchronousAuth Required

BatchNormalize

Batch normalize multiple pod specs in a single request

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • podsListRequired

    The pods value

    Example: (nested array)

    • nameString

      Name of the pod

      Example: nginx-deployment-abc123

    • namespaceString

      Kubernetes namespace of the pod

      Example: default

    • labelsLinkedHashMap

      Key-value labels attached to this resource

      Example: (nested object)

    • annotationsLinkedHashMap

      Arbitrary key-value annotations for metadata

      Example: (nested object)

    • containerCountInteger

      Number of containers in the pod

      Example: 2

    • nodeNameString

      Name of the node the pod is scheduled on

      Example: k8s-node-01

    • statusString

      Current phase of the pod lifecycle

      Example: Running

  • optsObjectRequired

    The opts value

    • batchSizeInteger

      Number of pods to process per batch

      Example: 100

    • maxErrorsInteger

      Maximum number of errors before aborting the batch

      Example: 10

    • strictModeBoolean

      If true, abort on first validation error; if false, skip and continue

      Example: false

Responses

200 OK

On success, this API returns the following response structure.

  • successfulInteger

    Number of pods successfully normalized

    Example: 95

  • failedInteger

    Number of pods that failed normalization

    Example: 3

  • skippedInteger

    Number of pods skipped due to filter rules

    Example: 2

  • errorsList

    Errors for this resource

    Example: (nested array)

    • podNameString

      Name of the pod that caused the error

      Example: bad-pod-001

    • errorString

      Error message describing the normalization failure

      Example: label value exceeds max length of 63

  • durationMsString

    Total time taken for the batch in milliseconds

    Example: 1250

Endpoint

POST/api/v1/zaku/normalize/batch

/api/v1/zaku/normalize/batch

Operation ID

BatchNormalize

Permalink

Request Example

curl -X POST '{host}/api/v1/zaku/normalize/batch' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"pods":"(nested array)","opts":{"batchSize":100,"maxErrors":10,"strictMode":false}}'

Response Example

200
{
  "successful": 95,
  "failed": 3,
  "skipped": 2,
  "errors": [
    {}
  ],
  "durationMs": 1250
}

Change History

This API has no change history records yet.

View all change history