GET
/
basins
curl --request GET \
  --url https://aws.s2.dev/v1alpha/basins \
  --header 'Authorization: Bearer <token>'
{
  "basins": [
    {
      "cell": "<string>",
      "name": "<string>",
      "scope": "<string>",
      "state": "unspecified"
    }
  ],
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
prefix
string

List basin names that begin with this prefix.

​
start_after
string

Only return basins names that lexicographically start after this name. This can be the last basin name seen in a previous listing, to continue from there. It must be greater than or equal to the prefix if specified.

​
limit
integer

Number of results, up to a maximum of 1000.

Required range: x > 0

Response

200
application/json

List basins response.

​
basins
object[]
required

Matching basins.

​
has_more
boolean
required

If set, indicates there are more results that can be listed with start_after.

Get basin configuration.