environments.diff

GET

/environments/{environmentId}/diff/{otherEnvironmentId}

const url = 'https://example.com/api/environments/example/diff/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/environments/example/diff/example

Compares two environment configuration sets. Public docs: /docs/environments/changes/diff-promote/#environment-diff

Parameters

Path Parameters

environmentId

required

string

>= 1 characters

otherEnvironmentId

required

string

>= 1 characters

Responses

200

application/json

Array<object>

object

key

required

string

exposure

required

string

Allowed values: build-time runtime

left

object

key

required

string

value

required

string

scope

required

string

exposure

required

string

Allowed values: build-time runtime

isSecret

required

boolean

kind

required

string

right

object

key

required

string

value

required

string

scope

required

string

exposure

required

string

Allowed values: build-time runtime

isSecret

required

boolean

kind

required

string

change

required

string

Allowed values: added removed changed unchanged

Example

[
  {
    "exposure": "build-time",
    "left": {
      "exposure": "build-time"
    },
    "right": {
      "exposure": "build-time"
    },
    "change": "added"
  }
]