Get Vcf Certificates

Get paginated list of certificates based on query parameters

Request

URI

POST

https://{api_host}/suite-api/api/fleet-management/certificate-management/certificates/query

COPY

Query Parameters

integer

page

Optional

Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer

pageSize

Optional

Constraints: default: 10

Expected number of entries per page

string

sortBy

Optional

Certificate field to sort by

Enumeration: STATUS, APPLIANCE, CATEGORY, TYPE, APPLIANCE_FQDN, VCF_COMPONENT_TYPE, SDDC_DOMAIN_ID, VCF_INSTANCE_ENDPOINT, CERTIFICATE_COMMON_NAME, EXPIRY_DATE, AUTO_RENEW_STATUS, CERTIFICATE_PURPOSE, CERTIFICATE_CHAIN_ROLE, CERTIFICATE_CHAIN_GROUP_ID

string

sortOrder

Optional

Sort direction for the results

Enumeration: ASCENDING, DESCENDING

Request Body

The certificate search request with search criteria

VcfCertificateSearchRequest of type(s) application/json

Required

{
    "appliance": "string",
    "applianceFqdn": "string",
    "category": "string",
    "certificateChainGroupId": "string",
    "certificateChainRole": "string",
    "certificatePurpose": "string",
    "status": "string",
    "type": "string"
}

string

appliance

Optional

Appliance or component type for certificate searches (e.g., VCENTER, NSXT_MANAGER, SDDC_MANAGER, VCF_AUTOMATION, LOG_MANAGEMENT, VCF_OPERATIONS, VCF_OPS_NETWORKS, IDENTITY_BROKER, VCF_OPS_HCX, ESX, VCF_SERVICES_RUNTIME, AVI_LOAD_BALANCER, LICENSE_SERVER, CLOUD_PROXY)

Enumeration: VCENTER, SDDC_MANAGER, NSXT_MANAGER, VCF_AUTOMATION, LOG_MANAGEMENT, VCF_OPERATIONS, VCF_OPS_NETWORK, IDENTITY_BROKER, VCF_OPS_HCX, ESX, VCF_SERVICES_RUNTIME, AVI_LOAD_BALANCER, LICENSE_SERVER, UNKNOWN, SUPERVISOR, CLOUD_PROXY

string

applianceFqdn

Optional

Fully qualified domain name of the appliance

string

category

Optional

Certificate category for search requests. Common types: TLS_CERT, ROOT_CERT, INTERMEDIATE_CERT. Component-specific types are also supported (e.g., STS_CERT, VMCA_ROOT for vCenter; LOCAL_MANAGER, CBM_CORFU for NSX; VIP, NSX_LB for Supervisor; POLICY_LB_CERT, POLICY_VPN_CERT for NSX policy certificates).

Enumeration: TLS_CERT, ROOT_CERT, INTERMEDIATE_CERT, UNKNOWN, STS_CERT, VMCA_ROOT, KMS_CLIENT_CERT, KMS_SERVER_CERT, SOLUTION_USER_CERT, VRNI_GRPC_CERT, VIP, NSX_LB, LOCAL_MANAGER, GLOBAL_MANAGER, CBM_CORFU, CBM_CLUSTER_MANAGER, APH, APH_TN, TN, CCP, WEB_PROXY, SYSLOG_SERVER, COMPUTE_MANAGER, CLIENT_AUTH, POLICY_LB_CERT, POLICY_VPN_CERT

string

certificateChainGroupId

Optional

Chain group ID for grouping certificates in the same chain

string

certificateChainRole

Optional

Certificate chain role (LEAF, INTERMEDIATE, ROOT)

string

certificatePurpose

Optional

Certificate purpose (e.g., MACHINE_SSL_CERT, STS_CERT)

string

status

Optional

Certificate expiry status for search requests (e.g., EXPIRED, EXPIRING_30, EXPIRING_60, NORMAL)

Enumeration: EXPIRED, EXPIRING_30, EXPIRING_60, NORMAL, UNKNOWN

string

type

Optional

Certificate signing CA type (e.g., VMCA, OPENSSL_CA, MSCA, EXTERNAL_CA, SELF_SIGNED_CA)

Enumeration: VMCA, OPENSSL_CA, MSCA, EXTERNAL_CA, SELF_SIGNED_CA, UNKNOWN

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

List of certificates

Returns VcfCertificatesResponse of type(s) application/json

"{\n  \"vcfCertificateModels\" : [ {\n    \"certificateResourceKey\" : \"vcenter.vsphere.com_1234_cert\",\n    \"issuedTo\" : \"vcenter.vsphere.local.com\",\n    \"appliance\" : \"VCENTER\",\n    \"displayApplianceType\" : \"vCenter\",\n    \"category\" : \"TLS_CERT\",\n    \"categoryDisplayName\" : \"TLS Certificate\",\n    \"type\" : \"SSL_CERTIFICATE\",\n    \"issuedBy\" : \"CA\",\n    \"status\" : \"NORMAL\",\n    \"displayStatus\" : \"Active\",\n    \"daysToExpire\" : 30,\n    \"applianceFqdn\" : \"vcenter.vsphere.local.com\",\n    \"redirectAvailable\" : true,\n    \"domainId\" : \"domain-123\",\n    \"vcfEndpoint\" : \"vcenter.vsphere.local.com\",\n    \"vcfComponent\" : \"VCENTER\",\n    \"issuedToCommonName\" : \"vcenter.vsphere.local.com\",\n    \"autoRenewState\" : \"ENABLED\",\n    \"displayAutoRenewState\" : \"Enabled\"\n  }, {\n    \"certificateResourceKey\" : \"nsx.vsphere.com_5678_cert\",\n    \"issuedTo\" : \"nsx.vsphere.local.com\",\n    \"appliance\" : \"NSXT_MANAGER\",\n    \"displayApplianceType\" : \"NSX Manager\",\n    \"category\" : \"TLS_CERT\",\n    \"categoryDisplayName\" : \"TLS Certificate\",\n    \"type\" : \"SSL_CERTIFICATE\",\n    \"issuedBy\" : \"CA\",\n    \"status\" : \"NORMAL\",\n    \"displayStatus\" : \"Active\",\n    \"daysToExpire\" : 60,\n    \"applianceFqdn\" : \"nsx.vsphere.local.com\",\n    \"redirectAvailable\" : true,\n    \"domainId\" : \"domain-456\",\n    \"vcfEndpoint\" : \"nsx.vsphere.local.com\",\n    \"vcfComponent\" : \"NSXT_MANAGER\",\n    \"issuedToCommonName\" : \"nsx.vsphere.local.com\",\n    \"autoRenewState\" : \"DISABLED\",\n    \"displayAutoRenewState\" : \"Disabled\"\n  } ]\n}"

array of object

links

Optional

Collection of links

object

pageInfo

Optional

Represents page information for a paged result

array of object

vcfCertificateModels

Optional

List of certificates

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/suite-api/api/fleet-management/certificate-management/certificates/query

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Fleet Certificate Management Operations

GET

Get Vcf Certificate Authorities

PUT