Delete Certificate Discovery

Request Structure


Endpoint:	/cert-discovery-history-delete
Type:	PUT
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/cert-discovery-history-delete?gwsource=external` To understand the elements of the sample URL, click here.
Headers
Content-Type:	application/json

Table 1. Input 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) Username that is configured in AppViewX. Type: String
password `Header`	(Mandatory) Password of that user. Type: String
content-type `Header`	(Mandatory) Payload content-type with application/json value. Type: String Constraint: The value must be application/json.
gwsource `Query`	(Mandatory) The source from which the request is triggered, e.g., external. Type: String
Payload `Body`	Contains all the parameters to be sent in the request body for the put request. Type: Payload (Refer Payload table below)

Table 2. Payload
Name	Description
NA	(Mandatory) Discovery IDs Type: Array of String

Response returns string of type application/json with the following body parameters:

Table 3. Parameters
Name	Description
response	Contains the response attributes for the enrollment request.
message	Success message or failure description in case of error. Type: String
appStatusCode	Application specific status code for the response. It is a non-null value for a failure response. Type: String
tags	Additional information in case of failure response.


HTTP Code	appStatusCode	Response Message
202 Accepted	NA	Success.
400 Bad Request	AVX-VLDTN-001	Invalid payload data. Remediation: Ensure the payload is correct or meets the validation rules specified by the validation protocol.
400 Bad Request	MSG_DISC_DISCOVERY_NOTFOUND	Discovery details not available. Remediation: The discovery ID must be valid or present in the database.
500 Internal Server Error	avx-common-011	Error while processing.

Request Payload

["507f1f77bcf86cd799439011", "507f1f77bcf86cd799439022", "507f1f77bcf86cd799439033"]

Response

{
"response": "success",
"message": null,
"appStatusCode": null,
"tags": null
}

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.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: execute-hook
gwsource: Source or origin of a gateway, for example: external.