Variables

Patch User Pipeline Variables

Modify multiple pipeline variables. To delete a variable, include it with an empty value.

patch/api/program/{programId}/pipeline/{pipelineId}/variables

Request

  • Base URL: https://cloudmanager.adobe.io
  • URL: https://cloudmanager.adobe.io/api/program/{programId}/pipeline/{pipelineId}/variables
  • Auth: none declared. Required headers: x-gw-ims-org-id, Authorization, x-api-key, Content-Type

Path parameters

programIdstring required

Identifier of the program

pipelineIdstring required

Identifier of the pipeline

Headers

x-gw-ims-org-idstring required

IMS organization ID that the request is being made under.

Authorizationstring required

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-keystring required

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Typestring required

Must always be application/json

Request body

namestring

Name of the variable. Can only consist of a-z, A-Z, _ and 0-9 and cannot begin with a number.

valuestring

Value of the variable. Read-Write for non-secrets, write-only for secrets. The length of secretString values must be less than 500 characters. An empty value causes a variable to be deleted.

type'string' | 'secretString'

Type of the variable. Default string if missing. secretString variables are encrypted at rest. The type of a variable be changed after creation; the variable must be deleted and recreated.

Example request

[
  {
    "name": "MY_VAR1",
    "value": "myValue",
    "type": "string"
  }
]

Response

Successful setting of variables

Changes

No recorded changes to this operation across all 2 revisions of this API.