Skip to main content
POST
/
policies
Create Policy
curl --request POST \
  --url https://www.corgea.app/api/v1/policies \
  --header 'CORGEA-TOKEN: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "cwes": [
    "<string>"
  ],
  "excludes": [
    "<string>"
  ],
  "projects": [
    "<string>"
  ],
  "active": true,
  "instruction_type": "overwrite",
  "glob_pattern": "<string>",
  "guidance_text": "<string>"
}
'
{
  "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

Body

application/json
policy_type
enum<string>
required
Available options:
BLAST,
scan,
false_positive,
fix
description
string
required
Minimum string length: 10
name
string
required
Minimum string length: 3
cwes
string[] | null
excludes
string[] | null
projects
(string | integer)[] | null

Project names or IDs that scope the policy. Empty or null creates a company-wide policy.

active
boolean
default:true
instruction_type
enum<string>
default:overwrite
Available options:
overwrite,
append
glob_pattern
string | null
Maximum string length: 255
guidance_text
string | null
Maximum string length: 3000

Response

Policy created successfully

policy
object