resources.effectiveConfig

GET

/resources/{resourceId}/effective-config

const url = 'https://example.com/api/resources/example/effective-config';
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/resources/example/effective-config

Reads the masked effective configuration for one resource. Public docs: /docs/environments/variables/precedence/#environment-variable-precedence

Parameters

Path Parameters

resourceId

required

string

>= 1 characters

Responses

200

application/json

object

schemaVersion

required

string

Allowed value: resources.effective-config/v1

resourceId

required

string

environmentId

required

string

ownedEntries

required

Array<object>

object

key

required

string

value

required

string

scope

required

string

exposure

required

string

Allowed values: build-time runtime

isSecret

required

boolean

kind

required

string

updatedAt

string

effectiveEntries

required

Array<object>

object

key

required

string

value

required

string

scope

required

string

exposure

required

string

Allowed values: build-time runtime

isSecret

required

boolean

kind

required

string

updatedAt

string

precedence

required

Array<string>

generatedAt

required

string

Example

{
  "schemaVersion": "resources.effective-config/v1",
  "ownedEntries": [
    {
      "exposure": "build-time"
    }
  ],
  "effectiveEntries": [
    {
      "exposure": "build-time"
    }
  ]
}