APIIDA · Schema

APIIDA Gateway

A managed API gateway instance registered with APIIDA, typically a Broadcom Layer7 gateway used for API deployment and monitoring.

API GatewayAPI ManagementFederated API ManagementGovernanceLayer7

Properties

Name Type Description
id string Unique gateway identifier
name string Display name of the gateway
host string Hostname or IP address of the gateway
port integer Gateway management port
status string Current connection status of the gateway
type string Gateway platform type (e.g. Layer7, Kong, AWS)
version string Gateway software version
apiCount integer Number of APIs currently deployed on this gateway
createdAt string Timestamp when the gateway was registered
updatedAt string Timestamp when the gateway record was last updated
View JSON Schema on GitHub

JSON Schema

apiida-gateway.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "apiida-gateway.json",
  "title": "APIIDA Gateway",
  "description": "A managed API gateway instance registered with APIIDA, typically a Broadcom Layer7 gateway used for API deployment and monitoring.",
  "type": "object",
  "required": ["id", "name", "host", "port"],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique gateway identifier"
    },
    "name": {
      "type": "string",
      "description": "Display name of the gateway"
    },
    "host": {
      "type": "string",
      "description": "Hostname or IP address of the gateway"
    },
    "port": {
      "type": "integer",
      "description": "Gateway management port"
    },
    "status": {
      "type": "string",
      "enum": ["connected", "disconnected", "error"],
      "description": "Current connection status of the gateway"
    },
    "type": {
      "type": "string",
      "description": "Gateway platform type (e.g. Layer7, Kong, AWS)"
    },
    "version": {
      "type": "string",
      "description": "Gateway software version"
    },
    "apiCount": {
      "type": "integer",
      "description": "Number of APIs currently deployed on this gateway"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the gateway was registered"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the gateway record was last updated"
    }
  }
}