This API exposes
11 operations
across 8 paths,
and defines 10 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.
11 operations8 paths10 schemas2 DELETE7 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Migrations 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 11
Across 8 paths, the API surfaces 11 operations — 2 DELETE, 7 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Migrations 11
Move projects to or from GitHub.
GET
/orgs/{org}/migrations
APIs.io Engineering Platform List organization migrations
migrations/list-for-org4 params→ 200
POST
/orgs/{org}/migrations
APIs.io Engineering Platform Start an organization migration
migrations/start-for-org1 parambody→ 201404422
GET
/orgs/{org}/migrations/{migration_id}
APIs.io Engineering Platform Get an organization migration status
migrations/get-status-for-org3 params→ 200404
GET
/orgs/{org}/migrations/{migration_id}/archive
APIs.io Engineering Platform Download an organization migration archive
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), minimal-repository (87 properties), nullable-simple-user (21 properties), simple-user (21 properties). Each schema is shown below with its type and property counts.
nullable-simple-user
object
A GitHub user.
21 properties18 required
repository
object
A repository on GitHub.
95 properties73 required
code-of-conduct
object
Code Of Conduct
5 properties4 required
basic-error
object
Basic Error
4 properties
validation-error
object
Validation Error
3 properties2 required
migration
object
A migration.
18 properties16 required
simple-user
object
A GitHub user.
21 properties18 required
minimal-repository
object
Minimal Repository
87 properties46 required
nullable-license-simple
object
License Simple
6 properties5 required
security-and-analysis
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
