Delete Secret

Delete a workspace or caller-owned personal secret without reading or returning its stored value. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:write.

DELETE/api/v2/secrets/{name}

Authorization

X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

name*string

Secret to delete.

Match^[A-Za-z0-9_]+$
Length1 <= length <= 255

Query Parameters

workspaceId*string

Workspace the request is authorized against. A workspace secret is deleted from it; a personal secret is deleted for the caller in all of their workspaces.

Length1 <= length <= 128
scope*string

Whether the secret belongs to the workspace or to the caller. A personal secret belongs to the caller across every workspace, not to one workspace.

Value in"workspace" | "personal"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://www.sim.ai/api/v2/secrets/string?workspaceId=string&scope=workspace" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "name": "STRIPE_API_KEY",
    "scope": "workspace",
    "deleted": true
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}
PATCHUpdate CredentialGETList Secrets