List Stages
apigateway.get_stages
ActionAmazon Web Servicesconnection required
Calls the AWS apigateway API (SigV4).
List an API's deployed stages.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon API Gateway
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
rest_api_id Id of the rest api to act on, from its API Gateway URL or console — not its name. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
stages One entry per stage: stage_name, deployment_id, client_certificate_id, web_acl_arn, description, created_date, last_updated, documentation_version, tracing_enabled, cache_cluster_enabled/size/status, variables, tags and the canary_deployment_id / canary_percent_traffic of any canary release. | array | — |
count | number | — |
{
"count": 0,
"stages": []
}See List Stages run in a workflow.
In a technical demo we add the Amazon API Gateway connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.