V2 Create Api Request Structure

CreateApiRequest schema from Amazon API Gateway v2 API

Type: object Properties: 5 Required: 2

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

CreateApiRequest is a JSON Structure definition published by Amazon API Gateway, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Name ProtocolType RouteSelectionExpression Description Target

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

JSON Structure

{
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": "Name of the API.",
      "example": "my-resource"
    },
    "ProtocolType": {
      "type": "string",
      "enum": [
        "HTTP",
        "WEBSOCKET"
      ],
      "description": "Protocol type for the API.",
      "example": "HTTP"
    },
    "RouteSelectionExpression": {
      "type": "string",
      "description": "Route selection expression (required for WebSocket APIs).",
      "example": "example-value"
    },
    "Description": {
      "type": "string",
      "description": "Description of the API.",
      "example": "A description of this resource."
    },
    "Target": {
      "type": "string",
      "description": "Quick-create target Lambda or HTTP endpoint URI.",
      "example": "example-value"
    }
  },
  "required": [
    "Name",
    "ProtocolType"
  ],
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-structure/v2-create-api-request-structure.json",
  "name": "CreateApiRequest",
  "description": "CreateApiRequest schema from Amazon API Gateway v2 API"
}