Venafi Certificate Inventory Monitoring API
The Certificate Inventory Monitoring API from Venafi — 3 operation(s) for certificate inventory monitoring.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/venafi-certificate-inventory-monitoring-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Certificate Manager - SaaS Certificate Inventory Monitoring…
version: '1.0'
servers:
- description: US Region
url: https://api.venafi.cloud
- description: EU Region
url: https://api.eu.venafi.cloud
- description: AU Region
url: https://api.au.venafi.cloud
- description: UK Region
url: https://api.uk.venafi.cloud
- description: SG Region
url: https://api.sg.venafi.cloud
- description: CA Region
url: https://api.ca.venafi.cloud
tags:
- name: Certificate Inventory Monitoring
paths:
/outagedetection/v1/inventorymonitoringconfig/{type}:
get:
description: Retrieves the details of the inventory monitoring configuration by configuration type
operationId: inventorymonitoringconfiguration_getByType
parameters:
- description: Configuration type
in: path
name: type
required: true
schema:
description: Configuration type
enum:
- CERTIFICATE_EXPIRATION
type: string
responses:
'200':
content:
application/json:
examples:
Retrieves the details of the inventory monitoring configuration.:
description: Retrieves the details of the inventory monitoring configuration.
summary: Retrieves the details of the inventory monitoring configuration.
value:
inventoryMonitoringConfiguration:
applicationIds: []
enabled: true
includeUnassignedCertificates: true
inventoryMonitoringConfigurationType: CERTIFICATE_EXPIRATION
thresholds:
- 7
- 14
- 30
schema:
$ref: '#/components/schemas/InventoryMonitoringConfigurationResponse'
description: Details of inventory monitoring configuration in response body.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Inventory monitoring configuration not found.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
security:
- tppl-api-key: []
summary: Get the details of the current inventory monitoring configuration
tags:
- Certificate Inventory Monitoring
put:
operationId: inventorymonitoringconfiguration_update
parameters:
- description: Configuration type
in: path
name: type
required: true
schema:
description: Type of the configuration
enum:
- CERTIFICATE_EXPIRATION
type: string
requestBody:
content:
application/json:
examples:
An example for disabling the configuration.:
description: An example for disabling the configuration.
value:
inventoryMonitoringConfiguration:
applicationIds: []
enabled: false
includeUnassignedCertificates: true
inventoryMonitoringConfigurationType: CERTIFICATE_EXPIRATION
thresholds: []
An example for enabling the configuration.:
description: An example for enabling the configuration.
value:
inventoryMonitoringConfiguration:
applicationIds: []
enabled: true
includeUnassignedCertificates: true
inventoryMonitoringConfigurationType: CERTIFICATE_EXPIRATION
thresholds:
- 7
- 14
- 30
schema:
$ref: '#/components/schemas/InventoryMonitoringConfigRequest'
description: Updates properties of the inventory monitoring configuration.
required: true
responses:
'200':
content:
application/json:
examples:
Updates properties of the inventory monitoring configuration.:
description: Updates properties of the inventory monitoring configuration.
summary: Updates properties of the inventory monitoring configuration.
value:
inventoryMonitoringConfiguration:
applicationIds: []
enabled: true
includeUnassignedCertificates: true
inventoryMonitoringConfigurationType: CERTIFICATE_EXPIRATION
thresholds:
- 7
- 14
- 30
schema:
$ref: '#/components/schemas/InventoryMonitoringConfigurationResponse'
description: Inventory monitoring configuration was updated.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
security:
- tppl-api-key: []
summary: Updates existing inventory monitoring configuration
tags:
- Certificate Inventory Monitoring
/outagedetection/v1/inventorymonitoringconfig/{type}/scheduler:
put:
operationId: inventorymonitoringconfigurationscheduler_update
parameters:
- description: Configuration type
in: path
name: type
required: true
schema:
description: Configuration type
enum:
- CERTIFICATE_EXPIRATION
type: string
- description: Start the scheduler now
in: query
name: runNow
schema:
default: true
description: Start the scheduler now
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryMonitoringSchedulerInformation'
description: Inventory monitoring scheduler was updated.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
security:
- tppl-api-key: []
summary: Update inventory monitoring scheduler by type
tags:
- Certificate Inventory Monitoring
/v1/expirationnotifications/tenantconfiguration:
get:
description: Retrieve the certificate expiration notification configuration for the current tenant
operationId: get-v1-tenant-expiration-notification-configuration
responses:
'200':
content:
application/json:
examples:
simple:
$ref: '#/components/examples/TenantExpirationNotificationConfigurationExample'
schema:
$ref: '#/components/schemas/TenantExpirationNotificationConfiguration'
description: Success
'400':
description: BadRequest
'401':
description: Unauthorized
'500':
description: InternalServerError
security:
- tppl-api-key: []
summary: Retrieve the certificate expiration notification configuration
tags:
- Certificate Inventory Monitoring
x-rbac:
cm-only: true
permissions:
access_type: read
description: Ability to get the certificate expiration notification configuration
name: ngts.expiration_notification_tenant_configuration.get
roles:
- PKIAdmin
put:
description: Update the certificate expiration notification configuration for the current tenant
operationId: put-v1-tenant-expiration-notification-configuration
requestBody:
content:
application/json:
examples:
simple:
$ref: '#/components/examples/TenantExpirationNotificationConfigurationExample'
schema:
$ref: '#/components/schemas/TenantExpirationNotificationConfiguration'
description: The options to apply
required: true
responses:
'200':
content:
application/json:
examples:
simple:
$ref: '#/components/examples/TenantExpirationNotificationConfigurationExample'
schema:
$ref: '#/components/schemas/TenantExpirationNotificationConfiguration'
description: Success. The tenant configuration was successfully updated.
'400':
description: BadRequest
'401':
description: Unauthorized
'500':
description: InternalServerError
security:
- tppl-api-key: []
summary: Update the certificate expiration notification configuration
tags:
- Certificate Inventory Monitoring
x-rbac:
cm-only: true
permissions:
access_type: write
description: Ability to update the certificate expiration notification configuration
name: ngts.expiration_notification_tenant_configuration.update
roles:
- PKIAdmin
components:
schemas:
Channel:
enum:
- email
type: string
InventoryMonitoringConfiguration:
discriminator:
propertyName: inventoryMonitoringConfigurationType
properties:
inventoryMonitoringConfigurationType:
type: string
required:
- inventoryMonitoringConfigurationType
type: object
CertificateExpirationInventoryMonitoringConfig:
allOf:
- $ref: '#/components/schemas/InventoryMonitoringConfig'
- properties:
applicationIds:
description: Application IDs that the webhook applies to
items:
description: Application IDs that the webhook applies to
format: uuid
type: string
type: array
uniqueItems: true
enabled:
description: Enables or disables webhook messages.
type: boolean
includeUnassignedCertificates:
description: Enables or disables notifications for unassigned certificates.
type: boolean
thresholds:
description: Array of certificate expiration thresholds, in days, for when notifications will be sent. Limit is 3 values.
items:
description: Array of certificate expiration thresholds, in days, for when notifications will be sent. Limit is 3 values.
format: int32
type: integer
type: array
type: object
type: object
Persona:
enum:
- Application Owners
- All PKI Admins
- All Admins
type: string
ErrorInformation3:
properties:
args:
items:
$ref: '#/components/schemas/AnyValue3'
type: array
code:
format: int32
type: integer
message:
type: string
type: object
InventoryMonitoringConfig:
discriminator:
mapping:
CERTIFICATE_EXPIRATION: '#/components/schemas/CertificateExpirationInventoryMonitoringConfig'
propertyName: inventoryMonitoringConfigurationType
properties:
inventoryMonitoringConfigurationType:
type: string
type: object
ErrorResponse4:
properties:
errors:
items:
$ref: '#/components/schemas/ErrorInformation3'
type: array
type: object
InventoryMonitoringConfigRequest:
properties:
inventoryMonitoringConfiguration:
oneOf:
- $ref: '#/components/schemas/CertificateExpirationInventoryMonitoringConfig'
type: object
type: object
TenantExpirationNotificationConfiguration:
properties:
additionalRecipients:
description: A list of users and/or teams who should be added as recipients.
example:
- id: 22153ae0-4352-11ee-b95c-3531a284802b
type: User
- id: 22153ae0-4352-11ee-b95c-12345abcd123
type: Team
items:
$ref: '#/components/schemas/Recipient'
type: array
uniqueItems: true
channels:
description: A list of channels that should be used to deliver the notification.
example:
- email
items:
$ref: '#/components/schemas/Channel'
minItems: 1
type: array
uniqueItems: true
enabled:
description: If true, then the system will send notification for certificates which are nearing expiration.
example: true
type: boolean
fallbackToPKIAdmin:
description: If true, then all users with the PKI admin role will be added as recipients if the persona list does not include any recipients for a specific certificate.
example: true
type: boolean
includeCertificateDetails:
description: If true, then the notification may include potentially sensitive details about the certificate that is nearing expiration.
example: true
type: boolean
personas:
description: A list of personas who should be recipients of the notification. If "Application Owners" is included then the owners of the Application object to which the certificate is assigned will be added as recipients. If "All PKI Admins" or "All Admins" are present then all users in the system with that role will be added as recipients.
example:
- Application Owners
- All PKI Admins
items:
$ref: '#/components/schemas/Persona'
type: array
uniqueItems: true
type: object
Recipient:
properties:
id:
description: The ID of a user or team who should be included as a recipient.
format: UUID
type: string
type:
description: The type of the recipient.
enum:
- User
- Team
type: string
required:
- type
- id
type: object
InventoryMonitoringSchedulerInformation:
properties:
name:
description: Name of the configuration
type: string
status:
description: Status of the configuration
enum:
- PENDING
- RUNNING
- DONE
- FAILED
type: string
type: object
AnyValue3:
description: Can be any value - string, number, boolean, array or object.
InventoryMonitoringConfigurationResponse:
properties:
companyId:
description: UUID specific to your company
example: 2b391680-74ce-11ed-bf7a-a3d5ccdf275c
format: uuid
type: string
configuration:
$ref: '#/components/schemas/InventoryMonitoringConfiguration'
id:
description: UUID of the configuration
example: 2e8d71a0-74ce-11ed-9051-cfa579eae364
format: uuid
type: string
type: object
examples:
TenantExpirationNotificationConfigurationExample:
value:
additionalRecipients:
- id: 22153ae0-4352-11ee-b95c-3531a284802b
type: User
- id: 22153ae0-4352-11ee-b95c-12345abcd123
type: Team
channels:
- email
enabled: true
fallbackToPKIAdmin: false
personas:
- Application Owners
- All PKI Admins
securitySchemes:
service-account:
in: header
name: service-account
type: apiKey
tppl-api-key:
in: header
name: tppl-api-key
type: apiKey
x-readme:
samples-languages:
- curl
- go
- java
- javascript
- node
- python