Skip to main content
ZStack
Monitoring & Collection/Zaku

AddCollectionFilter

Add a new collection filter rule to a platform

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

Operation ID

AddCollectionFilter

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

Path Parameters

  • platformId
    StringRequired

    Platform ID to add the filter to

Body Fields

  • id
    StringRequired

    Unique identifier of the filter

    Example: filter-001

  • platformId
    StringRequired

    Platform ID this filter applies to

    Example: plat-001

  • field
    StringRequired

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

    Example: namespace

  • op
    StringRequired

    Comparison operator (eq, contains, prefix)

    Example: eq

  • value
    StringRequired

    Value to compare the field against

    Example: kube-system

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • id
    String

    Unique identifier of the filter

    Example: filter-001

  • platformId
    String

    Platform ID this filter applies to

    Example: plat-001

  • field
    String

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

    Example: namespace

  • op
    String

    Comparison operator (eq, contains, prefix)

    Example: eq

  • value
    String

    Value to compare the field against

    Example: kube-system

  • action
    String

    Action to take when filter matches (include or exclude)

    Example: exclude

  • createdAt
    String

    Timestamp when this filter was created

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