Update a Customer-Controlled Cluster using its unique identifier. You can provide any combination of supported fields. If a field is not provided, the field will not be updated.
dc:put ]
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "MISSION CONTROL",
"description": "Documentation for Mission Control API",
"version": "2.2.1"
},
"servers": [
{
"url": "https://api.solace.cloud",
"description": "Solace Cloud US EAST Region"
},
{
"url": "https://api.solacecloud.com.au",
"description": "Solace Cloud AU Region"
},
{
"url": "https://api.solacecloud.eu",
"description": "Solace Cloud EU Region"
},
{
"url": "https://api.solacecloud.sg",
"description": "Solace Cloud SG Region"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/api/v2/missionControl/privateRegions/{id}": {
"patch": {
"tags": [
"Customer-Controlled Clusters"
],
"summary": "(Beta) Update a Customer-Controlled Cluster",
"description": "Update a Customer-Controlled Cluster using its unique identifier. You can provide any combination of supported fields.\nIf a field is not provided, the field will not be updated.
\ndc:put ]",
"operationId": "patchPrivateRegion",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerControlledCluster"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateRegionResponse"
}
}
}
},
"400": {
"description": "Bad request.",
"content": {
"application/json": {}
}
},
"401": {
"description": "Unauthorized.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "An authentication error occurred.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"403": {
"description": "Forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "You do not have permissions to perform this operation.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"404": {
"description": "Entity Not Found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"502": {
"description": "Bad Gateway - Marketplace integration error.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "Service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
}
},
"components": {
"schemas": {
"CustomerControlledCluster": {
"required": [
"name",
"provider",
"regionId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the datacenter for the customer-controlled cluster."
},
"name": {
"type": "string",
"description": "The name of the customer-controlled cluster."
},
"provider": {
"type": "string",
"description": "The cloud provider of the customer-controlled cluster.",
"example": "eks"
},
"regionId": {
"type": "string",
"description": "The cloud region of the customer-controlled cluster.",
"example": "us-east-1"
},
"environmentId": {
"type": "string",
"description": "The environment for the customer-controlled cluster.",
"example": "dev"
},
"useServiceClassSelectors": {
"type": "boolean",
"description": "Whether to use service class node selectors.",
"example": true,
"default": true
},
"imageRepository": {
"type": "string",
"description": "The container registry to use for downloading Mission Control Agent and event broker images.",
"example": "gcr.io/my-gcp-project",
"default": "gcr.io/gcp-maas-prod"
},
"imagePullSecretName": {
"type": "string",
"description": "The name of the Kubernetes secret that contains the container registry credentials.",
"example": "my-container-registry-secret",
"default": "gcr-reg-secret"
},
"storageClass": {
"type": "string",
"description": "The name of the Kubernetes storage class used for broker persistent volumes.",
"example": "ssd",
"default": "gp2"
},
"cloudAgentPodLabels": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The labels to apply to the Mission Control Agent pod.",
"example": "{key: value}"
},
"description": "The labels to apply to the Mission Control Agent pod.",
"example": "{key: value}"
},
"cloudAgentNodeSelectors": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The node selectors to apply to the Mission Control Agent pod.",
"example": "{key: value}"
},
"description": "The node selectors to apply to the Mission Control Agent pod.",
"example": "{key: value}"
},
"cloudAgentTolerations": {
"type": "array",
"description": "The tolerations to apply to the Mission Control Agent pod.",
"example": "{key: nodeType, value: agent, effect: NoSchedule, operator: Equal}",
"items": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The tolerations to apply to the Mission Control Agent pod.",
"example": "{key: nodeType, value: agent, effect: NoSchedule, operator: Equal}"
},
"description": "The tolerations to apply to the Mission Control Agent pod.",
"example": "{key: nodeType, value: agent, effect: NoSchedule, operator: Equal}"
}
},
"primaryPodLabels": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The labels to apply to the primary pod.",
"example": "{key: value}"
},
"description": "The labels to apply to the primary pod.",
"example": "{key: value}"
},
"primaryNodeSelectors": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The node selectors to apply to the primary pod.",
"example": "{key: value}"
},
"description": "The node selectors to apply to the primary pod.",
"example": "{key: value}"
},
"primaryTolerations": {
"type": "array",
"description": "The tolerations to apply to the primary pod.",
"example": "{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}",
"items": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The tolerations to apply to the primary pod.",
"example": "{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"
},
"description": "The tolerations to apply to the primary pod.",
"example": "{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"
}
},
"backupPodLabels": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The labels to apply to the backup pod.",
"example": "{key: value}"
},
"description": "The labels to apply to the backup pod.",
"example": "{key: value}"
},
"backupNodeSelectors": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The node selectors to apply to the backup pod.",
"example": "{key: value}"
},
"description": "The node selectors to apply to the backup pod.",
"example": "{key: value}"
},
"backupTolerations": {
"type": "array",
"description": "The tolerations to apply to the backup pod.",
"example": "{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}",
"items": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The tolerations to apply to the backup pod.",
"example": "{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"
},
"description": "The tolerations to apply to the backup pod.",
"example": "{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"
}
},
"monitorPodLabels": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The labels to apply to the monitoring pod.",
"example": "{key: value}"
},
"description": "The labels to apply to the monitoring pod.",
"example": "{key: value}"
},
"monitorNodeSelectors": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The node selectors to apply to the monitoring pod.",
"example": "{key: value}"
},
"description": "The node selectors to apply to the monitoring pod.",
"example": "{key: value}"
},
"monitorTolerations": {
"type": "array",
"description": "The tolerations to apply to the monitoring pod.",
"example": "{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}",
"items": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "The tolerations to apply to the monitoring pod.",
"example": "{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"
},
"description": "The tolerations to apply to the monitoring pod.",
"example": "{key: nodeType, value: broker, effect: NoSchedule, operator: Equal}"
}
},
"serviceAnnotations": {
"type": "array",
"description": "The annotations on Kubernetes services for legacy load balancers.",
"example": "[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n]\n",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"key": {
"type": "string"
}
},
"description": "The annotations on Kubernetes services for legacy load balancers.",
"example": "[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n]\n"
}
},
"internalServiceAnnotations": {
"type": "array",
"description": "The annotations on Kubernetes services for private connection endpoints of Solace event brokers.",
"example": "[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n {service.beta.kubernetes.io/aws-load-balancer-type: internal},\n]\n",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"key": {
"type": "string"
}
},
"description": "The annotations on Kubernetes services for private connection endpoints of Solace event brokers.",
"example": "[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n {service.beta.kubernetes.io/aws-load-balancer-type: internal},\n]\n"
}
},
"externalServiceAnnotations": {
"type": "array",
"description": "The annotations on Kubernetes services for public connections endpoints of Solace event brokers.",
"example": "[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n {service.beta.kubernetes.io/aws-load-balancer-type: external},\n]\n",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"key": {
"type": "string"
}
},
"description": "The annotations on Kubernetes services for public connections endpoints of Solace event brokers.",
"example": "[\n {service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: true},\n {service.beta.kubernetes.io/aws-load-balancer-type: external},\n]\n"
}
},
"type": {
"type": "string"
}
}
},
"ErrorResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A user-friendly message that describes the error.",
"example": "An error occurred."
},
"errorId": {
"type": "string",
"description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "The metadata about the error. This provides additional information about the error that occurred.",
"example": "'object': { 'field': 'description' }"
},
"description": "The metadata about the error. This provides additional information about the error that occurred.",
"example": "'object': { 'field': 'description' }"
},
"validationDetails": {
"type": "object",
"additionalProperties": {
"type": "array",
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']",
"items": {
"type": "string",
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
}
},
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
}
}
},
"PrivateRegionResponse": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CustomerControlledCluster"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}
```