Delete Tag

Before you begin

Before attempting to delete tags, make sure the tags to be deleted are already added in AppViewX.

Request Structure


Endpoint:	`/ssh/tags/delete`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ssh/tags/delete?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 `queryParam`	(Mandatory) Request Id of the bulk upload request. 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
keyId	(Mandatory) List of tag keyIDs. Type: List of 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 message of the api which will have the result as successfully deleted key and failed keys Type: String
message	“Tags deleted successfully" Type: String
appStatusCode	null. Type: String
tags	More info in case of failure response.

Status Codes

Table 3. 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.
406 Expectation Failed	SSH-TAG-004	Error while deleting ssh tags from keys Possible remediation: Check and ensure that the proper request is given for the delete tags request.
417 Expectation Failed	SSH-TAG-003	Could not process request due to invalid input Possible remediation: Check and ensure that the proper keyId is given for the delete tag request.

Sample Request/Response

Use Case

To delete tags using /tags/delete API.

Request URL

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

Sample Request

[“testKey”]

Sample Response


{
   "response": "Deleted Successfully - []. Failed to delete - []",
   "message": "Tags deleted 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.