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 Custom Pages for an Account API

The Custom Pages for an Account API from APIs.io Engineering Platform — 2 operation(s) for custom pages for an account.

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

3 operations 2 paths 11 schemas 2 GET1 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 Custom Pages for an Account 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 3

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

Custom Pages for an Account 3
GET
/accounts/{account_identifier}/custom_pages
APIs.io Engineering Platform List custom pages
custom-pages-for-an-account-list-custom-pages 1 param → 4xx200
GET
/accounts/{account_identifier}/custom_pages/{identifier}
APIs.io Engineering Platform Get a custom page
custom-pages-for-an-account-get-a-custom-page 2 params → 4xx200
PUT
/accounts/{account_identifier}/custom_pages/{identifier}
APIs.io Engineering Platform Update a custom page
custom-pages-for-an-account-update-a-custom-page 2 params body → 4xx200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are custom-pages_result_info (4 properties), custom-pages_api-response-common-failure (4 properties), custom-pages_api-response-common (4 properties). Each schema is shown below with its type and property counts.

custom-pages_result_info
object
4 properties
custom-pages_custom_pages_response_collection
custom-pages_api-response-common
object
4 properties 4 required
custom-pages_api-response-common-failure
object
4 properties 4 required
custom-pages_api-response-single
object
custom-pages_identifier
string
Identifier
custom-pages_messages
array
custom-pages_api-response-collection
object
custom-pages_custom_pages_response_single
custom-pages_url
string
The URL associated with the custom page.
custom-pages_state
string
The custom page state.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-custom-pages-for-an-account-api-openapi.yml Raw ↑