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

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

This API exposes 5 operations across 2 paths, and defines 16 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 16 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 Project 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 Project 5
GET
/accounts/{account_id}/pages/projects
APIs.io Engineering Platform Get projects
pages-project-get-projects 1 param → 4XX200
POST
/accounts/{account_id}/pages/projects
APIs.io Engineering Platform Create project
pages-project-create-project 1 param body → 4XX200
DELETE
/accounts/{account_id}/pages/projects/{project_name}
APIs.io Engineering Platform Delete project
pages-project-delete-project 2 params body → 4XX200
GET
/accounts/{account_id}/pages/projects/{project_name}
APIs.io Engineering Platform Get project
pages-project-get-project 2 params → 4XX200
PATCH
/accounts/{account_id}/pages/projects/{project_name}
APIs.io Engineering Platform Update project
pages-project-update-project 2 params body → 4XX200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are pages_deployments (16 properties), pages_deployment_configs_values (16 properties), pages_project-object (11 properties), pages_build_config (6 properties). Each schema is shown below with its type and property counts.

pages_project-response
pages_api-response-common-failure
object
4 properties 4 required
pages_deployment_configs_values
object
16 properties
pages_api-response-common
object
3 properties 4 required
pages_project-object
object
11 properties
pages_deployment_configs
object
Configs for deployments in a project.
2 properties
pages_deployments
object
16 properties
pages_project-patch
pages_api-response-pagination
object
1 property
pages_projects-response
pages_source
object
2 properties
pages_messages
array
pages_identifier
string
Identifier
pages_build_config
object
Configs for the project build process.
6 properties
pages_project_name
string
Name of the project.
pages_stage
object
The status of the deployment.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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