Update environment variable

PATCH

/api/v1/projects/{id}/env/{envVarId}

curl --request PATCH \
  --url https://api.deploybase.eu/api/v1/api/v1/projects/example/env/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "targets": [ "build" ], "value": "example" }'

Partially updates an environment variable: its value, its targets, or both. The key and environment cannot change.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Project ID

envVarId

required

string

Environment Variable ID

Request Body

Fields to change

Media type application/json

object

targets

Array<string>

Allowed values: build runtime

value

string

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

created_at

string

environment

string

Allowed values: production preview all

id

string

key

string

project_id

string

targets

Array<string>

Allowed values: build runtime

updated_at

string

warnings

Warnings are accepted-but-risky conditions the caller should show (NODE_OPTIONS).

Array<string>

Example

{
  "data": {
    "environment": "production",
    "targets": [
      "build"
    ]
  }
}

400

Bad Request

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Not Found

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

422

Unprocessable Entity

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}