How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 Deployment. 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.2.0, at version 1.0.

Requests are made against a single base URL, https://{tenant}.backend.apiida.io.

4 operations 3 paths 2 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.apiida.com
Authentication
HTTP Bearer
Resource Areas
1

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.

Deployments 4

Gateway deployment operations

POST
/apis/{apiId}/versions/{version}/importIntoGateways
APIIDA Deploy API to Gateways
deployToGateways 2 params body → 200401404
GET
/deployments
APIIDA List Deployments
listDeployments 2 params → 200401
POST
/deployments
APIIDA Create a Deployment
createDeployment body → 201400401
GET
/deployments/{deploymentId}
APIIDA Get Deployment Status
getDeployment 1 param → 200401404

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.

DeploymentRequest
object
3 properties 3 required
Deployment
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiida-deployments-api-openapi.yml Raw ↑

Other APIs APIIDA publishes across the network.

APIIDA Alarms API
APIIDA Apis API
APIIDA Gateways API
APIIDA Monitoring API
APIIDA Versions API
Where this information came from

This is an independent, third-party profile of APIIDA Deployments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.