Skip to main content

List targets

POST 
https://$CUSTOM-DOMAIN/v3alpha/targets/search

List all matching targets. By default, we will return all targets of your instance. Make sure to include a limit and sorting for pagination.

Request​

Body

required

    query

    object

    list limitations and ordering.

    offset uint64
    limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    default is descending

    sortingColumn string

    Possible values: [FIELD_NAME_UNSPECIFIED, FIELD_NAME_ID, FIELD_NAME_CREATION_DATE, FIELD_NAME_CHANGE_DATE, FIELD_NAME_NAME, FIELD_NAME_TARGET_TYPE, FIELD_NAME_URL, FIELD_NAME_TIMEOUT, FIELD_NAME_ASYNC, FIELD_NAME_INTERRUPT_ON_ERROR]

    Default value: FIELD_NAME_UNSPECIFIED

    the field the result is sorted.

    queries

    object[]

    Define the criteria to query for.

  • Array [

    • targetNameQuery

    object

    targetName string

    Possible values: <= 200 characters

    Defines the name of the target to query for.

    method string

    Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]

    Default value: TEXT_QUERY_METHOD_EQUALS

    defines which text equality method is used

    inTargetIdsQuery

    object

    targetIds string[]

    the ids of the targets to include

  • ]

Responses​

A list of all targets matching the query

Schema

    details

    object

    Details provides information about the returned result including total amount found.

    totalResult uint64
    processedSequence uint64
    timestamp date-time

    the last time the projection got updated

    sortingColumn string

    Possible values: [FIELD_NAME_UNSPECIFIED, FIELD_NAME_ID, FIELD_NAME_CREATION_DATE, FIELD_NAME_CHANGE_DATE, FIELD_NAME_NAME, FIELD_NAME_TARGET_TYPE, FIELD_NAME_URL, FIELD_NAME_TIMEOUT, FIELD_NAME_ASYNC, FIELD_NAME_INTERRUPT_ON_ERROR]

    Default value: FIELD_NAME_UNSPECIFIED

    States by which field the results are sorted.

    result

    object[]

    The result contains the user schemas, which matched the queries.

  • Array [

    • targetId string

    ID is the read-only unique identifier of the target.

    details

    object

    Details provide some base information (such as the last change date) of the target.

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)
    name string

    Unique name of the target.

    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

    Timeout defines the duration until ZITADEL cancels the execution.

    endpoint string

  • ]

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/targets/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "FIELD_NAME_SCHEMA_TYPE",
  "queries": [
    {
      "targetNameQuery": {
        "targetName": "ip_allow_list",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "inTargetIdsQuery": {
        "targetIds": [
          "69629023906488334",
          "69622366012355662"
        ]
      }
    }
  ]
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Body required
{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "FIELD_NAME_SCHEMA_TYPE",
  "queries": [
    {
      "targetNameQuery": {
        "targetName": "ip_allow_list",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "inTargetIdsQuery": {
        "targetIds": [
          "69629023906488334",
          "69622366012355662"
        ]
      }
    }
  ]
}
ResponseClear

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