RestApi

RestApi schema from Amazon API Gateway v1 API

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

Properties

Name	Type	Description
id	string	Identifier of the RestApi.
name	string	Name of the RestApi.
description	string	Description of the RestApi.
createdDate	string	Timestamp when the RestApi was created.
version	string	Version identifier of the API.
endpointConfiguration	object

View JSON Schema on GitHub

JSON Schema

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