SSH Download KRL

Before you begin

Before attempting to downloading KRL, the user has to ensure the following:

KRL should be present in AppViewX.

Request Structure


Endpoint:	`/ssh/krl/download`
Type:	`GET`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ssh/krl/download?caName=dev-ssh.user.ca&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
caName `queryParam`	(Mandatory) Name of the CA 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 KRL file 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
content	Content of the KRL Type: String
name	Name of the CA Type: String

Status Codes

Table 4. Status Codes and Description
HTTP Status code	appStatusCode	Message and Possible remediation
200 OK	NA	KRL file downloaded 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	ERR-SSH_NB-247	Invalid query param found for <FieldName> Possible remediation: Please make sure to provide valid values
400 Bad Request	ERR-CA-515	KRL file does not exist or file size mismatch Possible remediation: Please make sure to provide proper values in request

Sample Request/Response

Use Case

To download KRL using download_KRL API.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ssh/krl/download?gwsource=external

Sample URL

https://pe-ssh-apvx-n4.lab.appviewx.net:31443/avxapi/ssh/krl/download?caName=dev-ssh.user.ca&gwsource=internal

Sample Response


{
    "response": {
        "name": "dev-ssh.user.ca",
        "content": "content"
    },
    "message": "",
    "appStatusCode": "",
    "tags": {},
    "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.