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 Collection Access Keys API

The **Collection Access Keys** endpoints enable you to manage your [collection access keys](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-collection-access-key). Collection access keys enable you to securely grant other users read-only access to a collection.Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days.

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

2 operations 2 paths 3 schemas 1 DELETE1 GET

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 Collection Access Keys 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 2

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

Collection Access Keys 2

The Collection Access Keys endpoints enable you to manage your [collection access keys](https://learning.postman.com/docs/developer/postman-api/authentication/generate-a-collectio…

GET
/collection-access-keys
APIs.io Engineering Platform Get collection access keys
getCollectionAccessKeys 2 params → 200400401403500
DELETE
/collection-access-keys/{keyId}
APIs.io Engineering Platform Delete a collection access key
deleteCollectionAccessKey 1 param → 204401403404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are cakNotFound404Error (4 properties), getCollectionAccessKeys (2 properties). Each schema is shown below with its type and property counts.

getCollectionAccessKeys
object
2 properties
cakNotFound404Error
object
4 properties
cursor
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-collection-access-keys-api-openapi.yml Raw ↑