Lists the RestApis resources for your collection¶

Description¶

Lists the RestApis resources for your collection.

Usage¶

apigateway_get_rest_apis(position, limit)

Arguments¶

position

The current pagination position in the paged result set.
limit

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Value¶

A list with the following syntax:

list(
  position = "string",
  items = list(
    list(
      id = "string",
      name = "string",
      description = "string",
      createdDate = as.POSIXct(
        "2015-01-01"
      ),
      version = "string",
      warnings = list(
        "string"
      ),
      binaryMediaTypes = list(
        "string"
      ),
      minimumCompressionSize = 123,
      apiKeySource = "HEADER"|"AUTHORIZER",
      endpointConfiguration = list(
        types = list(
          "REGIONAL"|"EDGE"|"PRIVATE"
        ),
        ipAddressType = "ipv4"|"dualstack",
        vpcEndpointIds = list(
          "string"
        )
      ),
      policy = "string",
      tags = list(
        "string"
      ),
      disableExecuteApiEndpoint = TRUE|FALSE,
      rootResourceId = "string",
      securityPolicy = "TLS_1_0"|"TLS_1_2"|"SecurityPolicy_TLS13_1_3_2025_09"|"SecurityPolicy_TLS13_1_3_FIPS_2025_09"|"SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_FIPS_PFS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_Ext2_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_Ext2_FIPS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_2021_06"|"SecurityPolicy_TLS13_2025_EDGE"|"SecurityPolicy_TLS12_PFS_2025_EDGE"|"SecurityPolicy_TLS12_2018_EDGE",
      endpointAccessMode = "BASIC"|"STRICT",
      apiStatus = "UPDATING"|"AVAILABLE"|"PENDING"|"FAILED",
      apiStatusMessage = "string"
    )
  )
)

Request syntax¶

svc$get_rest_apis(
  position = "string",
  limit = 123
)