Create Tag

Before you begin

Before attempting to create tags, make sure you have access to create a tag.

Request Structure


Endpoint:	`/ssh/tags/create`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ssh/tags/create?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
tags	(Mandatory) List of ssh tags. Type: List of sshTags

Table 2. sshTags
Name	Description
keyId	(Mandatory) Unique id for the tag. Type: String
label	(Mandatory) Label for the tag. Type: String
type	(Mandatory) Type of the tag. Possible Values: text, dropdown Type: String
value	Default value for the tag. (Applicable only for text type tags). Type: String
values	List of values for the tag. (Applicable only for dropdown type tags). Type: tagValues

Table 3. tagValues
Name	Description
label	(Mandatory) Label for the value. Type: String
value	Unique value for the List values. Type: String

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 which will have added tags and already available tags. Type: String
message	“Tags created successfully" Type: String
appStatusCode	null. Type: String
tags	More info in case of failure response.

Status Codes

Table 5. 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.
406 Not Acceptable	SSH-TAG-001	Tag already exists with the given Key ID Possible remediation: Check and ensure that the tag is not present for the given keyId. Else please change keyId and try again.
417 Expectation Failed	SSH-TAG-002	Failed to add SSH Tags Possible remediation: Check and ensure that the proper request is given for the create tag request.

Sample Request/Response

Use Case

To create tags using /tags/create API.

Request URL

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

Sample Request


{
  "tags": [
    {
      "keyId": "testKey",
      "type": "dropdown",
      "label": "TestLabel",
      "values": [
        {
          "label": "DropdownUpdated",
          "value": "dropdownUpdated"
        }
      ]
    }
  ]
}

Sample Response


{
   "response": "Added Successfully - [testKey]. Already Available - []",
   "message": "Tags created 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.