Amazon API Gateway · JSON Structure

V1 Api Key Structure

ApiKey schema from Amazon API Gateway v1 API

Type: object Properties: 4
API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

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

Properties

id value name enabled

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ApiKey identifier.",
      "example": "abc123"
    },
    "value": {
      "type": "string",
      "description": "Value of the ApiKey.",
      "example": "example-value"
    },
    "name": {
      "type": "string",
      "description": "Name of the ApiKey.",
      "example": "my-resource"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the ApiKey is enabled.",
      "example": true
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-structure/v1-api-key-structure.json",
  "name": "ApiKey",
  "description": "ApiKey schema from Amazon API Gateway v1 API"
}