SPspice
Secrets

Create or update a secret

The org is orgId in the path. Creates a new secret or updates an existing secret with the same name. The secret value is encrypted at rest.

post/v1/orgs/{orgId}/projects/{projectId}/secrets

Request

  • Base URL
    https://api.spice.ai
  • Auth
    HTTP bearer

Path parameters

orgIdinteger required

The org id from GET /v1/orgs

projectIdinteger required

The ID of the project

Headers

X-Org-Namestring

When present, X-Org-Name must name the same org as orgId. Otherwise the request returns org_path_mismatch (400).

Request body

namestring required

Secret name (must start with a letter or underscore, alphanumeric and underscores only)

valuestring required

Secret value (will be encrypted at rest)

Response

Secret created or updated successfully

idinteger

Unique identifier for the secret

namestring

Name of the secret

valuestring

Always masked with asterisks

created_atstring date-time

Timestamp when the secret was created

updated_atstring date-time

Timestamp when the secret was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.