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 Pages Domains API

The Pages Domains API from APIs.io Engineering Platform — 2 operation(s) for pages domains.

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

5 operations 2 paths 12 schemas 1 DELETE2 GET1 PATCH1 POST

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 Pages Domains 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 5

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

Pages Domains 5
GET
/accounts/{account_id}/pages/projects/{project_name}/domains
APIs.io Engineering Platform Get domains
pages-domains-get-domains 2 params → 4XX200
POST
/accounts/{account_id}/pages/projects/{project_name}/domains
APIs.io Engineering Platform Add domain
pages-domains-add-domain 2 params body → 4XX200
DELETE
/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}
APIs.io Engineering Platform Delete domain
pages-domains-delete-domain 3 params body → 4xx200
GET
/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}
APIs.io Engineering Platform Get domain
pages-domains-get-domain 3 params → 4XX200
PATCH
/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}
APIs.io Engineering Platform Patch domain
pages-domains-patch-domain 3 params body → 4XX200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are pages_domain-object (9 properties), pages_api-response-common-failure (4 properties), pages_api-response-common (3 properties), pages_api-response-pagination (1 property). Each schema is shown below with its type and property counts.

pages_api-response-common-failure
object
4 properties 4 required
pages_api-response-common
object
3 properties 4 required
pages_api-response-single
object
pages_messages
array
pages_domain-object
object
9 properties
pages_api-response-pagination
object
1 property
pages_project_name
string
Name of the project.
pages_domains-post
object
1 property
pages_domain-response-single
pages_domain_name
string
Name of the domain.
pages_identifier
string
Identifier
pages_domain-response-collection

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-pages-domains-api-openapi.yml Raw ↑