V1 Api Keys Structure

ApiKeys schema from Amazon API Gateway v1 API

Type: object Properties: 1

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

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

Properties

items

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

JSON Structure

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "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
          }
        }
      },
      "example": [
        "example-value"
      ]
    }
  },
  "$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-keys-structure.json",
  "name": "ApiKeys",
  "description": "ApiKeys schema from Amazon API Gateway v1 API"
}