Target by ID

GET 
https://$CUSTOM-DOMAIN/resources/v3alpha/actions/targets/:id

Returns the target identified by the requested ID.

Request

Path Parameters

id stringrequired

Query Parameters

instance.id string
instance.domain string

Responses

200

Target successfully retrieved

application/json

Schema

Schema

target

object

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

Example (from schema)

{
  "target": {
    "details": {
      "id": "69629012906488334",
      "created": "2025-03-04T16:03:34.658Z",
      "changed": "2025-03-04T16:03:34.658Z",
      "owner": "69629023906488334"
    },
    "config": {
      "name": "ip_allow_list",
      "restWebhook": {
        "interruptOnError": true
      },
      "restCall": {
        "interruptOnError": true
      },
      "restAsync": {},
      "timeout": "10s",
      "endpoint": "https://example.com/hooks/ip_check"
    },
    "signingKey": "98KmsU67"
  }
}

application/grpc

Schema

Schema

target

object

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

Example (from schema)

{
  "target": {
    "details": {
      "id": "69629012906488334",
      "created": "2025-03-04T16:03:34.659Z",
      "changed": "2025-03-04T16:03:34.659Z",
      "owner": "69629023906488334"
    },
    "config": {
      "name": "ip_allow_list",
      "restWebhook": {
        "interruptOnError": true
      },
      "restCall": {
        "interruptOnError": true
      },
      "restAsync": {},
      "timeout": "10s",
      "endpoint": "https://example.com/hooks/ip_check"
    },
    "signingKey": "98KmsU67"
  }
}

application/grpc-web+proto

Schema

Schema

target

object

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

Example (from schema)

{
  "target": {
    "details": {
      "id": "69629012906488334",
      "created": "2025-03-04T16:03:34.660Z",
      "changed": "2025-03-04T16:03:34.660Z",
      "owner": "69629023906488334"
    },
    "config": {
      "name": "ip_allow_list",
      "restWebhook": {
        "interruptOnError": true
      },
      "restCall": {
        "interruptOnError": true
      },
      "restAsync": {},
      "timeout": "10s",
      "endpoint": "https://example.com/hooks/ip_check"
    },
    "signingKey": "98KmsU67"
  }
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://$CUSTOM-DOMAIN/resources/v3alpha/actions/targets/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN

Auth

Bearer Token

Parameters

id — pathrequired

instance.id — query

instance.domain — query

ResponseClear

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