Retrieve all certificate data

get https://api.venafi.cloud/outagedetection/v1/certificates

This endpoint allows you to retrieve all your certificates according to a specified criteria. This API provides a quick way to gather certificate details in order to install the certificates where they are needed.

Use the subject query parameter to limit the search based on the certificate subject common name.

Responses

Response body

object

certificates

array of objects

A collection of certificates

certificates

object

applicationIds

array of uuids

A collection of application IDs

applicationIds

archivedDate

date-time

The date a certificate was archived

authorityKeyIdentifierHash

string

An authority key identifier hash

certificateAuthorityAccountId

uuid

UUID of a certificate authority account

certificateName

string

A certificate name

certificateRequestId

uuid

UUID of a certificate request

certificateStatus

string

Certificate's status

ACTIVE RETIRED DELETED

companyId

uuid

UUID of a company

dekHash

string

A certificate dek hash

encryptionType

string

A certificate encryption type

RSA DSA EC GOST3410 ECGOST3410 RESERVED3 UNKNOWN

extendedKeyUsage

array of strings

A collection of certificate extended key usages

extendedKeyUsage

fingerprint

string

A certificate fingerprint

uuid

UUID of a certificate

inhibitAnyPolicy

int32

Inhibit any policy

inhibitPolicyMapping

int32

Inhibit policy mapping

instances

array of objects

A collection of certificate instances information

instances

object

applicationIds

array of uuids

A collection of application IDs

applicationIds

certificateId

uuid

UUID of a certificate

certificateInstanceId

uuid

UUID of a certificate instance

certificateSource

string

Certificate source

UNKNOWN USER_PROVIDED USER_IMPORTED USER_SCAN TRUSTNET_SCAN ON_PREM_CA_IMPORT EXTERNAL_CA_IMPORT FILE_IMPORT EXTERNAL_SCAN DOMAIN_SCAN SMART_SCAN_INTERNAL SMART_SCAN_EXTERNAL SMART_VALIDATION_INTERNAL SMART_VALIDATION_EXTERNAL MACHINE_DISCOVERY KUBERNETES_DISCOVERY AWS_DISCOVERY AZURE_DISCOVERY GCP_DISCOVERY

deploymentStatus

string

The deployment status

UNKNOWN IN_USE SUPERSEDED

hostname

string

A hostname

instanceChainValidationStatus

array of strings

A collection of the instance chain validation status

instanceChainValidationStatus

ipAddress

string

An ip address

lastScanDate

date-time

The last scan date

lastValidatedAttempt

date-time

The last validation attempt date

modificationDate

date-time

The last modification date

port

int32

A port number

serviceIds

array of uuids

A collection of service IDs

serviceIds

sslProtocols

array of strings

A collection of ssl protocols

sslProtocols

sslValidationErrorArguments

array of strings

A collection of ssl validation error arguments

sslValidationErrorArguments

sslValidationStatus

string

SSL validation status

HOSTNAME_NOT_RESOLVABLE NO_CERTIFICATE_PRESENTED INVALID_CERTIFICATE_FOUND UNEXPECTED_CERTIFICATE_FOUND OLD_VERSION_CERTIFICATE_FOUND TARGET_UNREACHABLE UNKNOWN_ERROR OK

sslValidationStatusMessage

string

SSL validation status message

issuerAlternativeNameDns

array of strings

A collection of certificate issuer alternative names DNs

issuerAlternativeNameDns

issuerAlternativeNameNonDns

array of strings

A collection of certificate issuer alternative name none DNs

issuerAlternativeNameNonDns

issuerC

string

A certificate issues Country

issuerCN

array of strings

A collection of certificate issuer Common names

issuerCN

issuerCertificateIds

array of uuids

A collection of issuer certificate IDs

issuerCertificateIds

issuerDN

string

A certificate issue DN

issuerL

string

A certificate issues Locality

issuerOU

array of strings

A collection of certificate issuer Organization units

issuerOU

issuerST

string

A certificate issuer State

keyCurve

string

A certificate key curve

P256 P384 P521 ED25519 UNKNOWN

keyStrength

int32

A certificate key strength

keyUsage

array of strings

A collection of certificate key usages

keyUsage

lastNotification

int32

managedCertificateId

uuid

UUID of a managed certificate

modificationDate

date-time

The last date a certificate was modified

ocspNoCheck

boolean

If a certificate no ocsp check

ownership

object

pathLength

int32

A certificate path length

requireExplicitPolicy

int32

Required explicit policy is required

selfSigned

boolean

If the certificate is self singed

serialNumber

string

A certificate serial number

signatureAlgorithm

string

A certificate signature algorithm

MD2_WITH_RSA_ENCRYPTION MD5_WITH_RSA_ENCRYPTION SHA1_WITH_RSA_ENCRYPTION SHA1_WITH_RSA_ENCRYPTION2 SHA256_WITH_RSA_ENCRYPTION SHA384_WITH_RSA_ENCRYPTION SHA512_WITH_RSA_ENCRYPTION ID_DSA_WITH_SHA1 dsaWithSHA1 EC_DSA_WITH_SHA1 EC_DSA_WITH_SHA224 EC_DSA_WITH_SHA256 EC_DSA_WITH_SHA384 EC_DSA_WITH_SHA512 UNKNOWN SHA1_WITH_RSAandMGF1 GOST_R3411_94_WITH_GOST_R3410_2001 GOST_R3411_94_WITH_GOST_R3410_94

signatureHashAlgorithm

string

A certificate signature hash algorithm

MD5 SHA1 MD2 SHA224 SHA256 SHA384 SHA512 UNKNOWN GOSTR3411_94

statusModificationDate

date-time

The date a certificate's status was modified

statusModificationUserId

uuid

UUID of the user that modified the certificate installation

subjectAlternativeNameDns

array of strings

A collection of certificate subject alternative names DNs

subjectAlternativeNameDns

subjectAlternativeNameNonDns

array of strings

A collection of certificate subject alternative name none DNs

subjectAlternativeNameNonDns

subjectAlternativeNamesByType

object

A certificate subject alternative name by type

subjectC

string

A certificate subject Country

subjectCN

array of strings

A collection of certificate subject CNs

subjectCN

subjectDN

string

A certificate subject DN

subjectKeyIdentifierHash

string

A subject key identifier hash

subjectL

string

A certificate subject Locality

subjectO

string

A certificate subject Organization

subjectOU

array of strings

A collection of certificate subject Organization units

subjectOU

subjectST

string

A certificate subject State

Control Plane

for Machine Identities

Guides

Ecosystem Developer

Design Patterns

Retrieve all certificate data

200Certificate(s) response.

400Request conditions failed.

412Request conditions failed.