Skip to main content
POST
Add a shard to a Neki shard configuration profile

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization
string
required

Organization name slug from list_organizations. Example: acme.

database
string
required

Database name slug from list_databases. Example: app-db.

branch
string
required

Branch name from list_branches. Example: main.

configuration_profile
string
required

Name from list_shard_configuration_profiles.

Body

application/json
display_name
string

The display name of the shard

Response

Returns the created shard

id
string
required

The ID of the shard

name
string
required

The name of the shard

display_name
string | null
required

The display name of the shard

configuration_profile
string
required

The name of the shard configuration profile

created_at
string
required

When the shard was created

ready
boolean
required

Whether the shard has been created on the cluster

authoritative
boolean
required

Whether the shard is the authoritative shard of the cluster