18min

API Gateway REST API

Note: if you are running CloudGraph locally you can view the interactive, automatically generated documentation in either GraphQL Playground or Altair by clicking the docs button on the right-hand side of the screen. After reading the below information we highly suggest you use one of these tools to test your queries as they will autocomplete fields for you and let you know if your queries are valid before you even submit them.

Overview

You can currently query the following attributes and connections on an API Gateway REST API:

GraphQL
|

Filtering

Get data for a single API Gateway REST API that you know the ARN for:

GraphQL
|

Get data for all of the API Gateway REST APIs in a certain AWS account:

GraphQL
|

Get data for all of the API Gateway REST APIs that are NOT in a certain AWS account:

GraphQL
|

Advanced Filtering

Get data for all of the API Gateway REST APIs that have Stages:

GraphQL
|

Use multiple filter selectors, (i.e. has, and, not, or) to get data for all of the API Gateway REST APIs that have Stages AND Resources OR that do not have Route53 Records. Note that you can use has, and, not, or completely independently of each other:

GraphQL
|

You may also filter using a regex when filtering on a string field like, policy if you want to look for a value that matches say, some-value (case insensitive):

GraphQL
|

Ordering

You can order the results you get back either asc or desc depending on your preference:

GraphQL
|

Only select and return the first two API Gateway REST APIs that are found:

GraphQL
|

Only select and return the first two API Gateway REST APIs that are found, but offset by one so API Gateway REST APIs two & three are returned:

GraphQL
|

Aggregation

Count the number of API Gateway REST APIs across all scanned AWS accounts:

GraphQL
|

Count the number of API Gateway REST APIs in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:

GraphQL
|

Examples

Get All the API Gateway REST APIs along with their Stages and Resources for AWS Account 12345:

GraphQL
|

With CloudGraph you can run multiple queries at the same time so you can combine the above two queries if you like:

GraphQL
|

Kitchen Sink

Putting it all together; get all data for all API Gateway REST APIs across all regions for all scanned AWS accounts in a single query. For the purposes of this example we will only get direct children of the API Gateway REST APIs but if you want to it's easy to go from say, API Gateway REST API -> Resouce -> Method...etc:

GraphQL
|

References



Updated 30 Dec 2021
Did this page help?
Yes
No