Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Secret Scanner API

The **Secret Scanner** endpoints enable you to manage the secrets detected by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/). These endpoints are only available on [**Enterprise** plans](https://www.postman.com/pricing/#enterprise-solutions) with the **Advanced Security Administration** add-on feature.

This API exposes 4 operations across 4 paths, and defines 18 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.

4 operations 4 paths 18 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Secret Scanner 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 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Secret Scanner 4

The Secret Scanner endpoints enable you to manage the secrets detected by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/). These endpo…

POST
/detected-secrets-queries
APIs.io Engineering Platform Search detected secrets
detectedSecretsQueries 5 params body → 200400401403500
PUT
/detected-secrets/{secretId}
APIs.io Engineering Platform Update detected secret resolution status
updateDetectedSecretResolutions 1 param body → 200400401403500
GET
/detected-secrets/{secretId}/locations
APIs.io Engineering Platform Get detected secrets locations
getDetectedSecretsLocations 6 params → 200400401403500
GET
/secret-types
APIs.io Engineering Platform Get secret types
getSecretTypes → 200401403500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are detectedSecretsQueriesRequest (5 properties), featureUnavailable403Error (4 properties), secretScanner401Error (4 properties), secretScanner500Error (4 properties). Each schema is shown below with its type and property counts.

sinceDateTime
string
updateSecretResolutionsRequest
object
2 properties 2 required
secretScanner403Error
object
4 properties
detectedSecretsQueriesRequest
object
5 properties
updateSecretResolutions
object
4 properties
secretScanner500Error
object
4 properties
getSecretsLocations
object
2 properties
secretScanner401Error
object
4 properties
workspaceId
string
featureUnavailable403Error
object
4 properties
limit
integer
cursor
string
getSecretTypes
object
2 properties
include
string
untilDateTime
string
secretId
string
detectedSecretsQueries
object
2 properties
secretScanner400Error
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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