V1 Rest Api Structure

RestApi schema from Amazon API Gateway v1 API

Type: object Properties: 6

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

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

Properties

id name description createdDate version endpointConfiguration

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

JSON Structure

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Identifier of the RestApi.",
      "example": "abc123"
    },
    "name": {
      "type": "string",
      "description": "Name of the RestApi.",
      "example": "my-resource"
    },
    "description": {
      "type": "string",
      "description": "Description of the RestApi.",
      "example": "A description of this resource."
    },
    "createdDate": {
      "type": "datetime",
      "description": "Timestamp when the RestApi was created.",
      "example": "2025-03-15T14:30:00Z"
    },
    "version": {
      "type": "string",
      "description": "Version identifier of the API.",
      "example": "1.0"
    },
    "endpointConfiguration": {
      "type": "object",
      "properties": {
        "types": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "EDGE",
              "REGIONAL",
              "PRIVATE"
            ]
          },
          "description": "List of endpoint types (EDGE, REGIONAL, PRIVATE).",
          "example": [
            "EDGE"
          ]
        }
      }
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-structure/v1-rest-api-structure.json",
  "name": "RestApi",
  "description": "RestApi schema from Amazon API Gateway v1 API"
}