APIIDA Deployments API
Gateway deployment operations
APIIDA Deployments API is one of 6 APIs that APIIDA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Deployments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.
This API exposes 4 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://{tenant}.backend.apiida.io.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIIDA Deployments API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Bearer token authentication
Paths & Operations 4
Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Gateway deployment operations
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Deployment (7 properties), DeploymentRequest (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 APIIDA 5
Other APIs APIIDA publishes across the network.