Fetch Upload SSH Key Status

Before you begin

Before attempting to fetching SSH status, the user has to ensure the following:

The keys are present in the inventory.

Request Structure


Endpoint:	`ssh/keys/upload/request/status`
Type:	`GET`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ssh/keys/upload/request/status?gwsource=external` To understand the elements of the sample URL, click here.
Headers:
Content-Type:	application/json

Table 1. Request Parameters
Name	Description
sessionId `Header`	(Mandatory) Session ID received after login. Type: String Constraints: Required if username and password are not provided.
username `Header`	(Mandatory) AppViewX login username Type: String Constraints: Required if sessionId is not provided.
password `Header`	(Mandatory) AppViewX login password Type: String Constraints: Required if sessionId is not provided.
Content-Type `Header`	(Mandatory) Specifies the nature of the data in the payload Type: String Constraints: The value of the param should be ‘application/json’.
gwsource `Query`	(Mandatory) Source from which the request is triggered. (E.g. external) Type: String
requestId `Query`	The UUID returned from the upload API. Type: String

Response Structure

200 OK returns string of type application/json with the following body params.

Table 2. Response Parameters
Name	Description
response	Contains the response attributes for the host keys Type: response
message	Success message of the action or failure description in case of error. Will be non-null for failure response Type: String
appStatusCode	Application-specific status code for the response. Will be non-null for failure response Type: String
tags	More info in case of failure response

Table 3. Response
Name	Description
status	The result of the upload operation. Example: `"Keys Upload information retrieved successfully"`

Status Codes

Table 4. Status Codes and Description
HTTP Status code	appStatusCode	Message and Possible remediation
200 OK	NA	Keys Upload information retrieved successfully
401 Unauthorized	AVX_GW_003	Authentication failed, reason - Invalid Credentials Possible remediation: Ensure that valid username and password or valid sessionId is provided as the header param.
400 Bad Request	AVX-VLDTN-001	Mandatory field is missing or invalid values specified - <<field name>> Possible remediation: Check and ensure that valid value is provided for <<field name>> field in the request.

Sample Request/Response

Use Case

To retrieve uploaded SSH keys (userKeys or hostKeys) status, using /ssh/keys/upload/request/status API.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ssh/keys/upload/request/status?gwsource=external

Sample Response

{
    "response": {
        "uuid": "3f01c360-0abd-4e3d-bbdc-258690f5ce2e",
        "keyType": "hostKeys",
        "failureDetails": [
            {
                "errorMessage": "Duplicate Key Name exists.",
                "requestIndexUUID": {
                    "1": "8df5b465-29cf-4d3d-b5e7-d154a48b5573"
                }
            }
        ],
        "totalKeys": 2,
        "failedKeys": 1,
        "inProgressKeys": 0,
        "completedKeys": 1,
        "status": "Partially Completed",
        "startTime": 1745238716249,
        "completedTime": 1745238768299,
        "userName": "admin",
        "_id": "68063abcaa38e1526d7ebb72"
    },
    "message": "Keys Upload information retrieved successfully",
    "appStatusCode": null,
    "tags": null,
    "headers": null
}

Reference

Understanding the sample URL:

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.
Note: GWPORT is not required for SaaS setups.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: /ssh/host/create
gwsource: Source or origin of a gateway, for example: external.

What's Next

Delete Upload SSH Key