APIIDA

APIIDA Gateways API

Gateway registration and management operations

GitHub OpenAPI

Operations 6

GET /gateways APIIDA List Managed Gateways #
POST /gateways APIIDA Register a Gateway #
GET /gateways/{gatewayId} APIIDA Get Gateway Details #
PUT /gateways/{gatewayId} APIIDA Update Gateway Configuration #
DELETE /gateways/{gatewayId} APIIDA Remove a Gateway #
GET /gateways/{gatewayId}/apis APIIDA List APIs on a Gateway #

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-gateways-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-gateways-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-gateways-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: APIIDA API Control Plane Alarms Gateways 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: Gateways
  description: Gateway registration and management operations
paths:
  /gateways:
    get:
      operationId: listGateways
      summary: APIIDA List Managed Gateways
      description: Retrieve a list of all registered and managed Layer7 API gateway instances.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: List of managed gateways
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Gateway'
                  total:
                    type: integer
                    description: Total number of gateways
        '401':
          description: Unauthorized
    post:
      operationId: registerGateway
      summary: APIIDA Register a Gateway
      description: Register a new Layer7 API gateway instance for management by APIIDA.
      tags:
      - Gateways
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayRegistration'
      responses:
        '201':
          description: Gateway registered successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gateway'
        '400':
          description: Invalid gateway configuration
        '401':
          description: Unauthorized
  /gateways/{gatewayId}:
    get:
      operationId: getGateway
      summary: APIIDA Get Gateway Details
      description: Retrieve detailed information about a specific managed gateway.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/gatewayId'
      responses:
        '200':
          description: Gateway details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gateway'
        '401':
          description: Unauthorized
        '404':
          description: Gateway not found
    put:
      operationId: updateGateway
      summary: APIIDA Update Gateway Configuration
      description: Update the configuration of a registered gateway.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/gatewayId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayRegistration'
      responses:
        '200':
          description: Gateway updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gateway'
        '401':
          description: Unauthorized
        '404':
          description: Gateway not found
    delete:
      operationId: removeGateway
      summary: APIIDA Remove a Gateway
      description: Unregister and remove a gateway from management.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/gatewayId'
      responses:
        '204':
          description: Gateway removed successfully
        '401':
          description: Unauthorized
        '404':
          description: Gateway not found
  /gateways/{gatewayId}/apis:
    get:
      operationId: listGatewayApis
      summary: APIIDA List APIs on a Gateway
      description: Retrieve a list of all APIs deployed on a specific gateway.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/gatewayId'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: List of APIs on the gateway
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/GatewayApi'
                  total:
                    type: integer
        '401':
          description: Unauthorized
        '404':
          description: Gateway not found
components:
  parameters:
    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
    gatewayId:
      name: gatewayId
      in: path
      required: true
      schema:
        type: string
      description: The gateway identifier
  schemas:
    GatewayApi:
      type: object
      properties:
        id:
          type: string
          description: API identifier on the gateway
        name:
          type: string
          description: API name
        version:
          type: string
          description: API version
        status:
          type: string
          enum:
          - active
          - disabled
          - deprecated
          description: API status on the gateway
        lastDeployed:
          type: string
          format: date-time
    Gateway:
      type: object
      properties:
        id:
          type: string
          description: Unique gateway identifier
        name:
          type: string
          description: Display name of the gateway
        host:
          type: string
          description: Hostname or IP of the gateway
        port:
          type: integer
          description: Gateway management port
        status:
          type: string
          enum:
          - connected
          - disconnected
          - error
          description: Current connection status
        type:
          type: string
          description: Gateway type (e.g. Layer7)
        version:
          type: string
          description: Gateway software version
        apiCount:
          type: integer
          description: Number of APIs deployed on this gateway
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    GatewayRegistration:
      type: object
      required:
      - name
      - host
      - port
      properties:
        name:
          type: string
          description: Display name of the gateway
        host:
          type: string
          description: Hostname or IP of the gateway
        port:
          type: integer
          description: Gateway management port
        type:
          type: string
          description: Gateway type
        credentials:
          type: object
          properties:
            username:
              type: string
            password:
              type: string
          description: Credentials for connecting to the gateway
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication
externalDocs:
  description: APIIDA Documentation
  url: https://apiida.atlassian.net