APIs.io Engineering Platform · Schema

EndpointConfiguration

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
types	object
vpcEndpointIds	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EndpointConfiguration",
  "title": "EndpointConfiguration",
  "type": "object",
  "properties": {
    "types": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfEndpointType"
        },
        {
          "description": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is <code>\"EDGE\"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>."
        }
      ]
    },
    "vpcEndpointIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfString"
        },
        {
          "description": "A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for <code>PRIVATE</code> endpoint type."
        }
      ]
    }
  },
  "description": "The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. "
}