Delete a secret

Delete a secret that is no longer referenced by workspace resources.

Endpoint

DELETE/api/v1/workspaces/{workspace_id}/secrets/{secret_id}

Authentication

Operation class	Authentication	Minimum role	API key
dashboard-session-api	Dashboard session cookie; mutations also require X-CX-Request: 1.	admin	Not allowed

Parameters

Name	In	Type	Required	Description
`workspace_id`	path	string	Yes	—
`secret_id`	path	string	Yes	—

Request body

This operation has no request body.

Example

curl --request DELETE 'https://operade.ai/api/v1/workspaces/ws_demo/secrets/sec_demo' \
  --cookie 'cx_session=YOUR_SESSION_COOKIE' \
  --header 'X-CX-Request: 1'

Responses

Status	Description	Content
`4XX`	Handled client error	application/json: ErrorResponse
`204`	Successful Response	No body

4XX application/json response schema

Field path	Type	Reference	Format	Nullable	Required	Enum	Description
`$`	object	ErrorResponse	—	No	Yes	—	—
`error`	object	ErrorItem	—	No	Yes	—	—
`error.code`	string	—	—	No	Yes	—	—
`error.details`	object	—	—	No	No	—	—
`error.message`	string	—	—	No	Yes	—	—

Response example

HTTP 204
This response has no body.

Errors

Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.

Status	Code	Description
`401`	`unauthenticated`	Authentication is missing, invalid, or revoked.
`403`	`forbidden`	The authenticated caller does not have access to this operation.
`404`	`not_found`	The requested workspace resource was not found.