API Gateway
API Gateway is an application that acts as a "front door" for backend services and APIs, handling client requests and routing them to the appropriate backend.
Last updated
API Gateway is an application that acts as a "front door" for backend services and APIs, handling client requests and routing them to the appropriate backend.
Last updated
An API gateway consists of the generic rules and configurations.
id
- (Computed)[string] The ID of the API Gateway.
name
- (Required)[string] The name of the API Gateway.
logs
- (Optional)[bool] Enable or disable logging. Defaults to false
. NOTE: Central Logging must be enabled through the Logging API to enable this feature.
metrics
- (Optional)[bool] Enable or disable metrics. Defaults to false
.
custom_domains
- (Optional)[list] Custom domains for the API Gateway, a list that contains elements with the following structure:
name
- (Required)[string] The domain name. Externally reachable.
certificate_id
- (Optional)[string] The certificate ID for the domain. Must be a valid certificate in UUID form.
public_endpoint
- (Computed)[string] The public endpoint of the API Gateway.
In order to import an API Gateway, you can define an empty API Gateway resource in the plan:
The resource can be imported using the gateway_id
, for example: