V1 Rest Apis Structure

RestApis schema from Amazon API Gateway v1 API

Type: object Properties: 1

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

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

Properties

items

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

JSON Structure

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "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",
                "description": "List of endpoint types (EDGE, REGIONAL, PRIVATE).",
                "items": {
                  "type": "string",
                  "enum": [
                    "EDGE",
                    "REGIONAL",
                    "PRIVATE"
                  ]
                },
                "example": [
                  "EDGE"
                ]
              }
            }
          }
        }
      },
      "example": [
        "example-value"
      ]
    }
  },
  "$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-apis-structure.json",
  "name": "RestApis",
  "description": "RestApis schema from Amazon API Gateway v1 API"
}