Skip to main content
POST
/
basins
Create a basin.
curl --request POST \
  --url https://aws.s2.dev/v1/basins \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "basin": "<string>",
  "config": "<unknown>",
  "scope": "aws:us-east-1"
}
'
{
  "name": "<string>",
  "scope": "aws:us-east-1",
  "state": "active"
}
Creating a basin is usually synchronous, however in some cases it can take a little longer. Check the state in the response body to know whether it is still being created.

Authorizations

​
Authorization
string
header
required

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

Headers

​
s2-request-token
string

Client-specified request token for idempotent retries.

Body

application/json
​
basin
string
required

Basin name which must be globally unique. It can be between 8 and 48 characters in length, and comprise lowercase letters, numbers and hyphens. It cannot begin or end with a hyphen.

Required string length: 1 - 48
​
config
object

Basin configuration.

​
scope
enum<string>
default:aws:us-east-1

Basin scope.

Available options:
aws:us-east-1

Response

​
name
string
required

Basin name.

Required string length: 1 - 48
​
scope
enum<string>
required

Basin scope.

Available options:
aws:us-east-1
​
state
enum<string>
required

Basin state.

Available options:
active,
creating,
deleting