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

The **Collection Items** endpoints enable you to manage a collection's items, such as folders and requests.

This API exposes 12 operations across 6 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.

12 operations 6 paths 3 schemas 3 DELETE3 GET3 POST3 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 Collection Items 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 12

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

Collection Items 12

The Collection Items endpoints enable you to manage a collection's items, such as folders and requests.

POST
/collections/{collectionId}/folders
APIs.io Engineering Platform Create a folder
createCollectionFolder 1 param body → 200400401500
POST
/collections/{collectionId}/requests
APIs.io Engineering Platform Create a request
createCollectionRequest 2 params body → 200400401500
POST
/collections/{collectionId}/responses
APIs.io Engineering Platform Create a response
createCollectionResponse 2 params body → 200400401500
GET
/collections/{collectionId}/folders/{folderId}
APIs.io Engineering Platform Get a folder
getCollectionFolder 5 params → 200401404500
PUT
/collections/{collectionId}/folders/{folderId}
APIs.io Engineering Platform Update a folder
updateCollectionFolder 2 params body → 200400401404500
DELETE
/collections/{collectionId}/folders/{folderId}
APIs.io Engineering Platform Delete a folder
deleteCollectionFolder 2 params → 200401404500
GET
/collections/{collectionId}/requests/{requestId}
APIs.io Engineering Platform Get a request
getCollectionRequest 5 params → 200401404500
PUT
/collections/{collectionId}/requests/{requestId}
APIs.io Engineering Platform Update a request
updateCollectionRequest 2 params body → 200400401404500
DELETE
/collections/{collectionId}/requests/{requestId}
APIs.io Engineering Platform Delete a request
deleteCollectionRequest 2 params → 200401404500
GET
/collections/{collectionId}/responses/{responseId}
APIs.io Engineering Platform Get a response
getCollectionResponse 5 params → 200401404500
PUT
/collections/{collectionId}/responses/{responseId}
APIs.io Engineering Platform Update a response
updateCollectionResponse 2 params body → 200400401404500
DELETE
/collections/{collectionId}/responses/{responseId}
APIs.io Engineering Platform Delete a response
deleteCollectionResponse 2 params → 200401404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

collectionRequestId
string
collectionFolderId
string
booleanQuery
boolean

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-collection-items-api-openapi.yml Raw ↑