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

AddCollectionFilter

Add a new collection filter rule to a platform

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • platformIdStringRequired

    Platform ID to add the filter to

Body Fields

  • idStringRequired

    Unique identifier of the filter

    Example: filter-001

  • platformIdStringRequired

    Platform ID this filter applies to

    Example: plat-001

  • fieldStringRequired

    Pod field to match against (e.g. namespace, label)

    Example: namespace

  • opStringRequired

    Comparison operator (eq, contains, prefix)

    Example: eq

  • valueStringRequired

    Value to compare the field against

    Example: kube-system

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of the filter

    Example: filter-001

  • platformIdString

    Platform ID this filter applies to

    Example: plat-001

  • fieldString

    Pod field to match against (e.g. namespace, label)

    Example: namespace

  • opString

    Comparison operator (eq, contains, prefix)

    Example: eq

  • valueString

    Value to compare the field against

    Example: kube-system

  • actionString

    Action to take when filter matches (include or exclude)

    Example: exclude

  • createdAtString

    Timestamp when this filter was created

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

Endpoint

POST/api/v1/platforms/{platformId}/collection-filter

/api/v1/platforms/{platformId}/collection-filter

Operation ID

AddCollectionFilter

Permalink

Request Example

curl -X POST '{host}/api/v1/platforms/{platformId}/collection-filter' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"id":"filter-001","platformId":"plat-001","field":"namespace","op":"eq","value":"kube-system","action":"exclude","createdAt":"2026-01-15T08:00:00Z"}'

Response Example

200
{
  "id": "filter-001",
  "platformId": "plat-001",
  "field": "namespace",
  "op": "eq",
  "value": "kube-system",
  "action": "exclude",
  "createdAt": "example"
}

Change History

This API has no change history records yet.

View all change history