WSO2 · JSON Structure

Admin Api Api Info Key Manager Structure

APIInfoKeyManager schema from WSO2 API Manager

Type: object Properties: 12 Required: 4
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

APIInfoKeyManager is a JSON Structure definition published by WSO2, describing 12 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id type name transportType description context version provider status thumbnailUri advertiseOnly keyManagerEntry

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/admin-api-api-info-key-manager-structure.json",
  "name": "APIInfoKeyManager",
  "description": "APIInfoKeyManager schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the API."
    },
    "type": {
      "type": "string",
      "description": "The type of the entry (e.g., \"API\")."
    },
    "name": {
      "type": "string",
      "description": "The name of the API."
    },
    "transportType": {
      "type": "string",
      "description": "The transport type of the API."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "description": "The description of the API."
    },
    "context": {
      "type": "string",
      "description": "The context of the API."
    },
    "version": {
      "type": "string",
      "description": "The version of the API."
    },
    "provider": {
      "type": "string",
      "description": "The provider of the API."
    },
    "status": {
      "type": "string",
      "description": "The status of the API."
    },
    "thumbnailUri": {
      "type": "string",
      "nullable": true,
      "description": "The URI of the thumbnail of the API."
    },
    "advertiseOnly": {
      "type": "boolean",
      "description": "Indicates if the API is advertised only."
    },
    "keyManagerEntry": {
      "type": "string",
      "description": "The key manager entry related to the API."
    }
  },
  "required": [
    "id",
    "name",
    "version",
    "provider"
  ]
}