Delete a profile
Deletes a profile; with `force`, a profile that has versions too, which destroys every version.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Deletes a profile; with force, a profile that has versions too, which destroys every version.
- Path
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/profiles/profile - Scope
secrets:write - Effect
destructive— a successful call removes data; the CLI asks before it runs. - Collection profiles
- Query
etag,validate_only,force
Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the profile to delete. Required. |
etag | string | Delete only if the current etag matches. |
validate_only | bool | Validate without deleting anything. |
force | bool | Also destroy every version; without it a profile with versions fails with INVALID_STATE. |
Response
The call answers with an empty object.
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.INVALID_STATE— The Resource is in a state that forbids the call.
Every error arrives in the body Errors describes.
Examples
curl -X DELETE "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/profiles/profile" \
-H "Authorization: Bearer $SYLPHX_API_KEY"