POST X509CertificateStore/LookupExpiring

Returns certificate vault IDs of any expiring certificates for a specified owner.

Requirements

  • Permissions:  The caller must have Read permission to the requested Owner object.
  • Token scope:  Restricted

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Input parameters

Name

Description

DaysToExpiration

Integer representing the maximum number of days before certificate expiration.

OwnerDN

Also known as the Owner object. The Distinguished Name (DN) of any object that owns a certificate vault entry. For example, Certificate objects or Discovery objects.

Returns

Response description

Name

Description

VaultIds

The list of vault IDs for certificates expiring within the specified number of days.

Result

A number indicating indicating success 0 or failure. Because this API is a wrapper for SecretStore, see SecretStore result codes.

Example

Request for Example

POST https://tpp.venafi.example/vedsdk/X509CertificateStore/LookupExpiring
Authorization:Bearer 4MyGeneratedBearerTknz==
{  
   "DaysToExpiration":1500,
   "OwnerDN":"\\VED\\Policy\\folder\\TestCert"
}

Response for Example

HTTP/1.1 200 OK
{  
   "Result":0,
   "VaultIds":[  
      503,
      488,
      487
   ]
}