Get all Kubernetes application groups

Select

SaaS

Customer Managed

API to get all Kubernetes application groups

Query Parameters

• clusterId int32

  clusterId is the ID of the Kubernetes cluster client to filter Application Groups for

Responses

• 200
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• applicationGroupCount int32
• applicationGroups object[]

  id int32

  ID of the Kubernetes Application group

  name string

  Name of the Kubernetes Application Group

  isDefaultApplicationGroup boolean

  Specifies whether the Application Group is a default Application Group

  snapBackupEnabled boolean

  Specifies if snap backup is enabled

  cluster object

  id int32

  name string

  displayName string

  plan object

  id int32

  name string

  company object

  id int32

  Id of company

  name string

  Name of company

  multiCommcellId int32

  Multi Commcell Id of company

  tags object[]

  List of Tags associated to the Kubernetes Application Group

  id int32

  name string

  value string

  instance object

  id int32

  name string

  lastBackup object

  last backup job details for the client

  time int32

  UNIX time for the last backup job run

  jobId int32

  Job id of the last backup job

  status string

  Possible values: [NEVER_BACKED_UP, COMPLETED, FAILED, COMPLETED_WITH_ERRORS, KILLED, SUSPENDED, INTERRUPTED, ANY_STATUS, SKIPPED, FAILED_TO_START, SYNCHRONIZED, NOT_SYNCHRONIZED, NOT_ATTEMPTED, STARTED, COMPLETED_WITH_WARNINGS, SYSTEM_FAILED, COMMITTED]

  Status of the last backup job performed.

  lastSuccessfulBackupTime int32

  UNIX time for the last successful backup job run

  failureReason string

  Failure reason for the last backup job

{
  "applicationGroupCount": 0,
  "applicationGroups": [
    {
      "id": 0,
      "name": "string",
      "isDefaultApplicationGroup": true,
      "snapBackupEnabled": true,
      "cluster": {
        "id": 0,
        "name": "string",
        "displayName": "string"
      },
      "plan": {
        "id": 0,
        "name": "string"
      },
      "company": {
        "id": 0,
        "name": "string",
        "multiCommcellId": 0
      },
      "tags": [
        {
          "id": 0,
          "name": "string",
          "value": "string"
        }
      ],
      "instance": {
        "id": 0,
        "name": "string"
      },
      "lastBackup": {
        "time": 0,
        "jobId": 0,
        "status": "NEVER_BACKED_UP",
        "lastSuccessfulBackupTime": 0,
        "failureReason": "string"
      }
    }
  ]
}

Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

GET /v5/kubernetes/applicationgroup    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

clusterId — query

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/ApplicationGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/ApplicationGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/ApplicationGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/ApplicationGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/ApplicationGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/ApplicationGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/ApplicationGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'