WSO2 · Schema

Endpoints

Endpoint schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name	Type	Description
id	string	UUID of the Endpoint entry
name	string	name of the Endpoint entry
endpointConfig	object
endpointSecurity	object
maxTps	integer	Endpoint max tps
type	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/publisher-api-endpoint-schema.json",
  "title": "Endpoints",
  "description": "Endpoint schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the Endpoint entry\n",
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "type": "string",
      "description": "name of the Endpoint entry\n",
      "example": "Endpoint 1"
    },
    "endpointConfig": {
      "type": "object",
      "properties": {
        "endpointType": {
          "type": "string",
          "example": "FAIL_OVER",
          "enum": [
            "SINGLE",
            "LOAD_BALANCED",
            "FAIL_OVER"
          ]
        },
        "list": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/EndpointConfig"
          }
        }
      }
    },
    "endpointSecurity": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": false
        },
        "type": {
          "type": "string",
          "example": "basic"
        },
        "username": {
          "type": "string",
          "example": "basic"
        },
        "password": {
          "type": "string",
          "example": "basic"
        }
      }
    },
    "maxTps": {
      "type": "integer",
      "description": "Endpoint max tps",
      "format": "int64",
      "example": 1000
    },
    "type": {
      "type": "string",
      "example": "http"
    }
  }
}