Skip to main content
GET
Get an app secret

Authorizations

Authorization
string
header
required

Effective API key. Send Authorization: Bearer sk-eai-...

Path Parameters

appId
string
required

App ID: app- followed by lowercase letters, digits and hyphens, ending in a letter or digit. It is part of the app’s hostname, so your organization’s subdomain and the ID together must fit 63 characters.

Maximum string length: 63
Pattern: ^app-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$
name
string
required

Secret name: letters, digits, _, . and -, starting with a letter or digit, at most 100 characters.

Maximum string length: 100
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]*$

Response

The secret.

id
string
required

Secret name, unique within the app.

routes
object[]
required

Where the app’s outbound HTTPS requests carry the value.

configured
boolean
required

True when a value is set and injected. A secret declared in Effective without a value of its own is false until you set one.

updatedAt
string<date-time>
required

When the secret last changed.