Environment variable drift since the live build

GET

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

curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/projects/example/env/drift \
  --header 'Authorization: <Authorization>'

Compares the build-targeted environment variables a production build would get now against the set the live deployment was built with. Returns key names only: values and fingerprints never leave the server. recorded is false (and the lists empty) when there is no live deployment or it was built before snapshots were recorded, or was a direct upload. Lists are sorted and never null.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Project ID

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

added

Added are keys configured now that the live build did not have.

Array<string>

changed

Changed are keys in both whose value differs.

Array<string>

deployment_id

DeploymentID is the live deployment compared against; null when there is none.

string

recorded

Recorded is false when there is nothing to compare against: no live deployment, or one built before snapshots were recorded (or a direct upload, which has no build). The three lists are then empty, which means “unknown”, not “no drift”.

boolean

removed

Removed are keys the live build had that are no longer configured.

Array<string>

Example ^generated

{
  "data": {
    "added": [
      "example"
    ],
    "changed": [
      "example"
    ],
    "deployment_id": "example",
    "recorded": true,
    "removed": [
      "example"
    ]
  },
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

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"
  }
}

500

Internal Server Error

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"
  }
}