API Stability Short-Term

The deleteClusterConnection() GraphQL mutation may be used to delete a cluster connection from a view.

Syntax

Below is the syntax for the deleteClusterConnection() mutation field:

graphql
deleteClusterConnection(
       input: DeleteClusterConnectionInput!
   ): boolean!

Below is an example of how this mutation field might be used:

Show:
graphql
mutation {
  deleteClusterConnection( input: {
         multiClusterViewName: "humidor",
         connectionId: "123456789"
  } )
}
Example Responses
Show:
json
{
  "data": {
    "deleteClusterConnection": true
  }
}

Given Datatypes

For DeleteClusterConnectionInput, there are two parameters. Below are descriptions of them:

Table: DeleteClusterConnectionInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 18, 2024
connectionIdstringyes  The unique identifier of the connection to delete.
multiClusterViewNamestringyes  The name or unique identifier of the multi-cluster view from which to delete the connection.