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>"
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "scope": "aws:us-east-1"
}

Documentation Index

Fetch the complete documentation index at: https://s2.dev/docs/llms.txt

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

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.

Maximum string length: 36

Body

application/json
​
basin
string
required

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

Required string length: 8 - 48
​
config
object

Basin configuration.

​
scope
null | enum<string>

Basin scope.

Available options:
aws:us-east-1

Response

​
created_at
string<date-time>
required

Creation time in RFC 3339 format.

​
name
string
required

Basin name.

Required string length: 8 - 48
​
deleted_at
string<date-time> | null

Deletion time in RFC 3339 format, if the basin is being deleted.

​
scope
null | enum<string>

Basin scope.

Available options:
aws:us-east-1