How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Secret-Scanning API

Retrieve secret scanning alerts from a repository.

APIs.io Engineering Platform Secret-Scanning API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Secret Scanning. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 27 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.

6 operations 5 paths 27 schemas 5 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://{bucketname}.s3.amazonaws.com
Contact
License
Terms of Service
Resource Areas
1

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 5 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Secret-Scanning 6

Retrieve secret scanning alerts from a repository.

GET
/enterprises/{enterprise}/secret-scanning/alerts
APIs.io Engineering Platform List secret scanning alerts for an enterprise
secret-scanning/list-alerts-for-enterprise 9 params → 200404503
GET
/orgs/{org}/secret-scanning/alerts
APIs.io Engineering Platform List secret scanning alerts for an organization
secret-scanning/list-alerts-for-org 10 params → 200404503
GET
/repos/{owner}/{repo}/secret-scanning/alerts
APIs.io Engineering Platform List secret scanning alerts for a repository
secret-scanning/list-alerts-for-repo 11 params → 200404503
GET
/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}
APIs.io Engineering Platform Get a secret scanning alert
secret-scanning/get-alert 3 params → 200304404503
PATCH
/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}
APIs.io Engineering Platform Update a secret scanning alert
secret-scanning/update-alert 3 params body → 200400404422503
GET
/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations
APIs.io Engineering Platform List locations for a secret scanning alert
secret-scanning/list-locations-for-alert 5 params → 200404503

Schemas 27

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

alert-html-url
string
The GitHub URL of the alert resource.
secret-scanning-location-commit
object
Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
9 properties 9 required
alert-number
integer
The security alert number.
secret-scanning-alert-resolution
stringnull
Required when the state is resolved. The reason for resolving the alert.
secret-scanning-location-discussion-comment
object
Represents a 'discussioncomment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
1 property 1 required
secret-scanning-location-issue-comment
object
Represents an 'issuecomment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
1 property 1 required
secret-scanning-alert
object
17 properties
secret-scanning-location-pull-request-review-comment
object
Represents a 'pullrequestreviewcomment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull reques…
1 property 1 required
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
secret-scanning-location-discussion-title
object
Represents a 'discussiontitle' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
1 property 1 required
simple-repository
object
A GitHub repository.
46 properties 46 required
secret-scanning-alert-state
string
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
basic-error
object
Basic Error
4 properties
secret-scanning-location-pull-request-body
object
Represents a 'pullrequestbody' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
1 property 1 required
secret-scanning-location-pull-request-title
object
Represents a 'pullrequesttitle' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
1 property 1 required
secret-scanning-location-discussion-body
object
Represents a 'discussionbody' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
1 property 1 required
organization-secret-scanning-alert
object
18 properties
secret-scanning-location-issue-body
object
Represents an 'issuebody' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
1 property 1 required
secret-scanning-location
object
2 properties 2 required
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
alert-url
string
The REST API URL of the alert resource.
simple-user
object
A GitHub user.
21 properties 18 required
secret-scanning-location-pull-request-review
object
Represents a 'pullrequestreview' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
1 property 1 required
nullable-alert-updated-at
stringnull
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
secret-scanning-alert-resolution-comment
stringnull
An optional comment when closing an alert. Cannot be updated or deleted. Must be null when changing state to open.
secret-scanning-location-pull-request-comment
object
Represents a 'pullrequestcomment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
1 property 1 required
secret-scanning-location-issue-title
object
Represents an 'issuetitle' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-secret-scanning-api-openapi.yml Raw ↑

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Secret-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.