Skip to content
Console
On this page

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.com does 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

FieldTypeWhat it is
namestringThe name of the profile to delete. Required.
etagstringDelete only if the current etag matches.
validate_onlyboolValidate without deleting anything.
forceboolAlso destroy every version; without it a profile with versions fails with INVALID_STATE.

Response

The call answers with an empty object.

Errors

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"