API ReferenceTask Forwarders

Update Task Forwarder

Authentication

AuthorizationBearer

Bearer token authentication using JWT tokens from Ory Kratos/Hydra

Path Parameters

task_forwarder_idstringRequiredformat: "uuid"
The specific Task to reference.
org_idstringRequiredformat: "uuid"
The unique identifier of the organization.
project_idstringRequiredformat: "uuid"
The unique identifier of the project.

Request

This endpoint expects an object.
namestring or nullOptional
A descriptive name for the Task Forwarder.
descriptionstring or nullOptional
Additional details about the Task Forwarder's purpose or configuration.
configobject or nullOptional

Configuration parameters for the Task Forwarder such as a destination URL.

config_sensitiveobject or nullOptional

Sensitive parameters for the Task Forwarder such as a signing_key.

Response

Task forwarder updated
namestring
A descriptive name for the Task Forwarder.
idstringformat: "uuid"
The unique identifier of the Task Forwarder.
project_idstringformat: "uuid"
The Project that the Task Forwarder belongs to.
createdstring
When the Task Forwarder was created.
modifiedstring
When the Task Forwarder was last updated.
descriptionstring or null
Additional details about the Task Forwarder's purpose or configuration.
configobject or null

Configuration parameters for the Task Forwarder such as a destination URL.

config_sensitiveobject or null

Sensitive parameters for the Task Forwarder such as a signing_key.

Errors