ApiGateway
A set of methods for managing API gateways.
JSON Representation
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"domain": "string",
"logGroupId": "string",
"attachedDomains": [
{
"domainId": "string",
"certificateId": "string",
"enabled": true,
"domain": "string"
}
],
"connectivity": {
"networkId": "string",
"subnetId": [
"string"
]
}
}
| Field | Description |
|---|---|
| id | string ID of the API gateway. Generated at creation time. |
| folderId | string ID of the folder that the API gateway belongs to. |
| createdAt | string (date-time) Creation timestamp for the API-gateway. String in RFC3339 text format. |
| name | string Name of the API gateway. The name is unique within the folder. |
| description | string Description of the API gateway. |
| labels | object API gateway labels as |
| status | string Status of the API gateway.
|
| domain | string Default domain for the API gateway. Generated at creation time. |
| logGroupId | string ID of the log group for the API gateway. |
| attachedDomains[] | object List of domains attached to API gateway. |
| attachedDomains[]. domainId |
string ID of the domain. |
| attachedDomains[]. certificateId |
string ID of the domain certificate. |
| attachedDomains[]. enabled |
boolean (boolean) Enabling flag. |
| attachedDomains[]. domain |
string Name of the domain. |
| connectivity | object Network access. If specified the gateway will be attached to specified network/subnet(s). Gateway connectivity specification. |
| connectivity. networkId |
string Network the gateway will have access to. It's essential to specify network with subnets in all availability zones. |
| connectivity. subnetId[] |
string Complete list of subnets (from the same network) the gateway can be attached to. It's essential to specify at least one subnet for each availability zones. |
Methods
| Method | Description |
|---|---|
| addDomain | Attaches domain to the specified API gateway. |
| create | Creates an API gateway in the specified folder. |
| delete | Deletes the specified API gateway. |
| get | Returns the specified API gateway. Note that only API gateway basic attributes are returned. To get associated openapi specification, make a getOpenapiSpec request. |
| getOpenapiSpec | Returns the OpenAPI specification of specified API gateway. |
| list | Retrieves the list of API gateways in the specified folder. |
| listAccessBindings | Lists existing access bindings for the specified API gateway. |
| listOperations | Lists operations for the specified API gateway. |
| removeDomain | Detaches domain from the specified API gateway. |
| setAccessBindings | Sets access bindings for the specified API gateway. |
| update | Updates the specified API gateway. |
| updateAccessBindings | Updates access bindings for the specified API gateway. |