Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIIDA Gateways API

Gateway registration and management operations

APIIDA Gateways 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 Gateways. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 6 operations across 3 paths, and defines 3 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.

6 operations 3 paths 3 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

APIIDA Gateways 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 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Gateways 6

Gateway registration and management operations

GET
/gateways
APIIDA List Managed Gateways
listGateways 2 params → 200401
POST
/gateways
APIIDA Register a Gateway
registerGateway body → 201400401
GET
/gateways/{gatewayId}
APIIDA Get Gateway Details
getGateway 1 param → 200401404
PUT
/gateways/{gatewayId}
APIIDA Update Gateway Configuration
updateGateway 1 param body → 200401404
DELETE
/gateways/{gatewayId}
APIIDA Remove a Gateway
removeGateway 1 param → 204401404
GET
/gateways/{gatewayId}/apis
APIIDA List APIs on a Gateway
listGatewayApis 3 params → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Gateway (10 properties), GatewayApi (5 properties), GatewayRegistration (5 properties). Each schema is shown below with its type and property counts.

Gateway
object
10 properties
GatewayRegistration
object
5 properties 3 required
GatewayApi
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiida-gateways-api-openapi.yml Raw ↑

Other APIs APIIDA publishes across the network.

APIIDA Alarms API
APIIDA Apis API
APIIDA Deployments API
APIIDA Monitoring API
APIIDA Versions API