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

The Pages Deployment API from APIs.io Engineering Platform — 5 operation(s) for pages deployment.

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

7 operations 5 paths 14 schemas 1 DELETE3 GET3 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 Deployment 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 7

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

Pages Deployment 7
GET
/accounts/{account_id}/pages/projects/{project_name}/deployments
APIs.io Engineering Platform Get deployments
pages-deployment-get-deployments 3 params → 4XX200
POST
/accounts/{account_id}/pages/projects/{project_name}/deployments
APIs.io Engineering Platform Create deployment
pages-deployment-create-deployment 2 params body → 4XX200
DELETE
/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}
APIs.io Engineering Platform Delete deployment
pages-deployment-delete-deployment 3 params body → 4XX200
GET
/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}
APIs.io Engineering Platform Get deployment info
pages-deployment-get-deployment-info 3 params → 4XX200
GET
/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs
APIs.io Engineering Platform Get deployment logs
pages-deployment-get-deployment-logs 3 params → 4XX200
POST
/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry
APIs.io Engineering Platform Retry deployment
pages-deployment-retry-deployment 3 params body → 4XX200
POST
/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback
APIs.io Engineering Platform Rollback deployment
pages-deployment-rollback-deployment 3 params body → 4XX200

Schemas 14

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

pages_api-response-common-failure
object
4 properties 4 required
pages_deployment-response-details
pages_api-response-common
object
3 properties 4 required
pages_deployment-response-logs
pages_deployments
object
16 properties
pages_api-response-pagination
object
1 property
pages_source
object
2 properties
pages_messages
array
pages_project_name
string
Name of the project.
pages_deployment-new-deployment
pages_identifier
string
Identifier
pages_build_config
object
Configs for the project build process.
6 properties
pages_stage
object
The status of the deployment.
4 properties
pages_deployment-list-response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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