website logo
HomeGithubSlack
⌘K
Overview
Quick Start
Supported Services
Running CloudGraph in EKS
Compliance
Rules Engine
AWS
Querying AWS Data
AWS Policy Packs
Billing Data
Services
Azure
Querying Azure Data
Azure Policy Packs
Services
GCP
Querying GCP Data
GCP Policy Packs
Services
K8s
Querying Kubernetes Data
Services
Docs powered by archbee 

API Gateway REST API

17min

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
|
query {
  queryawsApiGatewayRestApi {
    id
    accountId
    arn
    description
    policy {
      id
      # Other fields and connections here...
    }
    endpointConfiguration {
      id
      types
      vpcEndpointIds
    }
    apiKeySource
    createdDate
    minimumCompressionSize
    tags {
      id
      key
      value
    }
    binaryMediaTypes
    stages {
      arn
      # Other fields and connections here...
    }
    resources {
      arn
      # Other fields and connections here...
    }
    route53Record {
      id
      # Other fields and connections here...
    }
  }
}


Filtering

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

GraphQL
|
query {
  getawsApiGatewayRestApi(arn: "arn:12345") {
    arn
    # Other fields and connections here...
  }
}


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

GraphQL
|
query {
  queryawsApiGatewayRestApi(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "accountId" you can
# Filter based on any of the following attributes:

# id
# arn
# description // can use fulltext filters
# policy
# apiKeySource
# createdDate
# minimumCompressionSize
# binaryMediaTypes

# And the following Dgraph filters can also be applied:

# has
# and
# or
# not
# regexp (regular expressions)

// fulltext filters
# alloftext
# anyoftext


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

GraphQL
|
query {
  queryawsApiGatewayRestApi(filter: { not: { accountId: { eq: "12345" } } }) {
    arn
    # Other fields and connections here...
  }
}


Advanced Filtering

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

GraphQL
|
query {
  queryawsApiGatewayRestApi(filter: { has: stages }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "stages" you can filter
# Using "has" based on any of the following attributes:

# id
# accountId
# arn
# description
# policy
# endpointConfiguration
# apiKeySource
# createdDate
# minimumCompressionSize
# tags
# binaryMediaTypes
# resources
# route53Record


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
|
query {
  queryawsApiGatewayRestApi(
    filter: {
      has: stages
      and: { has: resources }
      or: { not: { has: route53Record } }
    }
  ) {
    arn
    # Other fields and connections here...
  }
}


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
|
query {
  queryawsApiGatewayRestApi(
    filter: { policy: { regexp: "/.*some-value*./i" } }
  ) {
    arn
    # Other fields and connections here...
  }
}


Ordering

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

GraphQL
|
query {
  queryawsApiGatewayRestApi(order: { desc: createdDate }) {
    createdDate
    # Other fields and connections here...
  }
}

# Note that in addition to "createdDate" you can filter
# Using "asc" or "desc" based on any of the following attributes:

# id
# accountId
# arn
# description
# policy
# apiKeySource
# minimumCompressionSize


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

GraphQL
|
query {
  queryawsApiGatewayRestApi(first: 2, order: { desc: createdDate }) {
    createdDate
    # Other fields and connections here...
  }
}


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
|
query {
  queryawsApiGatewayRestApi(first: 2, order: { desc: createdDate }, offset: 1) {
    createdDate
    # Other fields and connections here...
  }
}


Aggregation

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

GraphQL
|
query {
  aggregateawsApiGatewayRestApi {
    count
    # Other fields and connections here...
  }
}

# Note that in addition to "count" you can request the
# Following min and max values based on attributes of your API Gateway REST APIs:

# idMin
# idMax
# accountIdMin
# accountIdMax
# arnMin
# arnMax
# descriptionMin
# descriptionMax
# policyMin
# policyMax
# apiKeySourceMin
# apiKeySourceMax
# createdDateMin
# createdDateMax
# minimumCompressionSizeMin
# minimumCompressionSizeMax
# minimumCompressionSizeSum
# minimumCompressionSizeAvg


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
|
query {
  aggregateawsApiGatewayRestApi(filter: { accountId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}


Examples

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

GraphQL
|
query {
  queryawsApiGatewayRestApi(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
    stages {
      arn
      # Other fields and connections here...
    }
    resources {
      arn
      # Other fields and connections here...
    }
  }
}


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

GraphQL
|
query {
  aggregateawsApiGatewayRestApi(filter: { accountId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
  queryawsApiGatewayRestApi(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
    stages {
      arn
      # Other fields and connections here...
    }
    resources {
      arn
      # Other fields and connections here...
    }
  }
}


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
|
query {
  queryawsApiGatewayRestApi {
    id
    accountId
    arn
    description
    policy {
      id
      # Other fields and connections here...
    }
    endpointConfiguration {
      id
      types
      vpcEndpointIds
    }
    apiKeySource
    createdDate
    minimumCompressionSize
    tags {
      id
      key
      value
    }
    binaryMediaTypes
    stages {
      id
      accountId
      arn
      name
      description
      cacheCluster
      cacheClusterSize
      accessLogSettings {
        id
        # Other fields and connections here...
      }
      documentationVersion
      clientCertificateId
      xrayTracing
      variables {
        key
        value
      }
      tags {
        id
        key
        value
      }
      restApi {
        arn
        # Other fields and connections here...
      }
    }
    resources {
      id
      accountId
      arn
      restApi {
        arn
        # Other fields and connections here...
      }
      path
      methods {
        arn
        # Other fields and connections here...
      }
    }
    route53Record {
      id
      accountId
      zoneId
      alias {
        name
        zoneId
        evaluateTargetHealth
      }
      type
      ttl
      records
      route53HostedZone {
        arn
        # Other fields and connections here...
      }
      elb {
        arn
        # Other fields and connections here...
      }
      alb {
        arn
        # Other fields and connections here...
      }
      restApi {
        arn
        # Other fields and connections here...
      }
    }
  }
}


References

Dgraph documentation on querying

API Gateway REST API documentation

Updated 03 Mar 2023
Did this page help you?
Yes
No
PREVIOUS
API Gateway Overview
NEXT
API Gateway Stage
Docs powered by archbee 
TABLE OF CONTENTS
Overview
Filtering
Advanced Filtering
Ordering
Aggregation
Examples
Kitchen Sink
References