WSO2 · Schema

API with API Key

APIWithKeyInfo schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name	Type	Description
keyName	string	API Key name
keyUUID	string	The UUID of the API key
apiName	string	API name
apiUUID	string	The UUID of the associated API

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/devportal-api-api-with-key-info-schema.json",
  "title": "API with API Key",
  "description": "APIWithKeyInfo schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "keyName": {
      "type": "string",
      "description": "API Key name",
      "example": "Test_Key"
    },
    "keyUUID": {
      "type": "string",
      "description": "The UUID of the API key"
    },
    "apiName": {
      "type": "string",
      "description": "API name",
      "example": "NotificationAPI"
    },
    "apiUUID": {
      "type": "string",
      "description": "The UUID of the associated API"
    }
  }
}