Properties
| Name | Type | Description |
|---|---|---|
| type | string | |
| api_version | string | |
| id | string | |
| name | string | |
| version | string | |
| title | string | |
| summary | string | |
| scope | string | |
| state | string | |
| custom | boolean | |
| instance | boolean | |
| policy | object | |
| implementation | object | |
| attachments | array | |
| policy_kind | object | |
| api_urls | array | |
| global_policy_urls | array | |
| org_url | string | |
| catalog_url | string | |
| space_url | string | |
| gateway_service_url | string | |
| 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-policy-schema.json",
"title": "Policy",
"x-generated": "2026-10-29",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/ibm-api-connect-catalog-resources-api-openapi.yml#/components/schemas/Policy",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"readOnly": true,
"enum": [
"policy"
]
},
"api_version": {
"type": "string",
"readOnly": true,
"enum": [
"2.0.0"
]
},
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 255
},
"version": {
"type": "string",
"maxLength": 255
},
"title": {
"type": "string",
"maxLength": 1023
},
"summary": {
"type": "string",
"maxLength": 65535
},
"scope": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"public",
"private"
]
},
"custom": {
"type": "boolean"
},
"instance": {
"type": "boolean"
},
"policy": {
"$ref": "#/$defs/PolicyDocument"
},
"implementation": {
"type": "object",
"additionalProperties": false,
"required": [
"content_type",
"content"
],
"properties": {
"content_type": {
"type": "string",
"enum": [
"application/zip"
]
},
"content": {
"type": "string",
"format": "binary"
}
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"content_type",
"content"
],
"properties": {
"content_type": {
"type": "string",
"description": "MIME type of the attached file"
},
"content": {
"type": "string",
"format": "binary",
"description": "Binary content of the attached file"
},
"filename": {
"type": "string",
"description": "Original filename of the attachment"
}
}
}
},
"policy_kind": {
"$ref": "#/$defs/PolicyInstance"
},
"api_urls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"global_policy_urls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"org_url": {
"type": "string",
"format": "uri"
},
"catalog_url": {
"type": "string",
"format": "uri"
},
"space_url": {
"type": "string",
"format": "uri"
},
"gateway_service_url": {
"type": "string",
"format": "uri"
},
"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": {
"PolicyDocument": {
"type": "object",
"additionalProperties": true
},
"PolicyInstance": {
"oneOf": [
{
"$ref": "#/$defs/ProjectAWSLambda"
},
{
"$ref": "#/$defs/ProjectValidateAPISpecification"
},
{
"$ref": "#/$defs/ProjectUriSchemes"
},
{
"$ref": "#/$defs/ProjectInvoke"
},
{
"$ref": "#/$defs/ProjectLoadBalancer"
},
{
"$ref": "#/$defs/ProjectSetAuthorization"
},
{
"$ref": "#/$defs/ProjectStagedPolicySequence"
},
{
"$ref": "#/$defs/ProjectInboundBulkHead"
},
{
"$ref": "#/$defs/ProjectInboundBulkHeadV2"
},
{
"$ref": "#/$defs/ProjectSetMediaType"
},
{
"$ref": "#/$defs/ProjectInboundMessaging"
},
{
"$ref": "#/$defs/ProjectIAM"
},
{
"$ref": "#/$defs/ProjectAuthorizeUser"
},
{
"$ref": "#/$defs/ProjectSetContextVariable"
},
{
"$ref": "#/$defs/ProjectWebMethodsISService"
},
{
"$ref": "#/$defs/ProjectWebMethodsISServiceV2"
},
{
"$ref": "#/$defs/ProjectLogInvocation"
},
{
"$ref": "#/$defs/ProjectMonitorTraffic"
},
{
"$ref": "#/$defs/ProjectServiceResultCache"
},
{
"$ref": "#/$defs/ProjectOutboundAlias"
},
{
"$ref": "#/$defs/ProjectOutboundAnonymous"
},
{
"$ref": "#/$defs/ProjectHTTPInvoke"
},
{
"$ref": "#/$defs/ProjectInvokeMessagingExtension"
},
{
"$ref": "#/$defs/ProjectDataMasking"
},
{
"$ref": "#/$defs/ProjectRequestProcessing"
},
{
"$ref": "#/$defs/ProjectResponseProcessing"
},
{
"$ref": "#/$defs/ProjectRoute"
},
{
"$ref": "#/$defs/ProjectMessageConfig"
},
{
"$ref": "#/$defs/ProjectHTTPEndpoint"
},
{
"$ref": "#/$defs/ProjectHTTPEndpointV2"
},
{
"$ref": "#/$defs/ProjectMockEndpoint"
},
{
"$ref": "#/$defs/ProjectMockEndpointV2"
},
{
"$ref": "#/$defs/ProjectMockResponse"
},
{
"$ref": "#/$defs/ProjectErrorProcessing"
},
{
"$ref": "#/$defs/ProjectSet"
},
{
"$ref": "#/$defs/ProjectRateLimit"
},
{
"$ref": "#/$defs/ProjectRateLimitDefinition"
},
{
"$ref": "#/$defs/ProjectScope"
},
{
"$ref": "#/$defs/ProjectScopeV2"
},
{
"$ref": "#/$defs/ProjectCORS"
}
]
},
"ProjectAWSLambda": {
"type": "object",
"required": [
"kind",
"apiVersion",
"metadata",
"spec"
],
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"InvokeAWSLambda"
],
"type": "string"
},
"apiVersion": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ProjectMetadata"
},
"spec": {
"type": "object",
"additionalProperties": false,
"properties": {
"functionName": {
"description": "Name of the AWS Lambda function",
"type": "string"
},
"qualifier": {
"description": "Version of the AWS Lambda function",
"type": "string"
},
"invocationType": {
"type": "string",
"enum": [
"requestResponse",
"event"
]
},
"region": {
"type": "string"
},
"awsAuthType": {
"type": "object",
"properties": {
"accessSecret": {
"type": "string"
}
}
},
"tlsClientProfile": {
"type": "string"
},
"input": {
"type": "string"
},
"output": {
"type": "string"
},
"clientConfig": {
"type": "object",
"additionalProperties": false,
"properties": {
"socketTimeout": {
"type": "integer"
},
"connectionTimeout": {
"type": "integer"
},
"requestTimeout": {
"type": "integer"
},
"clientExecutionTimeout": {
"type": "integer"
},
"clientRetryCount": {
"type": "integer"
},
"connectionExpirationTimeout": {
"type": "integer"
},
"enableExpectContinue": {
"type": "boolean"
},
"enableGzip": {
"type": "boolean"
},
"enableHostPrefixInjection": {
"type": "boolean"
},
"maxConnectionIdleTime": {
"type": "integer"
},
"responseMetadataCacheSize": {
"type": "integer"
},
"enableThrottledRetries": {
"type": "boolean"
},
"enableKeepAlive": {
"type": "boolean"
},
"enableResponseMetadataCache": {
"type": "boolean"
},
"signatureAlgorithm": {
"type": "string"
},
"tcpSendBufferSizeHint": {
"type": "integer"
},
"tcpReceiveBufferSizeHint": {
"type": "integer"
}
}
},
"extensions": {
"type": "object",
"properties": {
"dp-nano-gateway": {
"type": "object",
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"spec": {
"type": "object",
"additionalProperties": false,
"properties": {
"clientConfig": {
"type": "object",
"additionalProperties": false,
"properties": {
"serverRetryCount": {
"type": "integer"
}
}
},
"telemetry": {
"$ref": "#/$defs/ProjectNanoGwTelemetry"
}
}
}
}
},
"webm-gateway": {
"type": "object",
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"spec": {
"type": "object",
"additionalProperties": false,
"properties": {
"condition": {
"type": "string"
},
"lambdaConfig": {
"type": "object",
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
}
}
},
"clientConfig": {
"type": "object",
"additionalProperties": false,
"properties": {
"retryOnErrorCount": {
"type": "integer"
}
}
},
"request_processing": {
"$ref": "#/$defs/ProjectInvokeRequestProcessingSchema"
},
"response_processing": {
"$ref": "#/$defs/ProjectInvokeResponseProcessingSchema"
},
"namespaces": {
"$ref": "#/$defs/ProjectNamespaces"
}
}
}
}
}
}
}
}
}
}
},
"ProjectAuthorizeUser": {
"type": "object",
"required": [
"kind",
"apiVersion",
"metadata",
"spec"
],
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"AuthorizeUser"
],
"type": "string"
},
"apiVersion": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ProjectMetadata"
},
"spec": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"users": {
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"teams": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"ProjectCORS": {
"description": "The CORS related information is captured in the message CORS",
"type": "object",
"required": [
"kind",
"apiVersion",
"metadata",
"spec"
],
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"CORS"
],
"type": "string"
},
"apiVersion": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ProjectMetadata"
},
"spec": {
"type": "object",
"additionalProperties": false,
"required": [
"rules"
],
"properties": {
"rules": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"required": [
"action",
"originList"
],
"additionalProperties": false,
"properties": {
"action": {
"type": "string",
"enum": [
"allow",
"deny"
]
},
"originList": {
"description": "Multiple instances of allowed origins can be given",
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
},
"allowCredentials": {
"description": "Credential can be allowed or not allowed",
"type": "boolean"
},
"allowMethods": {
"description": "Multiple instances allowed methods can be given",
"type": "array",
"minItems": 1,
"items": {
"type": "string"
},
"uniqueItems": true
},
"allowHeaders": {
"description": "Multiple instances of allowed headers can be given",
"minItems": 1,
"items": {
"type": "string"
},
"type": "array"
},
"maxAge": {
"description": "Single instance of maximum age can be given",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"exposeHeaders": {
"type": "object",
"additionalProperties": false,
"properties": {
"predefined": {
"type": "boolean"
},
"custom": {
"type": "string"
},
"backend": {
"type": "boolean"
}
}
}
}
}
}
}
}
}
},
"ProjectDataMasking": {
"description": "The Data Masking related information is captured in the message Data masking",
"type": "object",
"required": [
"kind",
"apiVersion",
"metadata",
"spec"
],
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"DataMasking"
],
"type": "string"
},
"apiVersion": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ProjectMetadata"
},
"spec": {
"type": "object",
"additionalProperties": false,
"properties": {
"applyForPayload": {
"description": "Apply for pay load can be enabled or disabled",
"type": "boolean"
},
"applyForTransactionLogging": {
"description": "Apply for transaction logging can be enabled or disabled",
"type": "boolean"
},
"enabled": {
"description": "Can be enabled or disabled",
"type": "boolean"
},
"matchApplications": {
"description": "Multiple instance of match applications can be given",
"type": "array",
"items": {
"type": "string"
}
},
"transformations": {
"description": "single instance of transformation can be given",
"type": "object",
"additionalProperties": false,
"properties": {
"remove": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"jpath": {
"type": "string"
},
"regex": {
"type": "string"
},
"xpath": {
"type": "string"
},
"namespaces": {
"$ref": "#/$defs/ProjectNamespaces"
}
}
}
},
"set": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"jpath": {
"type": "string"
},
"maskValue": {
"type": "string"
},
"namespaces": {
"$ref": "#/$defs/ProjectNamespaces"
},
"regex": {
"type": "string"
},
"xpath": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"ProjectDestinationsList": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string",
"enum": [
"api_gateway",
"dev_portals",
"snmp",
"jdbc",
"centraSite",
"elasticsearch",
"auditLog",
"apic"
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"email": {
"type": "array",
"items": {
"type": "string",
"format": "email"
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"log-file": {
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"type": "string",
"enum": [
"info",
"debug",
"warn",
"error"
]
}
}
}
}
}
]
}
},
"ProjectErrorProcessing": {
"description": "The Conditional Error Handling related information is captured in the message ConditionalErrorProcessing.",
"type": "object",
"required": [
"kind",
"apiVersion",
"metadata",
"spec"
],
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"ErrorProcessing"
],
"type": "string"
},
"apiVersion": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ProjectMetadata"
},
"spec": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Can be enabled or disabled",
"type": "boolean"
},
"condition": {
"description": "Single instance of condition can be given",
"type": "string"
},
"pre-processing": {
"description": "Field 'pre_processing' with JSON name 'pre-processing' accepts the value of either 'pre_processing' or 'pre-processing' from the YAML file.\nIf both 'pre_processing' and 'pre-processing' are specified, the value of 'pre-processing' takes priority.\nMultiple instances of pre processing can be given with JSON name \"pre-processing\".",
"type": "object",
"additionalProperties": false,
"properties": {
"webMethodsISService": {
"$ref": "#/$defs/ProjectReferenceList"
},
"xsl": {
"$ref": "#/$defs/ProjectXslSchema"
}
}
},
"transformations": {
"$ref": "#/$defs/ProjectErrorProcessingTransformationsSchema"
},
"post-processing": {
"description": "Field 'post_processing' with JSON name 'post-processing' accepts the value of either 'post_processing' or 'post-processing' from the YAML file.\nIf both 'post_processing' and 'post-processing' are specified, the value of 'post-processing' takes priority.\nMultiple instances of post processing can be given with JSON name 'post-processing\".",
"type": "object",
"additionalProperties": false,
"properties": {
"webMethodsISService": {
"$ref": "#/$defs/ProjectReferenceList"
},
"xsl": {
"$ref": "#/$defs/ProjectXslSchema"
}
}
}
}
}
}
},
"ProjectErrorProcessingTransformationsSchema": {
"description": "Single instance of transformation can be given",
"type": "object",
"additionalProperties": false,
"properties": {
"set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"remove": {
"type": "array",
"items": {
"type": "string"
}
},
"setPayload": {
"type": "object",
"additionalProperties": false,
"properties": {
"content-types": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"defaultContentType": {
"type": "string"
},
"xsl": {
"$ref": "#/$defs/ProjectXslSchema"
}
}
},
"namespaces": {
"$ref": "#/$defs/ProjectNamespaces"
},
"sendNativeError": {
"type": "boolean"
}
}
},
"ProjectHTTPEndpoint": {
"type": "object",
"required": [
"kind",
"apiVersion",
"metadata",
"spec"
],
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"HTTPEndpoint"
],
"type": "string"
},
"apiVersion": {
"type": "string",
"enum": [
"api.ibm.com/v1"
]
},
"metadata": {
"$ref": "#/$defs/ProjectMetadata"
},
"spec": {
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"type": "string"
},
"method": {
"type": "string"
},
"connectTimeout": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"readTimeout": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"nativeServiceTimeout": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"serviceRegistryParameters": {
"type": "array",
"items": {
"description": "The message specified the information related to SSL Configuration",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"sslConfig": {
"type": "object",
"additionalProperties": false,
"properties": {
"keyAlias": {
"type": "string"
},
"keyStoreAlias": {
"type": "string"
},
"trustStoreAlias": {
"type": "string"
}
}
}
}
}
}
},
"ProjectHTTPEndpointV2": {
"type": "object",
"required": [
"kind",
"apiVersion",
"metadata",
"spec"
],
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"HTTPEndpoint"
],
"type": "string"
},
"apiVersion": {
"type": "string",
"enum": [
"api.ibm.com/v2"
]
},
"metadata": {
"$ref": "#/$defs/ProjectMetadata"
},
"spec": {
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"type": "string"
},
"method": {
"type": "string"
},
"connectTimeout": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"readTimeout": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"nativeServiceTimeout": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"serviceRegistryParameters": {
"type": "array",
"items": {
"description": "A key-value pair specifying an SSL configuration parameter.",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"tlsClientProfile": {
"type": "string"
}
}
}
}
},
"ProjectHTTPInvoke": {
"description": "The HTTP Invoke related information is captured in the message HTTPInvoke",
"type": "object",
"required": [
"kind",
"apiVersion",
"metadata",
"spec"
],
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"HTTPInvoke"
],
"type": "string"
},
"apiVersion": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ProjectMetadata"
},
"spec": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Can be enabled or disabled",
"type": "boolean"
},
"condition": {
"type": "string"
},
"endpoint": {
"$ref": "#/$defs/ProjectReference"
},
"namespaces": {
"$ref": "#/$defs/ProjectNamespaces"
},
"request_processing": {
"$ref": "#/$defs/ProjectInvokeRequestProcessingSchema"
},
"response_processing": {
"$ref": "#/$defs/ProjectInvokeResponseProcessingSchema"
}
}
}
}
},
"ProjectIAM": {
"type": "object",
"required": [
"kind",
"apiVersion",
"metadata",
"spec"
],
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"IAM"
],
"type": "string"
},
"apiVersion": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ProjectMetadata"
},
"spec": {
"type": "object",
"additionalProperties": false,
"properties": {
"accessControl": {
"type": "array",
"items": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"httpBasic": {
"type": "object",
"additionalProperties": false,
"properties": {
"applicationSecurity": {
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"type": "string",
"enum": [
"authorize",
"identify",
"authenticate"
]
}
}
},
"credentialLocation": {
"type":
# --- truncated at 32 KB (181 KB total) ---
# Full source: https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-policy-schema.json
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-policy"
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.