List secret overrides

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/secret/override \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/secret/override?projectID=<projectID>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/secret/override?projectID=<projectID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "overrides": [
    {
      "environmentAlias": "<string>",
      "versionVariant": "<VersionVariant>",
      "secretIDs": [
        "<string>"
      ]
    }
  ]
}

List secret overrides

Returns which environment versions hold a value of their own for each secret, as secret IDs grouped by environment alias and `draft` or `published` variant; values are never included. The call is unpaginated: it takes no paging parameters, so one request yields the whole set.

GET

/v1/stable/secret/override

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/secret/override \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/secret/override?projectID=<projectID>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/secret/override?projectID=<projectID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "overrides": [
    {
      "environmentAlias": "<string>",
      "versionVariant": "<VersionVariant>",
      "secretIDs": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Query Parameters

projectID

string

required

The ID of the project to operate on.

Response

200 - application/json

Returns one entry per environment version that holds a value for at least one secret, each with the environment alias, the draft or published variant, and the IDs of the secrets with a value there.

overrides

object[]

required

Show child attributes

environmentAlias

string

required

The alias of the environment carrying the override (e.g. main).

versionVariant

enum<string>

required

Which version of the environment carries the override — its editable draft or its published copy.

Available options: draft, published

Show child attributes

secretIDs

string[]

required

The IDs of the secrets overridden on this environment version.

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

List secret overrides

Authorizations

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks