CA Inventory View

Before you begin

Ensure the following before attempting to view the CA inventory:

Refer to Prerequisites in the PKI User Guide.

Request Structure


Endpoint:	v1/pki/ca/ca-list
Type:	GET
Sample URL:	`https://<IP/HostName/TenantName>:>GWPORT>/avxapi/v1/pki/ca/ca-list?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.

Response Structure

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

Table 2. Parameters
Name	Description
response	Contains the response attributes for the view CA inventory 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.
name	Name of the CA or certificate. Type: String
description	Description field; `null` in this example. Type: String
certificateType	Type of certificate (e.g., Root CA, Intermediate CA). Type: String
createdTime	Timestamp when the entry was created. Type: String
expiryTime	Timestamp for expiry; `null` likely means it has not been issued yet. Type: String
status	Status of the certificate (e.g., `NEW`, `ISSUED`, etc.). Type: String
approverStatus	Approval status (e.g., `CREATE_REJECTED`, or `null` if not yet reviewed). Type: String
iTotalDisplayRecords	Indicates the total number of records after applying the search filter. Type: String
searchQuery	Specifies the search term used to filter results. Type: String

Status Codes


HTTP Code	appStatusCode	Response Message
200 Accepted	null	View CA inventory 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.

Sample Response

Response

{
    "response": {
        "data": [
            {
                "name": "Test1",
                "description": null,
                "certificateType": "Root CA",
                "createdTime": 1746781702035,
                "expiryTime": null,
                "status": "NEW",
                "approverStatus": null
            },
            {
                "name": "asd",
                "description": null,
                "certificateType": "Root CA",
                "createdTime": 1746781552135,
                "expiryTime": null,
                "status": "NEW",
                "approverStatus": "CREATE_REJECTED"
            },
            {
                "name": "qwe",
                "description": null,
                "certificateType": "Root CA",
                "createdTime": 1746781536971,
                "expiryTime": null,
                "status": "NEW",
                "approverStatus": "CREATE_REJECTED"
            },
            {
                "name": "Test",
                "description": null,
                "certificateType": "Root CA",
                "createdTime": 1746781524420,
                "expiryTime": null,
                "status": "NEW",
                "approverStatus": null
            }
        ],
        "iTotalDisplayRecords": 4,
        "searchQuery": null
    },
    "message": null,
    "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.