Skip to main content
POST
Create a basin.

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
null | object

Basin configuration.

location
null | string

Basin location. If omitted when creating, uses the default location for the account.

Required string length: 1 - 64

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.

location
null | string

Basin location.

Required string length: 1 - 64