Api

Api schema from Amazon API Gateway v2 API

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

Properties

Name	Type	Description
ApiId	string	Identifier of the API.
Name	string	Name of the API.
ProtocolType	string	API protocol (HTTP or WEBSOCKET).
ApiEndpoint	string	Default endpoint for the API.
RouteSelectionExpression	string	Route selection expression for the API.
CreatedDate	string	Timestamp when the API was created.

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "properties": {
    "ApiId": {
      "type": "string",
      "description": "Identifier of the API.",
      "example": "abc123"
    },
    "Name": {
      "type": "string",
      "description": "Name of the API.",
      "example": "my-resource"
    },
    "ProtocolType": {
      "type": "string",
      "enum": [
        "HTTP",
        "WEBSOCKET"
      ],
      "description": "API protocol (HTTP or WEBSOCKET).",
      "example": "HTTP"
    },
    "ApiEndpoint": {
      "type": "string",
      "description": "Default endpoint for the API.",
      "example": "example-value"
    },
    "RouteSelectionExpression": {
      "type": "string",
      "description": "Route selection expression for the API.",
      "example": "example-value"
    },
    "CreatedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the API was created.",
      "example": "2025-03-15T14:30:00Z"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-schema/v2-api-schema.json",
  "title": "Api",
  "description": "Api schema from Amazon API Gateway v2 API"
}