HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

Create a Cluster Affinity Group

This endpoint will create an affinity group for a specific cluster.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

The ID of the cluster

Body Params
affinityGroup
object
tenantPermissions
object
Responses

errors is keyed by the request field that failed, and each value is a stable
i18n message code. msg carries the human-readable text for the same failure.

A rule must be exactly one of two shapes — a legacy VM-to-VM rule that lists
servers, or a combined VM-to-Host rule that references both a vmGroup and
a hostGroup. Sending both shapes, or only one half of a combined rule, is
rejected here. The same mutual exclusion is enforced a second time at the
domain layer under the code affinityGroup.ruleShape.invalid.

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json