Skip to main content

Search targets

POST 
https://$CUSTOM-DOMAIN/resources/v3alpha/actions/targets/_search

Search all matching targets. By default all targets of the instance are returned. Make sure to include a limit and sorting for pagination.

Request​

Query Parameters

    instance.id string
    instance.domain string
    query.offset uint64
    query.limit int64

    Maximum amount of events returned. If not configured otherwise, the default is 100, the maximum is 1000. If the limit exceeds the maximum, ZITADEL throws an error.

    query.desc boolean

    default is ascending, because together with the creation date sorting column, this returns the most deterministic pagination results.

    sortingColumn string

    Possible values: [TARGET_FIELD_NAME_UNSPECIFIED, TARGET_FIELD_NAME_ID, TARGET_FIELD_NAME_CREATED_DATE, TARGET_FIELD_NAME_CHANGED_DATE, TARGET_FIELD_NAME_NAME, TARGET_FIELD_NAME_TARGET_TYPE, TARGET_FIELD_NAME_URL, TARGET_FIELD_NAME_TIMEOUT, TARGET_FIELD_NAME_INTERRUPT_ON_ERROR]

    Default value: TARGET_FIELD_NAME_UNSPECIFIED

    The field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent.

Body

required

Define the criteria to query for.

  • Array [

    • targetNameFilter

    object

    targetName string

    Possible values: <= 200 characters

    Defines the name of the target to query for.

    method string

    Possible values: [TEXT_FILTER_METHOD_EQUALS, TEXT_FILTER_METHOD_EQUALS_IGNORE_CASE, TEXT_FILTER_METHOD_STARTS_WITH, TEXT_FILTER_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_FILTER_METHOD_CONTAINS]

    Default value: TEXT_FILTER_METHOD_EQUALS

    defines which text equality method is used

    inTargetIdsFilter

    object

    targetIds string[]

    the ids of the targets to include

  • ]

Responses​

A list of all targets matching the query

Schema

    details

    object

    appliedLimit uint64
    totalResult uint64
    timestamp date-time

    the last time the projection got updated

    result

    object[]

  • Array [

    • details

    object

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string

    config

    object

    name string

    Possible values: non-empty and <= 1000 characters

    restWebhook

    object

    Wait for response but response body is ignored, status is checked, call is sent as post.

    interruptOnError boolean

    Define if any error stops the whole execution. By default the process continues as normal.

    restCall

    object

    Wait for response and response body is used, status is checked, call is sent as post.

    interruptOnError boolean

    Define if any error stops the whole execution. By default the process continues as normal.

    restAsync object

    Call is executed in parallel to others, ZITADEL does not wait until the call is finished. The state is ignored, call is sent as post.

    timeout string

    if the target doesn't respond before this timeout expires, the the connection is closed and the action fails

    endpoint string

    Possible values: non-empty and <= 1000 characters

    signingKey string

  • ]

curl -L 'https://$CUSTOM-DOMAIN/resources/v3alpha/actions/targets/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '[
  {
    "targetNameFilter": {
      "targetName": "ip_allow_list",
      "method": "TEXT_FILTER_METHOD_EQUALS"
    },
    "inTargetIdsFilter": {
      "targetIds": [
        "69629023906488334",
        "69622366012355662"
      ]
    }
  }
]'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— query
— query
— query
— query
— query
— query
Body required
[
  {
    "targetNameFilter": {
      "targetName": "ip_allow_list",
      "method": "TEXT_FILTER_METHOD_EQUALS"
    },
    "inTargetIdsFilter": {
      "targetIds": [
        "69629023906488334",
        "69622366012355662"
      ]
    }
  }
]
ResponseClear

Click the Send API Request button above and see the response here!