Bulk Upload Tags

Before you begin

Before attempting to bulk upload, make sure the fingerPrints of keys passed are present in the database.

Request Structure


Endpoint:	`/ssh/key/upload/tags`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ssh/key/upload/tags?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
Payload `Body`	(Mandatory) Contains all the parameters to be sent in the request body for the post request. Type: Payload

Payload


Name	Description
keyType	(Mandatory) Type of ssh key where the tags have to be updated. Type: String Possible values: “userKeys”, “hostKeys”
keyTagRequests	(Mandatory) List of keyTagRequests. Type: List of keyTagRequests

Table 2. keyTagRequests
Name	Description
fingerPrint	(Mandatory) Fingerprint of the ssh key where tags have to be updated. Type: String
tags	(Mandatory) List of tags to be updated. Type: List of tags

Table 3. tags
Name	Description
tagKey	(Mandatory) Tag key. Type: String Example: Tag1
tagValue	(Mandatory) User defined value for the respective tagKey. Type: List of tags Example: testTag

Response Structure

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

Table 4. Response Parameters
Name	Description
response	Contains the response message of the API. Type: SSH Key tag upload 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 5. SSH key tags upload response:
Name	Description
requestId	Request id of the uploaded ssh key tags request Type: String
status	"Uploaded Successfully" Type: String

Status Codes

Table 6. Status Codes and Description
HTTP Status code	appStatusCode	Message and Possible remediation
200 OK	NA	Success
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	VALIDATION_ERROR_0004	Mandatory field <<field name>> is missing or or empty Possible remediation: Check and ensure that valid value is provided for <<field name>> field in the request.
400 Bad Request	ERR-SSH_NB-270	Max request size exceeded::[Max request size allowed is 25] Possible remediation: Check and ensure that the number of requests specified in the payload is less than 25.
417 Expectation Failed	ERR-SSH-NB-298	One or more groups do not have permission to perform this action. Possible remediation: Check and ensure that the user has access to the specified key compliance group.

Sample Request/Response

Use Case

To bulk upload tags using upload/tags API.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ssh/key/upload/tags?gwsource=external

Sample Request


{
        "keyType": "userKeys",
        "keyTagRequests": [
            {
                "fingerPrint": "lR60OrKkhpgzTDyRnE8EEzIy0sQo8QyrLBXkvWI7+Sg",
                "tags": {
                    "test": "testTag"
                }
            }
        ]
}

Sample Response


{
    "response": {
        "requestId": "aac7fe37-6d8a-4f62-ac61-00fcd6abefb5",
        "status": "Uploaded Successfully"
    },
    "message": null,
    "appStatusCode": null,
    "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.

What's Next

Bulk Upload Tags Status Check