This API exposes
6 operations
across 5 paths,
and defines 27 schemas.
It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
6 operations5 paths27 schemas5 GET1 PATCH
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Secret-Scanning API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
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
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.
nullable-simple-user
object
A GitHub user.
21 properties18 required
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 property1 required
alert-number
integer
The security alert number.
nullable-alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
alert-html-url
string
The GitHub URL of the alert resource.
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 property1 required
basic-error
object
Basic Error
4 properties
secret-scanning-alert-state
string
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
secret-scanning-location
object
2 properties2 required
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 property1 required
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
secret-scanning-alert
object
17 properties
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 property1 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 property1 required
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 property1 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 property1 required
secret-scanning-alert-resolution
string
Required when the state is resolved. The reason for resolving the alert.
simple-user
object
A GitHub user.
21 properties18 required
secret-scanning-alert-resolution-comment
string
An optional comment when closing an alert. Cannot be updated or deleted. Must be null when changing state to open.
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 property1 required
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 properties9 required
simple-repository
object
A GitHub repository.
46 properties46 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 property1 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.
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 property1 required
organization-secret-scanning-alert
object
18 properties
alert-url
string
The REST API URL of the alert resource.
Specification
The full machine-readable OpenAPI contract behind this narrative.
