> For the complete documentation index, see [llms.txt](https://docs.kangal.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kangal.dev/integrations/aws-api-gateway.md).

# AWS API Gateway

This integration reads a regional inventory of REST APIs, HTTP/WebSocket APIs, and a bounded set of stage names by sending AWS Signature Version 4 requests directly to the API Gateway REST endpoints.

## Required values

| Type          | Field               | Required | Notes                                                 |
| ------------- | ------------------- | -------- | ----------------------------------------------------- |
| Configuration | `region`            | Yes      | AWS region, for example `eu-west-1`                   |
| Configuration | `page_size`         | No       | Console default is `25`; driver range is `1` to `500` |
| Secret        | `access_key_id`     | Yes      | Dedicated AWS access key ID                           |
| Secret        | `secret_access_key` | Yes      | Matching secret access key                            |
| Secret        | `session_token`     | No       | Required when using temporary credentials             |

The credentials need read access to the API Gateway collection and stage endpoints in the selected region.

## What sync calls

* `GET /restapis?limit={page_size}` for REST APIs.
* `GET /v2/apis?MaxResults={page_size}` for HTTP and WebSocket APIs.
* The corresponding stages endpoint for the first configured number of APIs. The driver default is the first `10` APIs across the REST-first combined list.

## Metadata returned

The result contains `region`, `rest_api_count`, `http_api_count`, `api_count`, `stage_count`, `truncated`, and `apis`. Each `apis` item contains `id`, `name`, `type`, `created_date`, and `stage_names`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.kangal.dev/integrations/aws-api-gateway.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.