Preview diffs for a proposed secret/var substitution

POST

/api/environments/{envId}/config-scan/preview

curl --request POST \
  --url https://example.com/api/environments/example/config-scan/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "hardcoded_value", "value": "example", "key": "example", "type": "secret", "fileIds": [ "example" ], "existingSecretId": "example" }'

Authorizations

• bearerAuth

Parameters

Path Parameters

envId

required

string

Request Body^required

Media typeapplication/json

object

kind

required

string

Allowed values: hardcoded_value missing_reference

value

required

string

>= 1 characters

key

required

string

>= 1 characters /^[A-Z][A-Z0-9_]*$/

type

required

string

Allowed values: secret var

fileIds

required

Array<string>

existingSecretId

required

string

nullable

Responses

400

Bad request — malformed input or failed validation.

Media typeapplication/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

401

Unauthorized — missing or invalid bearer token.

Media typeapplication/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

403

Forbidden — token scope or role does not permit this operation.

Media typeapplication/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}