Sast

Get Sast Terms

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

get

/api/sast/_terms

HTTPcURLJavaScriptPython

GET /api/sast/_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 Repostiory Sast Findings

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

repository_idstringRequired

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/sast/{repository_id}/findings

HTTPcURLJavaScriptPython

POST /api/sast/{repository_id}/findings 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": [
    {
      "rule_name": "text",
      "rule_message": "text",
      "rule": {
        "category": "text",
        "confidence": "text",
        "cwe_names": [
          "text"
        ],
        "source": "text",
        "message": "text",
        "name": "text",
        "owasp_names": [
          "text"
        ],
        "subcategories": [
          "text"
        ],
        "vulnerability_classes": [
          "text"
        ]
      },
      "severity": "text",
      "confidence": "text",
      "categories": [
        "text"
      ],
      "finding_count": 1,
      "cwes": [
        {
          "id": "text",
          "title": "text"
        }
      ]
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Finding Rule Details

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

repository_idstringRequired

rule_namestringRequired

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

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/sast/{repository_id}/findings/{rule_name}

HTTPcURLJavaScriptPython

GET /api/sast/{repository_id}/findings/{rule_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "finding_id": 1,
      "file_name": "text",
      "line_number": 1,
      "line_of_code_url": "text",
      "relevant_since": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Finding Rule Details

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

repository_idstringRequired

rule_namestringRequired

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

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/sast/{repository_id}/findings/{rule_name}

HTTPcURLJavaScriptPython

POST /api/sast/{repository_id}/findings/{rule_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "finding_id": 1,
      "file_name": "text",
      "line_number": 1,
      "line_of_code_url": "text",
      "relevant_since": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}