Skip to main content
DELETE
/
policies
/
{policy_id}
Deactivate Policy
curl --request DELETE \
  --url https://www.corgea.app/api/v1/policies/{policy_id} \
  --header 'CORGEA-TOKEN: <api-key>'
{
  "status": "ok",
  "policy": {
    "id": 123,
    "description": "<string>",
    "cwes": [
      "<string>"
    ],
    "excludes": [
      "<string>"
    ],
    "projects": [
      "<string>"
    ],
    "company": 123,
    "active": true,
    "approved": true,
    "approved_by": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "glob_pattern": "<string>",
    "source_type": "Web",
    "repo_policy_file": 123,
    "name": "<string>",
    "guidance_text": "<string>",
    "version": 123,
    "archived": true,
    "parent_policy": 123,
    "read_only": true,
    "created_by_corgea": true
  }
}

Authorizations

CORGEA-TOKEN
string
header
required

API key for authentication

Path Parameters

policy_id
integer
required

The ID of the policy

Response

Policy deactivated successfully

status
string
Example:

"ok"

policy
object