COconductorone
Decoy

Search

Changed on

Search decoys with free-text query and filters for kind, status, and annotation key.

post/api/v1/decoys/search

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/decoys/search
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

annotationKeysstring[] nullable

Filter to decoys that have at least one of these annotation keys set. Empty means no annotation filter. Per-key constraints match the c1api annotation-bag standard (min_len 1, max_len 128, same regex used by every annotation-bag-typed field across c1api).

hasBeenUsedboolean

Filter to decoys that have been used at least once. False / unset means no filter (show all). The "never used" case is not covered in this filter; add an explicit field if needed.

kindsstring[] nullable

Filter by kind (OR within the list). Empty means any kind.

pageSizeinteger

The pageSize field.

pageTokenstring

The pageToken field.

querystring

Free-text query against display_name and description. Empty means no text filter.

statusesstring[] nullable

Filter by status (OR within the list). Empty means any status.

Response

Successful response

nextPageTokenstring

The nextPageToken field.

Changes