WSO2 · JSON Structure

Devportal Api Api With Key Info Structure

APIWithKeyInfo schema from WSO2 API Manager

Type: object Properties: 4
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

API with API Key is a JSON Structure definition published by WSO2, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

keyName keyUUID apiName apiUUID

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/devportal-api-api-with-key-info-structure.json",
  "name": "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"
    }
  }
}