Skip to main content

Get Target

GET 
/v2beta/actions/targets/:id

Returns the target identified by the requested ID.

Required permission:

  • action.target.read

Required feature flag:

  • actions

Request​

Path Parameters

    id stringrequired

Responses​

Target retrieved successfully

Schema

    target

    object

    id string

    The unique identifier of the target.

    creationDate date-time

    The timestamp of the target creation.

    changeDate date-time

    The timestamp of the last change to the target (e.g. creation, activation, deactivation).

    name string

    restWebhook

    object

    interruptOnError boolean

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

    restCall

    object

    interruptOnError boolean

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

    restAsync object
    timeout string

    Timeout defines the duration until ZITADEL cancels the execution. If the target doesn't respond before this timeout expires, the 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
    signingKey string
Loading...