APIs.io Engineering Platform Code Scanning API

Retrieve code scanning alerts from a repository.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 13 operations across 10 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against a single base URL, {protocol}://{hostname}/api/v3.

13 operations 10 paths 50 schemas 1 DELETE9 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.2.0

API Version

1.1.4

Base URL

https://api.cloudflare.com/client/v4

Contact

Support

License

MIT

View terms

Resource Areas

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 1 DELETE, 9 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Code Scanning 13

Retrieve code scanning alerts from a repository.

GET

/enterprises/{enterprise}/code-scanning/alerts

APIs.io Engineering Platform List code scanning alerts for an enterprise

code-scanning/list-alerts-for-enterprise 10 params → 200404503

GET

/orgs/{org}/code-scanning/alerts

APIs.io Engineering Platform List code scanning alerts for an organization

code-scanning/list-alerts-for-org 11 params → 200404503

GET

/repos/{owner}/{repo}/code-scanning/alerts

APIs.io Engineering Platform List code scanning alerts for a repository

code-scanning/list-alerts-for-repo 11 params → 200304403404503

GET

/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}

APIs.io Engineering Platform Get a code scanning alert

code-scanning/get-alert 3 params → 200304403404503

PATCH

/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}

APIs.io Engineering Platform Update a code scanning alert

code-scanning/update-alert 3 params body → 200403404503

GET

/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances

APIs.io Engineering Platform List instances of a code scanning alert

code-scanning/list-alert-instances 6 params → 200403404503

GET

/repos/{owner}/{repo}/code-scanning/analyses

APIs.io Engineering Platform List code scanning analyses for a repository

code-scanning/list-recent-analyses 10 params → 200403404503

GET

/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}

APIs.io Engineering Platform Get a code scanning analysis for a repository

code-scanning/get-analysis 3 params → 200403404503

DELETE

/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}

APIs.io Engineering Platform Delete a code scanning analysis from a repository

code-scanning/delete-analysis 4 params → 200400403404503

GET

/repos/{owner}/{repo}/code-scanning/default-setup

APIs.io Engineering Platform Get a code scanning default setup configuration

code-scanning/get-default-setup 2 params → 200403404503

PATCH

/repos/{owner}/{repo}/code-scanning/default-setup

APIs.io Engineering Platform Update a code scanning default setup configuration

code-scanning/update-default-setup 2 params body → 200202403404409503

POST

/repos/{owner}/{repo}/code-scanning/sarifs

APIs.io Engineering Platform Upload an analysis as SARIF data

code-scanning/upload-sarif 2 params body → 202400403404413503

GET

/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}

APIs.io Engineering Platform Get information about a SARIF upload

code-scanning/get-sarif 3 params → 200403404503

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are simple-repository (46 properties), nullable-simple-user (21 properties), simple-user (21 properties), code-scanning-organization-alert-items (16 properties). Each schema is shown below with its type and property counts.

code-scanning-default-setup

object

Configuration for code scanning default setup.

4 properties

code-scanning-analysis-deletion

object

Successful deletion of a code scanning analysis

2 properties 2 required

code-scanning-analysis-analysis-key

string

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

alert-html-url

string

The GitHub URL of the alert resource.

code-scanning-analysis-tool-version

stringnull

The version of the tool used to generate the code scanning analysis.

code-scanning-analysis-tool-guid

stringnull

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.

alert-number

integer

The security alert number.

code-scanning-analysis-sarif-file

string

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [gzip](http://www.gnu.org/software/gzip/manual/gzip.html)…

simple-user

object

A GitHub user.

21 properties 18 required

scim-error

object

Scim Error

6 properties

alert-fixed-at

stringnull

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-sarifs-status

object

3 properties

code-scanning-analysis-tool-name

string

The name of the tool used to generate the code scanning analysis.

code-scanning-ref-full

string

The full Git reference, formatted as refs/heads/ , refs/tags/ , refs/pull/ /merge, or refs/pull/ /head.

code-scanning-sarifs-receipt

object

2 properties

empty-object

object

An object without any properties.

code-scanning-alert-dismissed-reason

stringnull

Required when the state is dismissed. The reason for dismissing or closing the alert.

code-scanning-analysis-url

string

The REST API URL of the analysis resource.

code-scanning-ref

string

The Git reference, formatted as refs/pull/ /merge, refs/pull/ /head, refs/heads/ or simply .

code-scanning-analysis-category

string

Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed o…

code-scanning-alert-rule-summary

object

6 properties

basic-error

object

Basic Error

4 properties

code-scanning-alert-location

object

Describe a region within a file for the alert.

5 properties

code-scanning-alert-environment

string

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language tha…

simple-repository

object

A GitHub repository.

46 properties 46 required

code-scanning-analysis-tool

object

3 properties

code-scanning-alert-dismissed-comment

stringnull

The dismissal comment associated with the dismissal of the alert.

nullable-simple-user

objectnull

A GitHub user.

21 properties 18 required

code-scanning-analysis-sarif-id

string

An identifier for the upload.

code-scanning-alert-severity

string

Severity of a code scanning alert.

code-scanning-alert

object

15 properties 12 required

alert-dismissed-at

stringnull

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-alert-state-query

string

State of a code scanning alert.

code-scanning-alert-set-state

string

Sets the state of the code scanning alert. You must provide dismissedreason when you set the state to dismissed.

code-scanning-alert-instance

object

10 properties

code-scanning-analysis

object

15 properties 14 required

code-scanning-alert-rule

object

9 properties

alert-updated-at

string

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-analysis-commit-sha

string

The SHA of the commit to which the analysis you are uploading relates.

code-scanning-alert-classification

stringnull

A classification of the file. For example to identify it as generated.

code-scanning-default-setup-update-response

object

You can use runurl to track the status of the run. This includes a property status and conclusion. You should not rely on this always being an actions workflow…

2 properties

code-scanning-alert-state

string

State of a code scanning alert.

alert-instances-url

string

The REST API URL for fetching the list of instances for an alert.

alert-created-at

string

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-default-setup-update

object

Configuration for code scanning default setup.

2 properties 1 required

code-scanning-organization-alert-items

object

16 properties 13 required

code-scanning-alert-items

object

15 properties 12 required

code-scanning-analysis-created-at

string

The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-scanning-analysis-environment

string

Identifies the variable values associated with the environment in which this analysis was performed.

alert-url

string

The REST API URL of the alert resource.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Code Scanning

← Back to A APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=engineering-platform-code-scanning-api&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/engineering-platform-code-scanning-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Code Scanning API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Code Scanning API

Metadata

Paths & Operations 13

Schemas 50

Specification

Source

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key