Management APIs / Secrets

Create or update a secret

POSThttps://api.spice.ai/v1/projects/{projectId}/secrets

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

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • projectIdintegerRequired

    The ID of the project

Header parameters

  • X-Org-Namestring

    The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Body

application/jsonRequired

  • namestringRequired

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

    • Pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$

  • valuestringRequired

    Secret value (will be encrypted at rest)

Responses

200Secret created or updated successfullyapplication/json

  • 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

400Invalid request body or project ID

401Unauthorized

403Insufficient scope

404Project not found

500Internal server error

curl -X POST "https://api.spice.ai/v1/projects/<projectId>/secrets" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "value": "string"
  }'
{
  "id": 0,
  "name": "string",
  "value": "string",
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z"
}

application/json

POSThttps://api.spice.ai/v1/orgs/{orgId}/projects/{projectId}/secrets

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.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • orgIdintegerRequired

    The org id from GET /v1/orgs

    • Minimum: 1

  • projectIdintegerRequired

    The ID of the project

Header parameters

  • X-Org-Namestring

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

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Body

application/jsonRequired

  • namestringRequired

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

    • Pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$

  • valuestringRequired

    Secret value (will be encrypted at rest)

Responses

200Secret created or updated successfullyapplication/json

  • 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

400Bad Request

Invalid request body or project ID. orgId is not a valid org id (invalid_org_id), or X-Org-Name does not name that org (org_path_mismatch).

401Unauthorized

403Forbidden

Insufficient scope. The caller is not a member of the org (org_forbidden). A machine credential named a different org (org_assertion_mismatch). The org is deleted (org_deleted).

404Project not found

500Internal server error

curl -X POST "https://api.spice.ai/v1/orgs/<orgId>/projects/<projectId>/secrets" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "value": "string"
  }'
{
  "id": 0,
  "name": "string",
  "value": "string",
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z"
}

application/json

POSThttps://api.spice.ai/v1/apps/{appId}/secretsDeprecated

Legacy alias of /v1/projects/{projectId}/secrets — projects were previously called apps. Creates a new secret or updates an existing secret with the same name. The secret value is encrypted at rest.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • appIdintegerRequired

    The ID of the project

Header parameters

  • X-Org-Namestring

    The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Body

application/jsonRequired

  • namestringRequired

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

    • Pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$

  • valuestringRequired

    Secret value (will be encrypted at rest)

Responses

200Secret created or updated successfullyapplication/json

  • 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

400Invalid request body or project ID

401Unauthorized

403Insufficient scope

404Project not found

500Internal server error

OpenAPIapi.spice.ai/openapi.json

curl -X POST "https://api.spice.ai/v1/apps/<appId>/secrets" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "value": "string"
  }'
{
  "id": 0,
  "name": "string",
  "value": "string",
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z"
}

application/json