APIIDA

APIIDA Deployments API

Gateway deployment operations

GitHub OpenAPI

Operations 4

POST /apis/{apiId}/versions/{version}/importIntoGateways APIIDA Deploy API to Gateways #
GET /deployments APIIDA List Deployments #
POST /deployments APIIDA Create a Deployment #
GET /deployments/{deploymentId} APIIDA Get Deployment Status #

Documentation

📖
Documentation
https://apiida.com/product/apiida-api-control-plane/
📖
Documentation
https://apiida.com/product/apiida-api-gateway-manager/
📖
Documentation
https://apiida.atlassian.net/wiki/spaces/AAGM

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/openapi/apiida-deployments-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-schema/apiida-api.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-schema/apiida-deployment.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-schema/apiida-gateway.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/apiida/refs/heads/main/json-ld/apiida-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/apiida-deployments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

apiida-deployments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: APIIDA API Control Plane Alarms Deployments API
  description: REST API for the APIIDA API Control Plane, enabling programmatic management of APIs across multiple API gateways. Supports validation of proxy specifications, API version management, and deployment to gateways.
  version: '1.0'
  contact:
    name: APIIDA Support
    url: https://www.apiida.com
servers:
- url: https://{tenant}.backend.apiida.io
  description: APIIDA Backend
  variables:
    tenant:
      description: Your APIIDA tenant identifier
      default: example
security:
- bearerAuth: []
tags:
- name: Deployments
  description: Gateway deployment operations
paths:
  /apis/{apiId}/versions/{version}/importIntoGateways:
    post:
      operationId: deployToGateways
      summary: APIIDA Deploy API to Gateways
      description: Deploy a specific API version to one or more connected API gateways.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/apiId'
      - $ref: '#/components/parameters/version'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                gatewayIds:
                  type: array
                  items:
                    type: string
                  description: List of gateway identifiers to deploy to
      responses:
        '200':
          description: Deployment initiated successfully
        '401':
          description: Unauthorized
        '404':
          description: API or version not found
  /deployments:
    get:
      operationId: listDeployments
      summary: APIIDA List Deployments
      description: Retrieve a list of API deployments across managed gateways.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: List of deployments
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Deployment'
                  total:
                    type: integer
        '401':
          description: Unauthorized
    post:
      operationId: createDeployment
      summary: APIIDA Create a Deployment
      description: Initiate a new API deployment or migration to one or more gateways.
      tags:
      - Deployments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentRequest'
      responses:
        '201':
          description: Deployment initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
        '400':
          description: Invalid deployment request
        '401':
          description: Unauthorized
  /deployments/{deploymentId}:
    get:
      operationId: getDeployment
      summary: APIIDA Get Deployment Status
      description: Retrieve the status and details of a specific deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentId'
      responses:
        '200':
          description: Deployment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
        '401':
          description: Unauthorized
        '404':
          description: Deployment not found
components:
  schemas:
    DeploymentRequest:
      type: object
      required:
      - apiId
      - version
      - targetGateways
      properties:
        apiId:
          type: string
          description: API identifier to deploy
        version:
          type: string
          description: API version to deploy
        targetGateways:
          type: array
          items:
            type: string
          description: List of gateway identifiers to deploy to
    Deployment:
      type: object
      properties:
        id:
          type: string
          description: Deployment identifier
        apiId:
          type: string
          description: API being deployed
        version:
          type: string
          description: API version being deployed
        targetGateways:
          type: array
          items:
            type: string
          description: Target gateway identifiers
        status:
          type: string
          enum:
          - pending
          - in_progress
          - completed
          - failed
          - rolled_back
          description: Current deployment status
        createdAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
  parameters:
    apiId:
      name: apiId
      in: path
      required: true
      schema:
        type: string
      description: The API identifier
    offset:
      name: offset
      in: query
      schema:
        type: integer
        default: 0
      description: Pagination offset
    limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 20
      description: Maximum number of items to return
    version:
      name: version
      in: path
      required: true
      schema:
        type: string
      description: The API version identifier
    deploymentId:
      name: deploymentId
      in: path
      required: true
      schema:
        type: string
      description: The deployment identifier
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication
externalDocs:
  description: APIIDA Documentation
  url: https://apiida.atlassian.net