Create a target

Create a new target, which can be used in executions.

application/json

application/grpc

application/grpc-web+proto

Request Body required

name string required

Possible values: non-empty and <= 200 characters

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 required

Timeout defines the duration until ZITADEL cancels the execution.

endpoint string required

Possible values: non-empty and <= 1000 characters

Request Body required

name string required

Possible values: non-empty and <= 200 characters

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 required

Timeout defines the duration until ZITADEL cancels the execution.

endpoint string required

Possible values: non-empty and <= 1000 characters

Request Body required

name string required

Possible values: non-empty and <= 200 characters

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 required

Timeout defines the duration until ZITADEL cancels the execution.

endpoint string required

Possible values: non-empty and <= 1000 characters

Responses

• 200
• 201
• 403
• 404
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

id 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

{
  "id": "string",
  "details": {
    "sequence": "2",
    "changeDate": "2024-05-10T13:32:03.304Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

id 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

{
  "id": "string",
  "details": {
    "sequence": "2",
    "changeDate": "2024-05-10T13:32:03.304Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

id 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

{
  "id": "string",
  "details": {
    "sequence": "2",
    "changeDate": "2024-05-10T13:32:03.304Z",
    "resourceOwner": "69629023906488334"
  }
}

Target successfully created

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

id 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

{
  "id": "string",
  "details": {
    "sequence": "2",
    "changeDate": "2024-05-10T13:32:03.305Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

id 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

{
  "id": "string",
  "details": {
    "sequence": "2",
    "changeDate": "2024-05-10T13:32:03.305Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

id 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

{
  "id": "string",
  "details": {
    "sequence": "2",
    "changeDate": "2024-05-10T13:32:03.305Z",
    "resourceOwner": "69629023906488334"
  }
}

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

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

POST /v3alpha/targets

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN

Bearer Token

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}

Accept

application/jsonapplication/grpcapplication/grpc-web+protoapplication/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/targets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/targets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/targets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/targets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/targets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/targets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/targets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/targets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/targets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}'