Skip to content

Delete a guideline

DELETE/v1/guidelines/{id}Key scope write

Deletes a guideline. Templates that enable its policy keep the key, which then scores 0.

Needs a key with the write scope. Authentication

curl -X DELETE https://api.useinfrared.com/v1/guidelines/gl_1LEog5dec7KKCgP7InZcWk \
  -H "Authorization: Bearer $INFRARED_KEY"
200 OKResponse
{
  "deleted": true,
  "id": "gl_1LEog5dec7KKCgP7InZcWk"
}

Path parameters

idstringRequired

Id of the guideline: gl_ plus 22 base62 characters.

Returns

An object with deleted set to true and the id of the deleted guideline.

  • 200 OKAn object

Errors

404
not_found

The key's project has no guideline with this id.

Every endpoint can also answer the errors any request can meet: a missing key, a rate limit, a malformed body. Errors

Something missing or unclear on this page? Write to support@useinfrared.com.