/v2/apis/{apiId}

GET

/v2/apis/{apiId}

Gets an Api resource.

Response Example

200 - Example 1

{
    "ApiEndpoint": "string",
    "ApiGatewayManaged": true,
    "ApiId": "string",
    "ApiKeySelectionExpression": "string",
    "CorsConfiguration": {
        "AllowCredentials": true,
        "AllowHeaders": [],
        "AllowMethods": [],
        "AllowOrigins": [],
        "ExposeHeaders": [],
        "MaxAge": 0
    },
    "CreatedDate": "string",
    "Description": "string",
    "DisableSchemaValidation": true,
    "DisableExecuteApiEndpoint": true,
    "ImportInfo": [],
    "Name": "string",
    "ProtocolType": "WEBSOCKET",
    "RouteSelectionExpression": "string",
    "Tags": {
        "property1": "string",
        "property2": "string"
    },
    "Version": "string",
    "Warnings": []
}

Request

Path Params

apiId

string

required

The API identifier.

Responses

🟢200Success

application/json

Body

ApiEndpoint

string

optional

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

ApiGatewayManaged

boolean

optional

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

ApiId

string

optional

The API ID.

ApiKeySelectionExpression

string

optional

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

CorsConfiguration

object

optional

A CORS configuration. Supported only for HTTP APIs.

AllowCredentials

boolean

optional

Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

AllowHeaders

array[string]

optional

Represents a collection of allowed headers. Supported only for HTTP APIs.

AllowMethods

array[string]

optional

Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

AllowOrigins

array[string]

optional

Represents a collection of allowed origins. Supported only for HTTP APIs.

ExposeHeaders

array[string]

optional

Represents a collection of exposed headers. Supported only for HTTP APIs.

MaxAge

integer

optional

The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

>= -1<= 86400

CreatedDate

string <date-time>

optional

The timestamp when the API was created.

Description

string

optional

The description of the API.

DisableSchemaValidation

boolean

optional

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

DisableExecuteApiEndpoint

boolean

optional

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

ImportInfo

array[string]

optional

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

Name

string

optional

The name of the API.

ProtocolType

enum<string>

optional

The API protocol.

Allowed values:

WEBSOCKETHTTP

RouteSelectionExpression

string

optional

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be

re q u es t . m e t h o d

{request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.