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

The Zone API from APIs.io Engineering Platform — 2 operation(s) for zone.

This API exposes 5 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.

5 operations 2 paths 11 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 Zone 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.

Zone 5
GET
/zones
APIs.io Engineering Platform List Zones
zones-get 9 params → 4XX200
POST
/zones
APIs.io Engineering Platform Create Zone
zones-post body → 4XX200
DELETE
/zones/{zone_id}
APIs.io Engineering Platform Delete Zone
zones-0-delete 1 param body → 4XX200
GET
/zones/{zone_id}
APIs.io Engineering Platform Zone Details
zones-0-get 1 param → 4XX200
PATCH
/zones/{zone_id}
APIs.io Engineering Platform Edit Zone
zones-0-patch 1 param body → 4XX200

Schemas 11

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

zones_type
string
A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.
zones_api-response-common-failure
object
4 properties 4 required
zones_messages
array
zones_name
string
The domain name
zones_identifier
string
Identifier
zones_zone
object
17 properties 13 required
zones_api-response-common
object
3 properties 3 required
zones_result_info
object
4 properties
zones_paused
boolean
Indicates whether the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits.
zones_vanity_name_servers
array
An array of domains used for custom name servers. This is only available for Business and Enterprise plans.
zones_api-response-single-id
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-zone-api-openapi.yml Raw ↑