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 Detected Secrets API

The **Detected Secrets** endpoints enable you to manage secrets detected by the Postman [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/).

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

3 operations 3 paths 17 schemas 1 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 Detected Secrets 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 3

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

Detected Secrets 3

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

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

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are detectedSecretsQueriesRequest (5 properties), secretScanner400Error (4 properties), featureUnavailable403Error (4 properties), secretScanner403Error (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
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-detected-secrets-api-openapi.yml Raw ↑