Guardrails

Redirect Base Route

get

Responses

200

Successful Response

application/json

Responseany

404

Not found

get

/api/guardrails/

HTTPcURLJavaScriptPython

GET /api/guardrails/ HTTP/1.1
Host: 
Accept: */*

No content

List Guardrails

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptionalDefault: 0

limitinteger · min: 1OptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

ordersany ofOptional

string[]Optional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/guardrails

HTTPcURLJavaScriptPython

GET /api/guardrails HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": 1,
      "title": "text",
      "scope_type": "Global",
      "scope_params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "action": "Block",
      "enabled": true,
      "created_at": "2025-12-14T11:07:11.670Z",
      "updated_at": "2025-12-14T11:07:11.670Z",
      "success_rate": 1,
      "success_rate_delta": 1,
      "rules": [
        {
          "id": 1,
          "entity_type": "Dependency",
          "rule_type": "Vulnerability",
          "rule_config": {
            "rule_sub_type": "text",
            "rule_params": {
              "threshold": 5,
              "operator": "<",
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        }
      ],
      "executions_last_30_days": 1,
      "last_executed": "2025-12-14T11:07:11.670Z"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Create Guardrail

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

titlestringRequired

scope_typestring · enumRequiredPossible values:

scope_paramsany ofOptional

or

nullOptional

actionstring · enumRequiredPossible values:

enabledbooleanOptionalDefault: true

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

/api/guardrails

HTTPcURLJavaScriptPython

POST /api/guardrails HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 284

{
  "title": "text",
  "scope_type": "Global",
  "scope_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "action": "Block",
  "enabled": true,
  "rules": [
    {
      "id": 1,
      "entity_type": "Dependency",
      "rule_type": "Vulnerability",
      "rule_sub_type": "Active Exploit",
      "rule_params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

No content

Get Supported Rules

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

get

/api/guardrails/supported_rules

HTTPcURLJavaScriptPython

GET /api/guardrails/supported_rules HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Supported Scopes

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

get

/api/guardrails/supported_scopes

HTTPcURLJavaScriptPython

GET /api/guardrails/supported_scopes HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Supported Scope Param Values

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scope_typestring · enumRequiredPossible values:

paramstringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/guardrails/supported_scopes/{scope_type}/params/{param}

HTTPcURLJavaScriptPython

GET /api/guardrails/supported_scopes/{scope_type}/params/{param} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Get Supported Actions

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

get

/api/guardrails/supported_actions

HTTPcURLJavaScriptPython

GET /api/guardrails/supported_actions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "Block"
]

Get Supported Licenses

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

Responsestring[]

404

Not found

get

/api/guardrails/supported_licenses

HTTPcURLJavaScriptPython

GET /api/guardrails/supported_licenses HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "text"
]

Update Guardrail

put

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

guardrail_idintegerRequired

Body

application/json

titlestringRequired

scope_typestring · enumRequiredPossible values:

scope_paramsany ofOptional

or

nullOptional

actionstring · enumRequiredPossible values:

enabledbooleanOptionalDefault: true

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

put

/api/guardrails/{guardrail_id}

HTTPcURLJavaScriptPython

PUT /api/guardrails/{guardrail_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 284

{
  "title": "text",
  "scope_type": "Global",
  "scope_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "action": "Block",
  "enabled": true,
  "rules": [
    {
      "id": 1,
      "entity_type": "Dependency",
      "rule_type": "Vulnerability",
      "rule_sub_type": "Active Exploit",
      "rule_params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

No content

Delete Guardrail

delete

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

delete

/api/guardrails/{id}

HTTPcURLJavaScriptPython

DELETE /api/guardrails/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Guardrail Executions

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

code_root_idany ofOptional

integerOptional

or

nullOptional

pageintegerOptionalDefault: 0

limitinteger · min: 1OptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

ordersany ofOptional

string[]Optional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Bodyany of[]

application/json

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/guardrails/executions

HTTPcURLJavaScriptPython

POST /api/guardrails/executions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "check_run_id": 1,
      "executed_at": "2025-12-14T11:07:11.670Z",
      "external_url": "text",
      "entity_type": "Dependency",
      "rule_type": "Vulnerability",
      "rule_sub_type": "Active Exploit",
      "scope_type": "Global",
      "rule_params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "scope_params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "title": "text",
      "rules": [
        {
          "entity_type": "Dependency",
          "rule_type": "Vulnerability",
          "rule_sub_type": "Active Exploit",
          "rule_params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ],
      "scopes": [
        {
          "scope_type": "Global",
          "scope_params": {}
        }
      ],
      "action": "Block",
      "guardrail_name": "text",
      "result": "Pass",
      "violations_count": 1,
      "contributor": "text",
      "identity": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "violations": [
        {
          "file": "text",
          "line": 1,
          "content": "text"
        }
      ]
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Guardrail Execution Filter Terms

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

code_root_idany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/guardrails/executions/_terms

HTTPcURLJavaScriptPython

GET /api/guardrails/executions/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "lazy_load": false,
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

Get Guardrail Execution

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

get

/api/guardrails/executions/{id}

HTTPcURLJavaScriptPython

GET /api/guardrails/executions/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Guardrail Executions For Guardrail

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

guardrail_idintegerRequired

Query parameters

pageintegerOptionalDefault: 0

limitinteger · min: 1OptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

ordersany ofOptional

string[]Optional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Bodyany of[]

application/json

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/guardrails/{guardrail_id}/executions

HTTPcURLJavaScriptPython

POST /api/guardrails/{guardrail_id}/executions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "executed_at": "2025-12-14T11:07:11.670Z",
      "external_url": "text",
      "result": "Pass",
      "contributor": "text",
      "violations": [
        {
          "file": "text",
          "line": 1,
          "content": "text"
        }
      ],
      "code_root": "text",
      "code_root_id": 1,
      "repository_type": "text",
      "repository_owner": "text",
      "repository_id": "text",
      "repository": "text",
      "pr_url": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Guardrail Execution Modal Filter Terms

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

get

/api/guardrails/executions/modal/_terms

HTTPcURLJavaScriptPython

GET /api/guardrails/executions/modal/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "lazy_load": false,
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

Get Guardrail Violations Filter Terms

get

Get filter terms for the guardrail violations endpoint

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

get

/api/guardrails/violations/_terms

HTTPcURLJavaScriptPython

GET /api/guardrails/violations/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "lazy_load": false,
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

List Guardrail Violations

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptionalDefault: 0

limitinteger · min: 1OptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

ordersany ofOptional

string[]Optional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Bodyany of[]

application/json

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/guardrails/violations

HTTPcURLJavaScriptPython

GET /api/guardrails/violations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "check_run_id": 1,
      "executed_at": "2025-12-14T11:07:11.670Z",
      "external_url": "text",
      "pr_url": "text",
      "repo_url": "text",
      "guardrail_id": 1,
      "guardrail_name": "text",
      "action": "Block",
      "violations_count": 1,
      "violations": [
        {
          "file": "text",
          "line": 1,
          "content": "text"
        }
      ],
      "repository_id": "text",
      "repository_owner": "text",
      "repository": "text",
      "repository_type": "text",
      "code_root": "text",
      "code_root_id": 1,
      "contributor": "text",
      "identity": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

List Guardrail Violations

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptionalDefault: 0

limitinteger · min: 1OptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

ordersany ofOptional

string[]Optional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Bodyany of[]

application/json

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/guardrails/violations

HTTPcURLJavaScriptPython

POST /api/guardrails/violations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "check_run_id": 1,
      "executed_at": "2025-12-14T11:07:11.670Z",
      "external_url": "text",
      "pr_url": "text",
      "repo_url": "text",
      "guardrail_id": 1,
      "guardrail_name": "text",
      "action": "Block",
      "violations_count": 1,
      "violations": [
        {
          "file": "text",
          "line": 1,
          "content": "text"
        }
      ],
      "repository_id": "text",
      "repository_owner": "text",
      "repository": "text",
      "repository_type": "text",
      "code_root": "text",
      "code_root_id": 1,
      "contributor": "text",
      "identity": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}