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 Build Cache API

The Pages Build Cache API from APIs.io Engineering Platform — 1 operation(s) for pages build cache.

This API exposes 1 operation across 1 path, and defines 5 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.

1 operations 1 paths 5 schemas 1 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 Build Cache 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Pages Build Cache 1
POST
/accounts/{account_id}/pages/projects/{project_name}/purge_build_cache
APIs.io Engineering Platform Purge build cache
pages-purge-build-cache 2 params → 4XX200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are pages_api-response-common-failure (4 properties), pages_api-response-common (3 properties). 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_messages
array
pages_identifier
string
Identifier
pages_project_name
string
Name of the project.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-pages-build-cache-api-openapi.yml Raw ↑