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 Collections API

The **Collections** endpoints enable you to manage your Postman [Collections](https://learning.postman.com/docs/sending-requests/intro-to-collections/).

This API exposes 29 operations across 21 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.

29 operations 21 paths 27 schemas 3 DELETE11 GET2 PATCH9 POST4 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 Collections 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 29

Across 21 paths, the API surfaces 29 operations — 3 DELETE, 11 GET, 2 PATCH, 9 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Collections 29

The Collections endpoints enable you to manage your Postman [Collections](https://learning.postman.com/docs/sending-requests/intro-to-collections/).

POST
/apis/{apiId}/collections
APIs.io Engineering Platform Add a collection
addApiCollection 2 params body → 200400401403404500
GET
/apis/{apiId}/collections/{collectionId}
APIs.io Engineering Platform Get a collection
getApiCollection 4 params → 200400401403404422500
PUT
/apis/{apiId}/collections/{collectionId}/sync-with-schema-tasks
APIs.io Engineering Platform Sync collection with schema
syncCollectionWithSchema 3 params → 202400401403404422500
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
GET
/collections
APIs.io Engineering Platform Get all collections
getCollections 2 params → 200401500
POST
/collections
APIs.io Engineering Platform Create a collection
createCollection 1 param body → 200400401500
POST
/collections/fork/{collectionId}
APIs.io Engineering Platform Create a fork
createCollectionFork 2 params body → 200401404500
POST
/collections/merge
APIs.io Engineering Platform Merge a fork
mergeCollectionFork body → 200401403404500
GET
/collections/{collectionId}
APIs.io Engineering Platform Get a collection
getCollection 3 params → 200400401500
PUT
/collections/{collectionId}
APIs.io Engineering Platform Replace a collection's data
putCollection 1 param body → 200400401403404500
PATCH
/collections/{collectionId}
APIs.io Engineering Platform Update part of a collection
patchCollection 1 param body → 200400401403404500
DELETE
/collections/{collectionId}
APIs.io Engineering Platform Delete a collection
deleteCollection 1 param → 200401404500
GET
/collections/{collectionId}/collection-forks
APIs.io Engineering Platform Get all forked collections
getCollectionsForkedByUser 4 params → 200400401500
GET
/collections/{collectionId}/comments
APIs.io Engineering Platform Get a collection's comments
getCollectionComments 1 param → 200401403404500
POST
/collections/{collectionId}/comments
APIs.io Engineering Platform Create a collection comment
createCollectionComment 1 param body → 201401403404500
PUT
/collections/{collectionId}/comments/{commentId}
APIs.io Engineering Platform Update a collection's comment
updateCollectionComment 2 params body → 200401403404500
DELETE
/collections/{collectionId}/comments/{commentId}
APIs.io Engineering Platform Delete a collection's comment
deleteCollectionComment 2 params → 204401403404500
GET
/collections/{collectionId}/forks
APIs.io Engineering Platform Get a collection's forks
getCollectionForks 4 params → 200400404500
PUT
/collections/{collectionId}/pulls
APIs.io Engineering Platform Pull source changes
pullCollectionChanges 1 param → 200400404500
GET
/collections/{collectionId}/pull-requests
APIs.io Engineering Platform Get a collection's pull requests
getCollectionPullRequests 1 param → 200403500
POST
/collections/{collectionId}/pull-requests
APIs.io Engineering Platform Create a pull request
createCollectionPullRequest 1 param body → 200400403500
GET
/collections/{collectionId}/roles
APIs.io Engineering Platform Get a collection's roles
getCollectionRoles 1 param → 200401403404500
PATCH
/collections/{collectionId}/roles
APIs.io Engineering Platform Update a collection's roles
updateCollectionRoles 1 param body → 204400401403404500
GET
/collections/{collectionId}/source-status
APIs.io Engineering Platform Get source collection's status
getSourceCollectionStatus 1 param → 200400500
GET
/collections/{collectionId}/transformations
APIs.io Engineering Platform Transform collection to OpenAPI
transformCollectionToOpenAPI 2 params → 200401404500
POST
/collection-folders-transfers
APIs.io Engineering Platform Transfer folders
transferCollectionFolders body → 200400500
POST
/collection-requests-transfers
APIs.io Engineering Platform Transfer requests
transferCollectionRequests body → 200400500
POST
/collection-responses-transfers
APIs.io Engineering Platform Transfer responses
transferCollectionResponses body → 200400500

Schemas 27

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

getCollection
object
1 property
comment403Error
object
4 properties
workspaceId
string
cursor
string
api403ErrorForbidden
object
3 properties
getCollectionAccessKeys
object
2 properties
apiCollection404ErrorNotFound
object
1 property
v10HeaderMissing
object
2 properties
apiVersionId
string
cakNotFound404Error
object
4 properties
transferCollectionItems
object
4 properties 4 required
apiSchema403ErrorForbidden
object
3 properties
apiSchema404ErrorNotFound
object
3 properties
pullRequest403ErrorNoViewerAccessCollections
object
4 properties
pullRequest400ErrorDuplicate
object
4 properties
api404ErrorNotFound
object
3 properties
common403Error
object
4 properties
api400ErrorVersionIdMissing
object
3 properties
commentCreateUpdate
object
Information about the comment.
2 properties 1 required
commentResponse
object
1 property
forkCollection400ErrorBadForkRelation
object
4 properties
apiCollection400InvalidParam
object
3 properties
commentCreatedUpdated
object
1 property
featureUnavailable403Error
object
4 properties
limit
integer
pullRequest403ErrorRolePermissionsCollection
object
4 properties
ascDesc
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-collections-api-openapi.yml Raw ↑