Skip to main content

Update Target

POST 
/v2beta/actions/targets/:id

Update an existing target. To generate a new signing key set the optional expirationSigningKey.

Required permission:

  • action.target.write

Required feature flag:

  • actions

Request​

Path Parameters

    id stringrequired

Body

required

    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

    Timeout defines the duration until ZITADEL cancels the execution. If the target doesn't respond before this timeout expires, then the connection is closed and the action fails. Depending on the target type and possible setting on interrupt_on_error following targets will not be called. In case of a rest_async target only this specific target will fail, without any influence on other targets of the same execution.

    endpoint string

    Possible values: non-empty and <= 1000 characters

    expirationSigningKey string

    Regenerate the key used for signing and checking the payload sent to the target. Set the graceful period for the existing key. During that time, the previous signing key and the new one will be used to sign the request to allow you a smooth transition onf your API.

    Note that we currently only allow an immediate rotation ("0s") and will support longer expirations in the future.

Responses​

Target successfully updated or left unchanged

Schema

    changeDate date-time

    The timestamp of the change of the target.

    signingKey string

    Key used to sign and check payload sent to the target.

Loading...