Properties
| Name | Type | Description |
|---|---|---|
| type | string | |
| api_version | string | |
| id | string | |
| name | string | |
| title | string | |
| summary | string | |
| integration_url | string | |
| gateway_service_type | string | |
| runtime_name | string | |
| runtime_id | string | |
| endpoint | string | |
| api_endpoint_base | string | |
| tls_client_profile_url | string | |
| sni | array | |
| state | string | |
| oauth_shared_secret | string | |
| visibility | object | |
| owned | boolean | |
| configuration | object | |
| analytics_service_url | stringnull | |
| opentelemetry_url | stringnull | |
| webhook_url | string | |
| webhook_state | string | |
| cloud_setting_urls | array | |
| configured_gateway_service_urls | array | |
| gateway_extension_urls | array | |
| org_url | string | |
| availability_zone_url | string | |
| service_version | stringnull | |
| ldap_cxn_pool | object | |
| communication_kind | string | |
| communication_to_analytics_kind | string | |
| communication_to_analytics_with_jwt | booleannull | |
| gateway_processing_status | object | |
| events | object | |
| service_supported_features | array | |
| ai_gateway_enabled | boolean | |
| cipher_suites | array | |
| disabled_protocols | array | |
| dp_nano_gw_limits | object | |
| dp_nano_gw_configuration | object | |
| metadata | object | |
| created_at | string | |
| updated_at | string | |
| url | string |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-gateway-service-schema.json",
"title": "GatewayService",
"x-generated": "2026-10-29",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/ibm-api-connect-organization-resources-api-openapi.yml#/components/schemas/GatewayService",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"readOnly": true,
"enum": [
"gateway_service"
]
},
"api_version": {
"type": "string",
"readOnly": true,
"enum": [
"2.0.0"
]
},
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 255
},
"title": {
"type": "string",
"maxLength": 1023
},
"summary": {
"type": "string",
"maxLength": 65535
},
"integration_url": {
"type": "string",
"format": "uri"
},
"gateway_service_type": {
"type": "string"
},
"runtime_name": {
"type": "string",
"maxLength": 50
},
"runtime_id": {
"type": "string"
},
"endpoint": {
"type": "string",
"format": "uri"
},
"api_endpoint_base": {
"type": "string"
},
"tls_client_profile_url": {
"type": "string",
"format": "uri"
},
"sni": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"tls_server_profile_url": {
"type": "string",
"format": "uri"
}
}
}
},
"state": {
"type": "string",
"enum": [
"pending",
"ready"
]
},
"oauth_shared_secret": {
"type": "string",
"format": "password"
},
"visibility": {
"$ref": "#/$defs/ResourceVisibility"
},
"owned": {
"type": "boolean"
},
"configuration": {
"type": "object"
},
"analytics_service_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"opentelemetry_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"webhook_url": {
"type": "string",
"format": "uri"
},
"webhook_state": {
"type": "string"
},
"cloud_setting_urls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"configured_gateway_service_urls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"gateway_extension_urls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"org_url": {
"type": "string",
"format": "uri"
},
"availability_zone_url": {
"type": "string",
"format": "uri"
},
"service_version": {
"type": [
"string",
"null"
]
},
"ldap_cxn_pool": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"idle_timeout": {
"type": "integer",
"minimum": 1,
"maximum": 86400
},
"max_pool_size": {
"type": "integer",
"minimum": 1,
"maximum": 2000
},
"document_cache_size": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
}
}
},
"communication_kind": {
"type": "string",
"enum": [
"external",
"internal_svc"
]
},
"communication_to_analytics_kind": {
"type": "string",
"enum": [
"external",
"internal_svc"
]
},
"communication_to_analytics_with_jwt": {
"type": [
"boolean",
"null"
]
},
"gateway_processing_status": {
"$ref": "#/$defs/SubscriberProcessingStatus"
},
"events": {
"type": "object",
"properties": {
"sent_events": {
"type": "array",
"items": {
"$ref": "#/$defs/SubscriberEvent"
}
},
"queued_events": {
"type": "array",
"items": {
"$ref": "#/$defs/SubscriberEvent"
}
}
}
},
"service_supported_features": {
"type": "array",
"items": {
"type": "string"
}
},
"ai_gateway_enabled": {
"type": "boolean"
},
"cipher_suites": {
"type": "array",
"items": {
"type": "string"
}
},
"disabled_protocols": {
"type": "array",
"items": {
"type": "string"
}
},
"dp_nano_gw_limits": {
"type": "object",
"additionalProperties": false,
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
},
"replicas": {
"type": "integer",
"minimum": 0,
"maximum": 128
},
"allow_overrides": {
"type": "boolean"
},
"hpa": {
"type": "object",
"additionalProperties": false,
"properties": {
"min_replicas": {
"type": "integer",
"minimum": 1
},
"max_replicas": {
"type": "integer",
"minimum": 2
}
}
}
}
},
"dp_nano_gw_configuration": {
"type": "object",
"additionalProperties": false,
"properties": {
"hpa": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"min_replicas": {
"type": "integer",
"minimum": 1
},
"max_replicas": {
"type": "integer",
"minimum": 2
},
"target_cpu": {
"type": "integer",
"minimum": 1
},
"target_memory": {
"type": "integer",
"minimum": 1
},
"to_zero_time": {
"type": "integer",
"minimum": 0
},
"from_zero_replicas": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
}
}
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"url": {
"type": "string",
"readOnly": true,
"format": "uri"
}
},
"$defs": {
"ResourceVisibility": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"public",
"private",
"custom"
]
},
"group_urls": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"format": "uri"
}
},
"org_urls": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"format": "uri"
}
}
}
},
"SubscriberEvent": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"readOnly": true,
"enum": [
"subscriber_event"
]
},
"api_version": {
"type": "string",
"readOnly": true,
"enum": [
"2.0.0"
]
},
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 255
},
"title": {
"type": "string",
"maxLength": 1023
},
"summary": {
"type": "string",
"maxLength": 65535
},
"scope": {
"type": "string"
},
"event": {
"type": "string"
},
"filter": {
"type": "string"
},
"event_type": {
"type": "string",
"enum": [
"create",
"update",
"delete"
]
},
"payload_sent": {
"type": "string"
},
"payload": {
"type": "object"
},
"generated_at": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"queued",
"sent",
"failed"
]
},
"retries": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"request_id": {
"type": "string"
},
"ids_in_payload": {
"type": "array",
"readOnly": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"resourceUrl": {
"type": "string",
"format": "uri-reference"
},
"resourceType": {
"type": "string"
}
}
}
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"url": {
"type": "string",
"readOnly": true,
"format": "uri"
}
}
},
"SubscriberEventStatus": {
"type": "object",
"additionalProperties": false,
"properties": {
"event_id": {
"type": "string"
},
"title": {
"type": "string"
},
"filter": {
"type": "string"
},
"generated_at": {
"type": "string"
},
"processed_at": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"SubscriberProcessingStatus": {
"type": "object",
"additionalProperties": false,
"properties": {
"service_state": {
"type": "string",
"enum": [
"green",
"orange",
"red"
]
},
"service_up_to_date": {
"type": "boolean"
},
"last_processed_event": {
"type": "object",
"properties": {
"event_id": {
"type": "string"
},
"title": {
"type": "string"
},
"filter": {
"type": "string"
},
"generated_at": {
"type": "string"
},
"processed_at": {
"type": "string"
},
"event_processing_time": {
"type": "integer"
},
"elapsed_time_since_last_processed_event": {
"type": "integer"
}
}
},
"first_failed_event": {
"$ref": "#/$defs/SubscriberEventStatus"
},
"number_of_outstanding_sent_events": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"last_sent_event": {
"type": "object",
"properties": {
"event_id": {
"type": "string"
},
"title": {
"type": "string"
},
"sent_at": {
"type": "string"
},
"generated_at": {
"type": "string"
}
}
},
"number_of_outstanding_queued_events": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
}
}
}
}
}Work with this as data
Every JSON Schema 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 schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/ibm-api-connect-gateway-service"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
A second provider on the same verified email joins the account you already have.