Skip to main content
POST
Create placement group

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

project_id
integer
required

Project ID.

Example:

1

Query Parameters

dry_run
boolean
default:false

Run every check of the real request and change nothing. The response has the status code and the schema of the real call, and an empty list of tasks. With false, the default, the request does the operation.

Body

application/json
name
string
required

Placement group name. A name starting with k8s- is rejected with 400 validation-error. The prefix is reserved for the groups that managed Kubernetes creates.

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,108}[a-zA-Z0-9._]$
Example:

"web-affinity"

policy
enum<string>
required

Placement policy: affinity, anti-affinity, soft-affinity, or soft-anti-affinity.

Available options:
affinity,
anti-affinity,
soft-affinity,
soft-anti-affinity
Example:

"anti-affinity"

region_id
integer
required

Region to create the placement group in.

Example:

5

Response

Task IDs

tasks
string[]
required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

  • GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.
Example: