Chapter 11. Clusters Service


11.1. Clusters Service

11.1.1. DeleteCluster

DELETE /v1/clusters/{id}

11.1.1.1. Description

11.1.1.2. Parameters

11.1.1.2.1. Path Parameters
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

11.1.1.3. Return Type

Object

11.1.1.4. Content Type

  • application/json

11.1.1.5. Responses

Table 11.1. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

11.1.1.6. Samples

11.1.2. GetCluster

GET /v1/clusters/{id}

11.1.2.1. Description

11.1.2.2. Parameters

11.1.2.2.1. Path Parameters
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

11.1.2.3. Return Type

V1ClusterResponse

11.1.2.4. Content Type

  • application/json

11.1.2.5. Responses

Table 11.2. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ClusterResponse

0

An unexpected error response.

GooglerpcStatus

11.1.2.6. Samples

11.1.3. GetClusterDefaultValues

GET /v1/cluster-defaults

11.1.3.1. Description

11.1.3.2. Parameters

11.1.3.3. Return Type

V1ClusterDefaultsResponse

11.1.3.4. Content Type

  • application/json

11.1.3.5. Responses

Table 11.3. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ClusterDefaultsResponse

0

An unexpected error response.

GooglerpcStatus

11.1.3.6. Samples

11.1.4. GetClusters

GET /v1/clusters

11.1.4.1. Description

11.1.4.2. Parameters

11.1.4.2.1. Query Parameters
NameDescriptionRequiredDefaultPattern

query

 

-

null

 

11.1.4.3. Return Type

V1ClustersList

11.1.4.4. Content Type

  • application/json

11.1.4.5. Responses

Table 11.4. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ClustersList

0

An unexpected error response.

GooglerpcStatus

11.1.4.6. Samples

11.1.5. GetKernelSupportAvailable

GET /v1/clusters-env/kernel-support-available

GetKernelSupportAvailable is deprecated in favor of GetClusterDefaultValues.

11.1.5.1. Description

11.1.5.2. Parameters

11.1.5.3. Return Type

V1KernelSupportAvailableResponse

11.1.5.4. Content Type

  • application/json

11.1.5.5. Responses

Table 11.5. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1KernelSupportAvailableResponse

0

An unexpected error response.

GooglerpcStatus

11.1.5.6. Samples

11.1.6. PostCluster

POST /v1/clusters

11.1.6.1. Description

11.1.6.2. Parameters

11.1.6.2.1. Body Parameter
NameDescriptionRequiredDefaultPattern

body

StorageCluster

X

  

11.1.6.3. Return Type

V1ClusterResponse

11.1.6.4. Content Type

  • application/json

11.1.6.5. Responses

Table 11.6. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ClusterResponse

0

An unexpected error response.

GooglerpcStatus

11.1.6.6. Samples

11.1.7. PutCluster

PUT /v1/clusters/{id}

11.1.7.1. Description

11.1.7.2. Parameters

11.1.7.2.1. Path Parameters
NameDescriptionRequiredDefaultPattern

id

 

X

null

 
11.1.7.2.2. Body Parameter
NameDescriptionRequiredDefaultPattern

body

ClustersServicePutClusterBody

X

  

11.1.7.3. Return Type

V1ClusterResponse

11.1.7.4. Content Type

  • application/json

11.1.7.5. Responses

Table 11.7. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ClusterResponse

0

An unexpected error response.

GooglerpcStatus

11.1.7.6. Samples

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat