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

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

This API exposes 9 operations across 5 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.

9 operations 5 paths 5 schemas 1 DELETE3 GET4 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 Environments 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 9

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

Environments 9

The Environments endpoints enable you to manage your Postman [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).

GET
/environments
APIs.io Engineering Platform Get all environments
getEnvironments 1 param → 200401404500
POST
/environments
APIs.io Engineering Platform Create an environment
createEnvironment 1 param body → 200400401403500
GET
/environments/{environmentId}
APIs.io Engineering Platform Get an environment
getEnvironment 1 param → 200400401500
PUT
/environments/{environmentId}
APIs.io Engineering Platform Update an environment
updateEnvironment 1 param body → 200400401500
DELETE
/environments/{environmentId}
APIs.io Engineering Platform Delete an environment
deleteEnvironment 1 param → 200401404500
POST
/environments/{environmentId}/forks
APIs.io Engineering Platform Create a fork
forkEnvironment 2 params body → 200401404500
GET
/environments/{environmentId}/forks
APIs.io Engineering Platform Get an environment's forks
getEnvironmentForks 5 params → 200400401404500
POST
/environments/{environmentId}/merges
APIs.io Engineering Platform Merge a fork
mergeEnvironmentFork 1 param body → 200400401404500
POST
/environments/{environmentId}/pulls
APIs.io Engineering Platform Pull source changes
pullEnvironment 1 param body → 200400401404500

Schemas 5

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

workspaceId
string
limit
integer
common403Error
object
4 properties
ascDesc
string
cursor
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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