Skip to main content
GET
/
basins
List Basins
curl --request GET \
  --url https://api.example.com/basins
{
  "basins": [
    {
      "name": "<string>",
      "scope": "<string>",
      "state": "<string>"
    }
  ],
  "has_more": true
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/s2-streamstore/s2/llms.txt

Use this file to discover all available pages before exploring further.

List basins in your account.

​
Query Parameters

​
prefix
string
Filter to basins whose names begin with this prefix.
​
start_after
string
Filter to basins whose names lexicographically start after this string. It must be greater than or equal to the prefix if specified.
​
limit
number
default:"1000"
Number of results, up to a maximum of 1000.

​
Response

​
basins
array
Matching basins (up to 1000 items).
​
has_more
boolean
Indicates that there are more basins that match the criteria.

​
Example

curl -X GET "https://aws.s2.dev/v1/basins?limit=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Response

{
  "basins": [
    {
      "name": "my-basin-1",
      "scope": "aws:us-east-1",
      "state": "active"
    },
    {
      "name": "my-basin-2",
      "scope": "aws:us-east-1",
      "state": "active"
    }
  ],
  "has_more": false
}

Build docs developers (and LLMs) love

Get started for freeTalk to us