The Cluster API does not support XML format.
Add
Add a new Cluster.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| NewObjectResponse with | Cluster added |
| Cluster Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
| Unknown error |
Delete
Remove a Cluster.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Cluster deleted | |
|
| |
| Authentication required | |
|
| |
| Unknown error |
Edit
Edit an existing Cluster.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Cluster updated | |
| Cluster Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
|
| |
| Unknown error |
View (all)
Retrieve all existing Clusters.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Cluster returned | |
| Authentication required | |
| Unknown error |
View (per CO)
Retrieve Clusters attached to a CO.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
| Clusters returned | |
| Authentication required | |
|
| |
| Unknown error |
View (one)
Retrieve an existing Cluster.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Cluster returned | |
| Authentication required | |
|
| |
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- cm_clusters data model definition