Skip to main content
GET
/
basins
List basins.
curl --request GET \
  --url https://aws.s2.dev/v1/basins \
  --header 'Authorization: Bearer <token>'
{
  "basins": [
    {
      "name": "<string>",
      "scope": "aws:us-east-1",
      "state": "active"
    }
  ],
  "has_more": true
}
Model paging by specifying start_after as the last basin name that was returned.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
prefix
string
default:""

Filter to basins whose names begin with this prefix.

​
start_after
string
default:""

Filter to basins whose names lexicographically start after this string. It must be greater than or equal to the prefix if specified.

​
limit
integer
default:1000

Number of results, up to a maximum of 1000.

Required range: 0 <= x <= 1000

Response

​
basins
object[]
required

Matching basins.

Maximum array length: 1000
​
has_more
boolean
required

Indicates that there are more basins that match the criteria.