Upgrade Cluster Command

Request Structure


Endpoint:	`/kube-get-cluster-installation-command`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/kube-get-cluster-installation-command?gwsource=kube` To understand the elements of the sample URL, click here.
Headers:
Content-Type:	application/json

Table 1. Input Parameter
Name	Description
sessionId `Header`	(Mandatory) A unique identifier assigned to a user's session upon successful authentication. The session ID remains valid until it expires, and it can contain alphanumeric characters. Type: String Constraints: The session ID is used when username and password are not provided. Example: `A1B2c3d4E5F6`
gwsource `Header`	(Mandatory) Source from which the request is triggered. Type: String Example: `DataCenterA`
payload `Body`	(Mandatory) Input data for request body in application/json format. For payload details, see Payload section.

Payload

Table 2. Payload Details
Name	Description
hook `Object`	Contains all the hook params.
input `Object`	Tenant Key

Table 3. Hook Details
Name	Description
name `String`	(Mandatory) Name of the hook. Possible values: Cluster

Table 4. Input Details
Name	Description
action `String`	(Mandatory) Specific action. Possible values: upgrade_commands
payload `payload`	Contains all the payload params.

Table 5. Payload Parameter
Name	Description
clusterName `String`	(Mandatory) Name of the Cluster.
purpose `String`	(Mandatory) Features to be enabled in the cert-orchestrator deployed in the cluster. Possible Values: Provision Certificates to K8s Secrets Discover Certificates Provision Certificates to Ephemeral Volumes Discover K8's Infra Certificates Enable mTLS Certificates for Service Mesh

Response Structure


Name	Description
response `String`	The response contains the upgrade status.
message `String`	Success message or failure description in case of error.
appStatusCode `String`	Application specific status code for the response. Will be non-null for failure response.
tags	More info in case of failure response.

Sample Request/Response

Use case: Upgrade command for a cluster.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/kube-get-cluster-installation-command ?gwsource=kube

Sample Request

POST Content type: application/json Username: <> Password: <>
{
    "payload": {
        "hook": {
            "name": "Cluster"
        },
        "input": {
            "action": "upgrade_commands",
            "payload": {
                "clusterName": "testing.appviewx.net",
                "purpose": [
                    "Provision Certificates to K8s Secrets",
                    "Discover Certificates",
                    "Provision Certificates to Ephemeral Volumes"
                ]
            }
        }
    }
}

Sample Response

{
  "response": {
    "status": "Success",
    "output": {
      "status": "Success",
      "response": "\"Update Command\"\nhelm upgrade crypto-mesh crypto-mesh/crypto-mesh --version v1.1 --n"
    },
    "type": "script"
  },
  "message": null,
  "appStatusCode": null,
  "tags": null,
  "headers": null
}

Reference

Understanding the sample URL: This section provides an explanation of each component of the sample URL structure used in API requests. For quick reference, this section is referenced in all the API topics as Reference in this guide.

IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
- IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication
  The IP address will be included in the endpoint URL for an on-prem deployment.
- HostName: A human-readable label assigned to a device (host) on a network
  The hostname will be included in the endpoint URL for an on-prem deployment.
- TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify
  The tenant name will be included in the endpoint URL for a SaaS deployment.
GWPORT: AppViewX gateway port
A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: execute-hook
gwsource: Source or origin of a gateway, for example: external.

What's Next

Cluster Inventory