GET

/restapis/{restapi_id}/resources

http://apigateway.{region}.amazonaws.com/restapis/{restapi_id}/resources

Lists information about a collection of Resource resources.

Access Token Required: API Key

Path Parameters

restapi_idstringrequired

The string identifier of the associated RestApi.

Query Params

positionstring

The current pagination position in the paged result set.

limitinteger

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

embedarray

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the <code>"methods"</code> string. For example, <code>GET /restapis/{restapi_id}/resources?embed=methods</code>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://apigateway.{region}.amazonaws.com/restapis/{restapi_id}/resources' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}