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

Endpoints that give information about the API.

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

4 operations 4 paths 2 schemas 4 GET

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 Meta 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 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Meta 4

Endpoints that give information about the API.

GET
/
APIs.io Engineering Platform GitHub API Root
meta/root → 200
GET
/meta
APIs.io Engineering Platform Get GitHub Enterprise Server meta information
meta/get → 200304
GET
/octocat
APIs.io Engineering Platform Get Octocat
meta/get-octocat 1 param → 200
GET
/zen
APIs.io Engineering Platform Get the Zen of GitHub
meta/get-zen → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are root (33 properties), api-overview (6 properties). Each schema is shown below with its type and property counts.

api-overview
object
Api Overview
6 properties 1 required
root
object
33 properties 31 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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