Update a target

Update an existing target.

Path Parameters

targetId string required

unique identifier of the target.

application/json

application/grpc

application/grpc-web+proto

Request Body required

name string

Possible values: non-empty and <= 200 characters

Optionally change the unique name of the target.

restWebhook object

url string required

Possible values: non-empty and <= 1000 characters

restRequestResponse object

url string required

Possible values: non-empty and <= 1000 characters

timeout string

Optionally change the timeout, which defines the duration until ZITADEL cancels the execution.

isAsync boolean

Set the execution to run asynchronously.

interruptOnError boolean

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

Request Body required

name string

Possible values: non-empty and <= 200 characters

Optionally change the unique name of the target.

restWebhook object

url string required

Possible values: non-empty and <= 1000 characters

restRequestResponse object

url string required

Possible values: non-empty and <= 1000 characters

timeout string

Optionally change the timeout, which defines the duration until ZITADEL cancels the execution.

isAsync boolean

Set the execution to run asynchronously.

interruptOnError boolean

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

Request Body required

name string

Possible values: non-empty and <= 200 characters

Optionally change the unique name of the target.

restWebhook object

url string required

Possible values: non-empty and <= 1000 characters

restRequestResponse object

url string required

Possible values: non-empty and <= 1000 characters

timeout string

Optionally change the timeout, which defines the duration until ZITADEL cancels the execution.

isAsync boolean

Set the execution to run asynchronously.

interruptOnError boolean

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

Responses

• 200
• 403
• 404
• default

---

Target successfully updated

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

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

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-03-27T10:05:49.514Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

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

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-03-27T10:05:49.514Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

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

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-03-27T10:05:49.514Z",
    "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"
    }
  ]
}

PUT /v3alpha/targets/:targetId

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

targetId — path required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "name": "ip_allow_list",
  "restWebhook": {
    "url": "https://example.com/hooks/ip_check"
  },
  "restRequestResponse": {
    "url": "https://example.com/hooks/ip_check"
  },
  "timeout": "10s",
  "isAsync": true,
  "interruptOnError": true
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

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

python / requests

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

go / native

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

nodejs / axios

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

ruby / Net::HTTP

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

csharp / RestSharp

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

php / cURL

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

java / OkHttp

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

powershell / RestMethod

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