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

The **Forks** endpoints enable you to manage element [forks](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/). Forks are new instances of an element that you can change without making any changes to the parent element.

This API exposes 10 operations across 9 paths, and defines 4 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.

10 operations 9 paths 4 schemas 4 GET5 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 Forks 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 10

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

Forks 10

The Forks endpoints enable you to manage element [forks](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/). Forks are new instanc…

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}/collection-forks
APIs.io Engineering Platform Get all forked collections
getCollectionsForkedByUser 4 params → 200400401500
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}/source-status
APIs.io Engineering Platform Get source collection's status
getSourceCollectionStatus 1 param → 200400500
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 4

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

workspaceId
string
limit
integer
ascDesc
string
cursor
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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