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

The **Mocks** endpoints enable you to manage your [mock servers](https://learning.postman.com/docs/designing-and-developing-your-api/mocking-data/setting-up-mock/).

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

13 operations 7 paths 5 schemas 3 DELETE5 GET3 POST2 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 Mocks 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 13

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

Mocks 13

The Mocks endpoints enable you to manage your [mock servers](https://learning.postman.com/docs/designing-and-developing-your-api/mocking-data/setting-up-mock/).

GET
/mocks
APIs.io Engineering Platform Get all mock servers
getMocks 2 params → 200401500
POST
/mocks
APIs.io Engineering Platform Create a mock server
createMock 1 param body → 200400401500
GET
/mocks/{mockId}
APIs.io Engineering Platform Get a mock server
getMock 1 param → 200401404500
PUT
/mocks/{mockId}
APIs.io Engineering Platform Update a mock server
updateMock 1 param body → 200401404500
DELETE
/mocks/{mockId}
APIs.io Engineering Platform Delete a mock server
deleteMock 1 param → 200401404500
GET
/mocks/{mockId}/call-logs
APIs.io Engineering Platform Get a mock server's call logs
getMockCallLogs 12 params → 200400401404500
POST
/mocks/{mockId}/publish
APIs.io Engineering Platform Publish a mock server
publishMock 1 param → 200400401404500
DELETE
/mocks/{mockId}/unpublish
APIs.io Engineering Platform Unpublish a mock server
unpublishMock 1 param → 200400401404500
GET
/mocks/{mockId}/server-responses
APIs.io Engineering Platform Get all server responses
getMockServerResponses 1 param → 200401404500
POST
/mocks/{mockId}/server-responses
APIs.io Engineering Platform Create a server response
createMockServerResponse 1 param body → 200400401500
GET
/mocks/{mockId}/server-responses/{serverResponseId}
APIs.io Engineering Platform Get a server response
getMockServerResponse 4 params → 200400401404500
PUT
/mocks/{mockId}/server-responses/{serverResponseId}
APIs.io Engineering Platform Update a server response
updateMockServerResponse 2 params body → 200400401500
DELETE
/mocks/{mockId}/server-responses/{serverResponseId}
APIs.io Engineering Platform Delete a server response
deleteMockServerResponse 2 params → 200400401404500

Schemas 5

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

sinceDateTime
string
workspaceId
string
ascDesc
string
cursor
string
untilDateTime
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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