Create a secret.

post

https://api.cast.ai/ai-optimizer/v1beta/organizations/{organizationId}/secrets

Creates a secret. Scope mappings are optional in the payload: a
user-scope mapping must reference the caller's own user ID, an
organization-scope mapping the request organization. Without mappings
the secret is scoped to the caller's own user. Use SetSecretMappings to
change scopes after creation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

string

required

The ID of the organization.

Body Params

Secret is the metadata of a stored secret. The value is never present on
output.

name

string

Human-readable display name (not unique).

hostPattern

string

Host pattern the secret applies to: an exact lowercase hostname
(api.example.com) or a subdomain wildcard (*.example.com).

injection

object

required

How the value is injected into matching requests.

value

string

The secret value. INPUT_ONLY: accepted on create/update, never returned.
Empty means "unchanged" on update; the create path requires a value.

mappings

array of objects

Scopes this secret is mapped to. Optional on create: when empty, the
secret is scoped to the caller's own user; user-scope mappings must
reference the caller's own user ID and organization-scope mappings the
request organization. Ignored in update payloads; use SetSecretMappings
to change scopes after creation.

mappings

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response