Skip to main content
ZStack
Recently Deleted/Recently Deleted

SearchAssetLabels

Search for assets by label key/value criteria across the asset inventory.

GET/api/v1/assets/labels/search

Operation ID

SearchAssetLabels

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

Query Parameters

  • key
    String

    Label key to search by Label key to search by

  • value
    String

    Label value to filter by; empty matches all values for the given key Label value to filter by; empty matches all values for the given key

  • assetType
    String

    Asset type to restrict search to; empty searches across all asset types Asset type to restrict search to; empty searches across all asset types

  • page
    Integer

    Page number (1-based) for pagination Page number (1-based) for pagination

    Example: 0

  • size
    Integer

    Number of records per page Number of records per page

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • data
    Object

    The data value

    Example: (nested object)