Delete a Certificate Group

Before you Begin

The user should have the required ACF permissions to delete the certificate group.

Request Structure


Endpoint:	/certificate/group
Type:	DELETE
Action:	certificate-group-delete
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/certificate/group?groupName=<groupName>&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 Constraint: Required if username and password are not provided.
username `Header`	(Mandatory) AppViewX login username. Type: String Constraint: Required if sessionId is not provided.
password `Header`	(Mandatory) AppViewX login password. Type: String Constraint: Required if sessionId is not provided.
Content-Type `Header`	(Mandatory) Specifies the nature of the data in the payload. Type: String Constraint: Value of the parameter should be ‘application/json’
groupName `Header`	(Mandatory) Name of the certificate group to be deleted
gwsource `Query`	(Mandatory) Source from which the request is triggered. (E.g. external) Type: String

Response Structure

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

Table 2. Parameters
Name	Description
response	Contains the response for the group deletion operation Type: Boolean
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.

Status codes


HTTP Code	appStatusCode	Response Message
202 Accepted	null	View certificate group action has been triggered successfully
401 Unauthorized	AVX_GW_003	Authentication failed, reason - Invalid Credentials. Remediation: Ensure that valid username and password or a valid sessionId is provided as header parameters.
404 Not Found	NO_RECORDS_FOUND	No matching records found. Remediation: Check and ensure that the values provided for commonName / serialNumber / resourceId are correct.
400 Bad Request	INVALID_REQUEST	Please give valid common name and serial number or resourceId. Remediation: Provide a valid commonName and serialNumber or resourceId.
400 Bad Request	INVALID_REQUEST	Please provide a valid action. Remediation: Provide a valid action.
400 Bad Request	MANDATORY_FIELD_MISSING	Mandatory field is missing or invalid - action. Remediation: Ensure that the action field is available in the request payload.
417 Expectation failed	CERT-GRP-0002	Default group cannot be deleted.
417 Expectation failed	CERT-GRP-0007	User does not permission to make changes to this group. Remediation: Ensure that the requisite RW permissions are assigned to the user for group deletion.
417 Expectation failed	CERT-GRP-0022	Can't delete root level groups with children below it. Remediation: Root/parent group with children cannot be deleted.

Sample Request/Response

Sample Request

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/certificate/group?groupName=MasterGroup1&gwsource=external

Sample Response

{
   "response": "Certificate Group Deleted successfully",
   "message": "Certificate Group Deleted successfully",
   "appStatusCode": null,
   "tags": {},
   "headers": null
}

References

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.