Management APIs / Secrets

Delete an organization secret

DELETEhttps://api.spice.ai/v1/orgs/{orgId}/secrets/{secretName}

Deletes an organization secret and every project link to it. Deployments that reference it stop receiving it on their next deploy.

Authorizations

  • AuthorizationstringRequired

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

Path parameters

  • orgIdintegerRequired

    The org id from GET /v1/orgs

    • Minimum: 1

  • secretNamestringRequired

    The name of the secret

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}$

Responses

204Secret deleted

400Bad Request

Invalid org id (invalid_org_id), X-Org-Name does not name that org (org_path_mismatch), or invalid secret name

401Unauthorized

403Forbidden

Insufficient scope (requires secrets:write), the caller is not an admin or owner, or not a member of the organization (org_forbidden), a machine credential named an organization other than its own (org_assertion_mismatch), or the organization a machine credential is bound to has been deleted (org_deleted)

404Secret not found

500Internal server error

OpenAPIapi.spice.ai/openapi.json

curl -X DELETE "https://api.spice.ai/v1/orgs/<orgId>/secrets/<secretName>" \
  -H "Authorization: Bearer <token>"

No response body