Amazon API Gateway · Schema

ApiKey

ApiKey schema from Amazon API Gateway v1 API

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

Properties

Name Type Description
id string ApiKey identifier.
value string Value of the ApiKey.
name string Name of the ApiKey.
enabled boolean Whether the ApiKey is enabled.
View JSON Schema on GitHub

JSON Schema

v1-api-key-schema.json 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-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-schema/v1-api-key-schema.json",
  "title": "ApiKey",
  "description": "ApiKey schema from Amazon API Gateway v1 API"
}