Release Deploys API
The Deploys API from Release — 5 operation(s) for deploys.
Release Deploys API is one of 9 APIs that Release publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Deploys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 6 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://api.release.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Release Deploys API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-User-Email (userEmail).
An API key is passed in the header as X-User-Token (userToken).
By default, every request must be authenticated.
userEmail— User's email address for authenticationuserToken— User's authentication token (from ~/.release.yaml)
Paths & Operations 6
Across 5 paths, the API surfaces 6 operations — 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Pipeline (10 properties), Error (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Release 8
Other APIs Release publishes across the network.