ExternalCluster

Provides a list of all the external clusters available to be added to management plane

get

Path parameters

projectIdstringRequired

UUID of the project the cluster belongs to

Header parameters

X-Auth-TokenstringRequired

Responses

200

OK, List of external clusters.

No content

get

/v4/{projectId}/externalClusters/discover

HTTPcURLJavaScriptPython

GET /qbert/v4/{projectId}/externalClusters/discover HTTP/1.1
X-Auth-Token: text
Accept: */*

200

OK, List of external clusters.

No content

Registers an external cluster

post

Path parameters

projectIdstringRequired

UUID of the project the cluster belongs to

Header parameters

X-Auth-TokenstringRequired

Body

application/json

idstringOptional

An unique cluster idenfier

providerstringOptional

Name of the external K8S cluster provider service

cloudProviderIDstringOptional

UUID of a cloud provider in PF9

providerDetailsobjectOptional

A dynamic field to include cloud specific parameters. For example, for EKS, we need the region to be able to register a cluster

Responses

200

OK, if cluster create request was submitted successfully

No content

403

Unauthorized to perform this operation

404

Cluster could not be founds

409

Cluster already registered

post

/v4/{projectId}/externalClusters/register

HTTPcURLJavaScriptPython

POST /qbert/v4/{projectId}/externalClusters/register HTTP/1.1
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "id": "text",
  "provider": "text",
  "cloudProviderID": "text",
  "providerDetails": {}
}

No content

Deregister an external cluster

post

Path parameters

projectIdstringRequired

UUID of the project the cluster belongs to

Header parameters

X-Auth-TokenstringRequired

Responses

200

OK, if cluster create request was submitted successfully

No content

403

Unauthorized to perform this operation

post

/v4/{projectId}/externalClusters/:clusterID/deregister

HTTPcURLJavaScriptPython

POST /qbert/v4/{projectId}/externalClusters/:clusterID/deregister HTTP/1.1
X-Auth-Token: text
Accept: */*

No content

Get the deployment YAML for a private external cluster

get

Path parameters

projectIdstringRequired

UUID of the project the cluster belongs to

Header parameters

X-Auth-TokenstringRequired

Responses

200

OK, if cluster create request was submitted successfully

No content

403

Unauthorized to perform this operation

404

Cluster or the cluster agent could not be found

get

/v4/{projectId}/externalClusters/:clusterID/deploymentYAML

HTTPcURLJavaScriptPython

GET /qbert/v4/{projectId}/externalClusters/:clusterID/deploymentYAML HTTP/1.1
X-Auth-Token: text
Accept: */*

No content