PATCH /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings

Patch script metadata, such as bindings

Servers

Path parameters

Name Type Required Description
environment_name String Yes
service_name String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
messages[] Array Yes
messages[].source Object No
messages[].source.pointer String No
messages[].message String Yes
messages[].documentation_url String No
messages[].code Integer Yes
errors[] Array Yes
errors[].source Object No
errors[].source.pointer String No
errors[].message String Yes
errors[].documentation_url String No
errors[].code Integer Yes
success Boolean Yes

Whether the API call was successful.

Possible values:

  • true
result Object No
result.tail_consumers[] Array No

List of Workers that will consume logs from the attached Worker.

result.tail_consumers[].namespace String No

Optional dispatch namespace the script belongs to.

result.tail_consumers[].environment String No

Optional environment if the Worker utilizes one.

result.tail_consumers[].service String Yes

Name of Worker that is to be the consumer.

result.logpush Boolean No

Whether Logpush is turned on for the Worker.

result.observability Object No

Observability settings for the Worker.

result.observability.head_sampling_rate Number No

The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

result.observability.enabled Boolean Yes

Whether observability is enabled for the Worker.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.