PATCH /v1/env

Updates a given Shared Environment Variable for a Team.

Servers

Request headers

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

Default value: "application/json"

Query parameters

Name Type Required Description
teamId String No

The Team identifier to perform the request on behalf of.

slug String No

The Team slug to perform the request on behalf of.

Request body fields

Name Type Required Description
updates Object Yes
updates.name Object No
updates.name.projectId[] Array No

Associate a Shared Environment Variable to projects.

updates.name.comment String No

A comment to add context on what this Shared Environment Variable is for

updates.name.projectIdUpdates Object No

Incrementally update project associations without specifying the full list

updates.name.projectIdUpdates.link[] Array No

Project IDs to add to this environment variable

updates.name.projectIdUpdates.unlink[] Array No

Project IDs to remove from this environment variable

updates.name.key String No

The name of the Shared Environment Variable

updates.name.target[] Array No

The target environment of the Shared Environment Variable

updates.name.type String No

The new type of the Shared Environment Variable

Valid values:

  • "sensitive"
  • "encrypted"
updates.name.value String No

The value of the Shared Environment Variable

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.