API Gateway Stage

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 Stage:
GraphQL
|
query {
  queryawsApiGatewayStage {
    id
    accountId
    arn
    region
    name
    description
    cacheCluster
    cacheClusterSize
    documentationVersion
    clientCertificateId
    xrayTracing
    accessLogSettings {
      format
      destinationArn
    }
    variables {
      key
      value
    }
    tags {
      id
      key
      value
    }
    restApi {
      arn
      # Other fields and connections here...
    }
  }
}
query {
  queryawsApiGatewayStage {
    id
    accountId
    arn
    region
    name
    description
    cacheCluster
    cacheClusterSize
    documentationVersion
    clientCertificateId
    xrayTracing
    accessLogSettings {
      format
      destinationArn
    }
    variables {
      key
      value
    }
    tags {
      id
      key
      value
    }
    restApi {
      arn
      # Other fields and connections here...
    }
  }
}
﻿
Filtering
Get data for a single API Gateway Stage that you know the ARN for:
GraphQL
|
query {
  getawsApiGatewayStage(arn: "arn:12345") {
    arn
    # Other fields and connections here...
  }
}
query {
  getawsApiGatewayStage(arn: "arn:12345") {
    arn
    # Other fields and connections here...
  }
}
﻿
Get data for all of the API Gateway Stages in a certain AWS account:
GraphQL
|
query {
  queryawsApiGatewayStage(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
# region
# description // can use fulltext filters
# name
# cacheCluster
# cacheClusterSize
# documentationVersion
# clientCertificateId
# xrayTracing

# And the following Dgraph filters can also be applied:

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

// fulltext filters
# alloftext
# anyoftext
query {
  queryawsApiGatewayStage(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
# region
# description // can use fulltext filters
# name
# cacheCluster
# cacheClusterSize
# documentationVersion
# clientCertificateId
# xrayTracing

# 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 Stages that are NOT in a certain AWS account:
GraphQL
|
query {
  queryawsApiGatewayStage(filter: { not: { accountId: { eq: "12345" } } }) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsApiGatewayStage(filter: { not: { accountId: { eq: "12345" } } }) {
    arn
    # Other fields and connections here...
  }
}
﻿
Advanced Filtering
Get data for all of the API Gateway Stages that have a rest API:
GraphQL
|
query {
  queryawsApiGatewayStage(filter: { has: restApi }) {
    arn
    # Other fields and connections here...
  }
}

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

# id
# accountId
# arn
# region
# description
# name
# cacheCluster
# cacheClusterSize
# accessLogSettings
# documentationVersion
# clientCertificateId
# xrayTracing
# tags
query {
  queryawsApiGatewayStage(filter: { has: restApi }) {
    arn
    # Other fields and connections here...
  }
}

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

# id
# accountId
# arn
# region
# description
# name
# cacheCluster
# cacheClusterSize
# accessLogSettings
# documentationVersion
# clientCertificateId
# xrayTracing
# tags
﻿
Use multiple filter selectors, (i.e. has, and, not, or) to get data for all of the API Gateway Stages that have a restApi AND tags OR that do not have description. Note that you can use has, and, not, or completely independently of each other:
GraphQL
|
query {
  queryawsApiGatewayStage(
    filter: {
      has: restApi
      and: { has: tags }
      or: { not: { has: description } }
    }
  ) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsApiGatewayStage(
    filter: {
      has: restApi
      and: { has: tags }
      or: { not: { has: description } }
    }
  ) {
    arn
    # Other fields and connections here...
  }
}
﻿
You may also filter using a regex when filtering on a string field like, description if you want to look for a value that matches say, some-value (case insensitive):
GraphQL
|
query {
  queryawsApiGatewayStage(
    filter: { description: { regexp: "/.*some-value*./i" } }
  ) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsApiGatewayStage(
    filter: { description: { 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 {
  queryawsApiGatewayStage(order: { desc: region }) {
    createdDate
    # Other fields and connections here...
  }
}

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

# id
# accountId
# arn
# description
# name
# cacheCluster
# cacheClusterSize
# documentationVersion
# clientCertificateId
# xrayTracing
query {
  queryawsApiGatewayStage(order: { desc: region }) {
    createdDate
    # Other fields and connections here...
  }
}

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

# id
# accountId
# arn
# description
# name
# cacheCluster
# cacheClusterSize
# documentationVersion
# clientCertificateId
# xrayTracing
﻿
Only select and return the first two API Gateway Stages that are found:
GraphQL
|
query {
  queryawsApiGatewayStage(first: 2, order: { desc: region }) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsApiGatewayStage(first: 2, order: { desc: region }) {
    arn
    # Other fields and connections here...
  }
}
﻿
Only select and return the first two API Gateway Stages that are found, but offset by one so API Gateway REST APIs two & three are returned:
GraphQL
|
query {
  queryawsApiGatewayStage(first: 2, order: { desc: region }, offset: 1) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsApiGatewayStage(first: 2, order: { desc: region }, offset: 1) {
    arn
    # Other fields and connections here...
  }
}
﻿
Aggregation
Count the number of API Gateway Stages across all scanned AWS accounts:
GraphQL
|
query {
  aggregateawsApiGatewayStage {
    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
# regionMin
# regionMax
# nameMin
# nameMax
# descriptionMin
# descriptionMax
# cacheClusterMin
# cacheClusterMax
# cacheClusterSizeMin
# cacheClusterSizeMax
# documentationVersionMin
# documentationVersionMax
# clientCertificateIdMin
# clientCertificateIdMax
# xrayTracingMin
# xrayTracingMax
query {
  aggregateawsApiGatewayStage {
    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
# regionMin
# regionMax
# nameMin
# nameMax
# descriptionMin
# descriptionMax
# cacheClusterMin
# cacheClusterMax
# cacheClusterSizeMin
# cacheClusterSizeMax
# documentationVersionMin
# documentationVersionMax
# clientCertificateIdMin
# clientCertificateIdMax
# xrayTracingMin
# xrayTracingMax
﻿
Count the number of API Gateway Stages in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
|
query {
  aggregateawsApiGatewayStage(filter: { accountId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
query {
  aggregateawsApiGatewayStage(filter: { accountId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
﻿
Examples
Get All the API Gateway Stages along with their rest API and tags for AWS Account 12345:
GraphQL
|
query {
  queryawsApiGatewayStage(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
    restApi {
      arn
      # Other fields and connections here...
    }
    tags {
      key
      value
    }
  }
}
query {
  queryawsApiGatewayStage(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
    restApi {
      arn
      # Other fields and connections here...
    }
    tags {
      key
      value
    }
  }
}
﻿
With CloudGraph you can run multiple queries at the same time so you can combine the above two queries if you like:
GraphQL
|
query {
  aggregateawsApiGatewayStage(filter: { accountId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
  queryawsApiGatewayStage(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
    restApi {
      arn
      # Other fields and connections here...
    }
    tags {
      key
      value
      # Other fields and connections here...
    }
  }
}
query {
  aggregateawsApiGatewayStage(filter: { accountId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
  queryawsApiGatewayStage(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
    restApi {
      arn
      # Other fields and connections here...
    }
    tags {
      key
      value
      # Other fields and connections here...
    }
  }
}
﻿
Kitchen Sink
Putting it all together; get all data for all API Gateway Stages 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 Stage -> REST API -> route 53 record ...etc:
GraphQL
|
query {
  queryawsApiGatewayStage {
    id
    accountId
    arn
    region
    name
    description
    cacheCluster
    cacheClusterSize
    documentationVersion
    clientCertificateId
    xrayTracing
    accessLogSettings {
      format
      destinationArn
    }
    variables {
      key
      value
    }
    tags {
      id
      key
      value
    }
    restApi {
      id
      accountId
      arn
      description
      policy{
        id
        # Other fields and connections here...
      }
      endpointConfiguration {
        id
        types
        vpcEndpointIds
      }
      apiKeySource
      createdDate
      minimumCompressionSize
      binaryMediaTypes
      tags {
        id
        key
        value
      }
      stages {
        arn
        # Other fields and connections here...
      }
      resources {
        arn
        # Other fields and connections here...
      }
      route53Record {
        id
        # Other fields and connections here...
      }
    }
  }
}
query {
  queryawsApiGatewayStage {
    id
    accountId
    arn
    region
    name
    description
    cacheCluster
    cacheClusterSize
    documentationVersion
    clientCertificateId
    xrayTracing
    accessLogSettings {
      format
      destinationArn
    }
    variables {
      key
      value
    }
    tags {
      id
      key
      value
    }
    restApi {
      id
      accountId
      arn
      description
      policy{
        id
        # Other fields and connections here...
      }
      endpointConfiguration {
        id
        types
        vpcEndpointIds
      }
      apiKeySource
      createdDate
      minimumCompressionSize
      binaryMediaTypes
      tags {
        id
        key
        value
      }
      stages {
        arn
        # Other fields and connections here...
      }
      resources {
        arn
        # Other fields and connections here...
      }
      route53Record {
        id
        # Other fields and connections here...
      }
    }
  }
}
﻿
References
﻿Dgraph documentation on querying﻿
﻿API Gateway Stage documentation﻿
Updated 03 Mar 2023
Did this page help you?
TABLE OF CONTENTS