Skip to main content

Transfer Cluster

Provided that the target user belongs to your organization, you can transfer a cluster to them, as long as they have permission to hold it!

Transfer a cluster to another user​

By providing the API with a cluster slug and an email, a cluster can be transferred with a single call.

curl -X 'PATCH' \
  'https://api.gigapipe.com/v1/clusters/<your_cluster_slug>/transfer?email=alfred@lamborgini.com' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <your_access_token>'
# Payload response ::Dictionary
{
  "message": "Cluster <cluster-test> transferred to <alfred@lamborgini.com>"
}

Transfer cluster parameters​

Attributes​

email  ::String

The email of the user you want to transfer the cluster to

slug  ::String

The cluster slug

Transfer cluster response​

Attributes​

message  ::String

A basic response message