Skip to main content
PATCH
Assign shards 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
shard_ids
string[]
required

The IDs of the shards to assign

Response

Returns an assignment result for each requested shard

id
string
required

The public ID of the shard

status
string
required

One of assigned, unchanged, or failed

error
object | null

The assignment error