ZITADEL Docs
APIsCore ResourcesV2Action

ListTargets

List targets

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

Required permission:

  • action.target.read
POST
/v2/actions/targets/search

Request Body

application/json

pagination?

List limitations and ordering.

sortingColumn?string

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.

Value in"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"
filters?

Define the criteria to query for.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/v2/actions/targets/search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  },
  "targets": [
    {
      "id": "string",
      "creationDate": "1s",
      "changeDate": "1s",
      "name": "string",
      "timeout": "string",
      "endpoint": "string",
      "signingKey": "string",
      "payloadType": "PAYLOAD_TYPE_UNSPECIFIED",
      "restAsync": {}
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?