Skip to main content

Update properties of a Kubernetes application group

Select

SaaS
Customer Managed

API to update properties of a Kubernetes application group

Path Parameters
  • applicationGroupId int32 required

    applicationGroupId is the ID of the Kubernetes application group

Request Body
  • name string

    Specify new name to rename an Application Group

  • plan object
  • id int32
  • name string
  • content object

    Item describing the content for Application Group

  • overwrite boolean

    Default value: false

    Specifies whether content has to be overwritten or appended

  • applications object[]

    List of applications to be added as content

  • GUID string required

    GUID value of the Kubernetes Application to be associated as content

  • type string required

    Possible values: [NAMESPACE, APPLICATION, PVC, LABELS]

    Type of the Kubernetes application

  • name string

    Name of the application

  • labelSelectors object[]

    List of label selectors to be added as content

  • selectorValue string required

    Value of the label selector in key=value format

  • selectorLevel string required

    Possible values: [Application, Volumes, Namespace]

    Selector level of the label selector

  • filters object

    Item to describe the applications and label selectors for filters

  • overwrite boolean

    Default value: false

    Specifies whether content has to be overwritten or appended

  • skipStatelessApps boolean

    Default value: false

    Specify whether to skip backup of stateless applications

  • applications object[]

    List of applications to be added as content

  • GUID string required

    GUID value of the Kubernetes Application to be associated as content

  • type string required

    Possible values: [NAMESPACE, APPLICATION, PVC, LABELS]

    Type of the Kubernetes application

  • name string

    Name of the application

  • labelSelectors object[]

    List of label selectors to be added as content

  • selectorValue string required

    Value of the label selector in key=value format

  • selectorLevel string required

    Possible values: [Application, Volumes, Namespace]

    Selector level of the label selector

  • options object
  • backupStreams int32

    Default value: 5

    Define number of parallel data readers

  • jobStartTime int32

    Define the backup job start time in epochs

  • onSnapFailureFallbackToLiveVolume boolean

    Default value: false

    Define setting to enable fallback to live volume backup in case of snap failure

  • scheduleWorkerToConfigNamespace boolean

    Default value: false

    Define setting to enable scheduling worker Pods to CV Namespace for CSI-Snapshot enabled backups

  • workerResources object
  • cpuLimits string

    Define limits.cpu to set on the worker Pod

  • cpuRequests string

    Define requests.cpu to set on the worker Pod

  • memoryLimits string

    Define limits.memory to set on the worker Pod

  • memoryRequests string

    Define requests.memory to set on the worker Pod

  • timezone object
  • id int32
  • name string
  • activityControl object
  • enableBackup boolean

    Default value: true

  • tags object[]
  • name string
  • value string
Responses

OK


Schema
  • errorMessage string
  • errorCode int32
PUT /v5/kubernetes/applicationgroup/:applicationgroupid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
applicationGroupId — path required
Body
{
"name": "string",
"plan": {
"id": 0,
"name": "string"
},
"content": {
"overwrite": false,
"applications": [
{
"GUID": "string",
"type": "NAMESPACE",
"name": "string"
}
],
"labelSelectors": [
{
"selectorValue": "string",
"selectorLevel": "Application"
}
]
},
"filters": {
"overwrite": false,
"skipStatelessApps": false,
"applications": [
{
"GUID": "string",
"type": "NAMESPACE",
"name": "string"
}
],
"labelSelectors": [
{
"selectorValue": "string",
"selectorLevel": "Application"
}
]
},
"options": {
"backupStreams": 5,
"jobStartTime": 0,
"onSnapFailureFallbackToLiveVolume": false,
"scheduleWorkerToConfigNamespace": false,
"workerResources": {
"cpuLimits": "string",
"cpuRequests": "string",
"memoryLimits": "string",
"memoryRequests": "string"
}
},
"timezone": {
"id": 0,
"name": "string"
},
"activityControl": {
"enableBackup": true
},
"tags": [
{
"name": "string",
"value": "string"
}
]
}
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/ApplicationGroup/:applicationGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"name": "string",
"plan": {
"id": 0,
"name": "string"
},
"content": {
"overwrite": false,
"applications": [
{
"GUID": "string",
"type": "NAMESPACE",
"name": "string"
}
],
"labelSelectors": [
{
"selectorValue": "string",
"selectorLevel": "Application"
}
]
},
"filters": {
"overwrite": false,
"skipStatelessApps": false,
"applications": [
{
"GUID": "string",
"type": "NAMESPACE",
"name": "string"
}
],
"labelSelectors": [
{
"selectorValue": "string",
"selectorLevel": "Application"
}
]
},
"options": {
"backupStreams": 5,
"jobStartTime": 0,
"onSnapFailureFallbackToLiveVolume": false,
"scheduleWorkerToConfigNamespace": false,
"workerResources": {
"cpuLimits": "string",
"cpuRequests": "string",
"memoryLimits": "string",
"memoryRequests": "string"
}
},
"timezone": {
"id": 0,
"name": "string"
},
"activityControl": {
"enableBackup": true
},
"tags": [
{
"name": "string",
"value": "string"
}
]
}'