How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Venafi

Certificate Manager - SaaS API (Venafi Control Plane)

The Venafi / CyberArk Certificate Manager - SaaS REST API. 184 operations across 120 paths covering certificate inventory and search, certificate requests and issuing templates, applications, machines and machine identities, credential managers, teams and users, service accounts and scopes, tags, event logs, VSatellites (edge instances/workers), webhook connectors, expiration/auto-renewal monitoring, approval rules, plugins and Workload Identity Manager (distributed issuers). Served from six regional hosts under venafi.cloud.

Documentation Provider Profile APIs.io OpenAPI GitHub

Certificate Manager - SaaS API (Venafi Control Plane) is one of 2 APIs that Venafi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Certificates, PKI, Machine Identity, Certificate Lifecycle Management, and Security. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 184 operations across 120 paths, organized into 30 resource areas, and defines 453 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 6 base URLs: https://api.venafi.cloud, https://api.eu.venafi.cloud, https://api.au.venafi.cloud, https://api.uk.venafi.cloud, https://api.sg.venafi.cloud, https://api.ca.venafi.cloud.

184 operations 120 paths 453 schemas 23 DELETE69 GET12 PATCH60 POST20 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.venafi.cloud
Authentication
API Key, API Key
Resource Areas
30

Authentication & Security 2

Certificate Manager - SaaS API (Venafi Control Plane) declares 2 security schemes for authenticating requests. An API key is passed in the header as service-account (service-account). An API key is passed in the header as tppl-api-key (tppl-api-key).

Paths & Operations 184

Across 120 paths, the API surfaces 184 operations — 23 DELETE, 69 GET, 12 PATCH, 60 POST, 20 PUT. They span 30 resource areas, including Certificates, Certificate Import, Certificate Installations, Certificate Discovery, Private Key Import, Certificate Request, Certificate Policy, Application, and 22 more. Each is listed below with its method, path, parameters, and response codes.

Certificates 8
GET
/outagedetection/v1/certificates
Retrieve all certificate data
certificates_getAll 4 params → 200400412
GET
/outagedetection/v1/certificates/{id}
Get a certificate's details
certificates_getById 3 params → 200400404412
GET
/outagedetection/v1/certificates/{id}/contents
Download a certificate
certificates_getContentsById 4 params → 200400404412
POST
/outagedetection/v1/certificates/validation
Request validation for a set of certificates
certificates_validation body → 202400412
POST
/outagedetection/v1/certificates/retirement
Retire certificates
certificateretirement_retireCertificates body → 200400412
POST
/outagedetection/v1/certificates/recovery
Recover a set of certificates
certificateretirement_recoverCertificates body → 200400412
POST
/outagedetection/v1/certificates/deletion
Delete a set of retired certificates
certificateretirement_deleteCertificates body → 204400412
POST
/outagedetection/v1/certificatesearch
Retrieve certificate data matching search criteria
certificates_search_getByExpression 2 params body → 200400412
Certificate Import 1
POST
/outagedetection/v1/certificates
Import a set of raw certificates
certificateimports_create body → 201400412
Certificate Installations 4
GET
/outagedetection/v1/certificateinstances
Retrieve Certificate Instances
certificateinstances_getAll 4 params → 200400412
GET
/outagedetection/v1/certificateinstances/{id}
Get a certificate installation's details
certificateinstances_getById 1 param → 200400404412
POST
/outagedetection/v1/certificateinstances/validation
Request validation for a set of certificate installations
certificateinstances_validation body → 202400412
POST
/outagedetection/v1/certificateinstancesearch
Retrieve certificate instance data matching search criteria
certificateinstances_search_getByExpression body → 200400412
Certificate Discovery 5
GET
/v1/integrationservices
Get a list of services
integrationsservices_getAll 2 params → 200400412
POST
/v1/integrationservices
Add a service
integrationsservices_create body → 201400
GET
/v1/integrationservices/{id}
Get service details
integrationsservices_getById 1 param → 200400404412
DELETE
/v1/integrationservices/{id}
Remove a service
integrationsservices_delete 2 params → 204400404412
PATCH
/v1/integrationservices/{id}
Update Service properties
integrationsservices_update 1 param body → 200400404412
Private Key Import 2
POST
/v1/certificates/imports
Import a list of certificates and their associated private key pairs
certificates_import body → 201400412
GET
/v1/certificates/imports/{id}
Retrieve import details
certificatesImport_getByImportId 1 param → 200400404412
Certificate Request 6
GET
/outagedetection/v1/certificaterequests
Get the details of all certificate requests
certificaterequests_getAll → 200400412
POST
/outagedetection/v1/certificaterequests
Create a certificate request
certificaterequests_create body → 201400412
GET
/outagedetection/v1/certificaterequests/{id}
Get a certificate request's details
certificaterequests_getById 1 param → 200400404412
POST
/outagedetection/v1/certificaterequests/{id}/resubmission
Resubmit a certificate request
certificaterequests_resubmitById 1 param body → 200400404412
POST
/outagedetection/v1/certificaterequests/validation
Validate a certificate request
certificaterequests_validation body → 201400412
POST
/outagedetection/v1/certificaterequestssearch
Get the details of certificate requests matching custom search criteria
getCertificateRequestsByExpression body → 200400412
Certificate Policy 6
GET
/v1/certificateissuingtemplates
Get the details of issuing templates matching simple criteria
certificateissuingtemplate_getAll 1 param → 200400412
POST
/v1/certificateissuingtemplates
Add an issuing template
certificateissuingtemplate_create body → 201400404409412
GET
/v1/certificateissuingtemplates/{id}
Get an issuing template's details
certificateissuingtemplate_getById 1 param → 200400404412
PUT
/v1/certificateissuingtemplates/{id}
Overwrite an issuing template's details
certificateissuingtemplate_update 1 param body → 200202400404412
DELETE
/v1/certificateissuingtemplates/{id}
Remove an issuing template
certificateissuingtemplate_delete 1 param → 204400404412
POST
/v1/certificateissuingtemplates/domainssynchronization
Synchronize issuing templates domains with CA
domainssynchronization body → 200
Application 10
GET
/outagedetection/v1/applications
Get the details of applications
applications_getAll 4 params → 200400412
POST
/outagedetection/v1/applications
Add an application
applications_create body → 201400409412
GET
/outagedetection/v1/applications/{id}
Get an application's details
applications_getById 2 params → 200400404412
PUT
/outagedetection/v1/applications/{id}
Update an application's details
applications_update 1 param body → 200400404412
DELETE
/outagedetection/v1/applications/{id}
Remove an application
applications_delete 1 param → 200400404412
POST
/outagedetection/v1/applications/{id}/invitations
Creates an invitation link for an application.
applications_invitations_create 1 param body → 201400412
GET
/outagedetection/v1/applications/{id}/scanaficonfiguration
Get the Basic Discovery configuration for an application
applications_getScanafiConfigById 1 param → 200400404412
GET
/outagedetection/v1/applications/{name}/certificateissuingtemplates/{alias}
Get the details of an issuing template by its alias
certificateissuingtemplates_getByAlias 2 params → 200400404412
PATCH
/outagedetection/v1/applications/certificates
Manage application assignments for a set of certificates
applications_assignToCertificates body → 200400412
GET
/outagedetection/v1/applications/name/{name}
Get an application's details by its name
applications_getByName 2 params → 200400404412
Credential Management 14
GET
/v1/credentialmanagerconfigurations
Retrieves a set of Credential Manager Service configurations
get-public-cms-conf 1 param → 200400401403404500
POST
/v1/credentialmanagerconfigurations
Add a set of Credential Manager Service configurations
post-public-cms-conf body → 201400401403404500
PUT
/v1/credentialmanagerconfigurations
Update a Credential Manager Service configuration
put-public-cms-conf body → 200400401403404500
GET
/v1/credentialmanagerconfigurations/{id}
Retrieves a Credential Manager Service configuration by ID
get-public-cms-conf-id 1 param → 200400401403404500
DELETE
/v1/credentialmanagerconfigurations/{id}
Delete a Credential Manager Service configuration by ID
delete-public-cms-conf-id 1 param → 204400401403404500
POST
/v1/credentialmanagerconfigurations/test
Test the connection to a privileged access management
post-public-cms-conf-test body → 200400401403404500
POST
/v1/credentialmanagerconfigurations/{id}/test
Test the connection to an external Privilege Access Management by ID
post-public-cms-conf-test-id 1 param → 200400401403404500
GET
/v1/credentials
Retrieves credentials for a company
get-public-cms-credential 5 params → 200400401403422500
POST
/v1/credentials
Add a set of new shared credentials
post-public-cms-credential body → 201400401403422500
PUT
/v1/credentials
Update a shared credential
put-public-cms-credential body → 200400401403422500
DELETE
/v1/credentials
Delete shared credentials
delete-public-cms-credential 1 param → 200400401403422500
GET
/v1/credentials/{id}
Retrieves shared credential by ID
get-public-cms-credential-id 2 params → 200400401403422500
DELETE
/v1/credentials/{id}
Delete shared credential by ID
delete-public-cms-credential-id 1 param → 204400401403422500
POST
/v1/credentials/test
Test the access to shared credential by ID
post-public-cms-credential-test-id body → 200400401403404500
Machine Identities 7
GET
/v1/machineidentities
Get the details of all machine identities
machineidentities_getAll → 200400412
POST
/v1/machineidentities
Add a machine identity to a machine
machineidentities_create body → 201400
GET
/v1/machineidentities/{id}
Get a machine identity's details
machineidentities_getById 1 param → 200400404412
DELETE
/v1/machineidentities/{id}
Remove a machine identity
machineidentities_delete 1 param → 204400404412
PATCH
/v1/machineidentities/{id}
Update a machine identity's details
machineidentities_update 1 param body → 200400404412
POST
/v1/machineidentities/{id}/workflows
Initiate a machine workflow
machineidentities_initiateWorkflow 1 param body → 201400404412
POST
/v1/machineidentitysearch
Get the details of machine identities matching search criteria.
getMachineIdentitiesByExpression body → 200400412
Machine Types 1
GET
/v1/machinetypesdeprecated
Deprecated. This functionality is no longer supported. Use the Plugins API set instead.
machineTypes_getAll → default
Machines 11
GET
/v1/machines
Get the details of all machines
machines_getAll → 200400412
POST
/v1/machines
Add a machine
machines_create body → 201400
GET
/v1/machines/{id}
Get a machine's details
machines_getById 1 param → 200400404412
DELETE
/v1/machines/{id}
Delete a machine
machines_delete 1 param → 204400404412
PATCH
/v1/machines/{id}
Update a machine's details
machines_update 1 param body → 200400404412
POST
/v1/machines/{id}/workflows
Initiate the workflow
machines_initiateWorkflow 1 param body → 201400
POST
/v1/machines/workflows
Initiate workflow (currently supported test connection only)
machines_initiateTestConnectionWorkflow body → 201400
POST
/v1/machinesearch
Get the details of machines matching search criteria
getMachinesByExpression 1 param body → 200400412
POST
/v1/machines/{id}/batchprovisionings/abort
Abort active batch provisioning for a machine by ID
abort-v1-batchprovisionings-forMachineId 1 param → 202403404405500
GET
/v1/machines/{id}/discovery
Get the discovery results for a machine by its ID
machineDiscoveryResults_getByMachineId 1 param → 200400404412
POST
/v1/machines/{id}/discovery/abort
Abort machine discovery
machineDiscoveryResults_abortdiscovery 1 param → 202403404405
Users 7
GET
/v1/users
Retrieve users matching specified criteria
get-v1-users 4 params → 200
GET
/v1/users/{id}
Retrieve user details by user ID
get-v1-users-byId 1 param → 200400404412
PUT
/v1/users/{id}/accounttype
Update user account type.
put-v1-users-byId-accounttype 1 param body → 200400404412
PUT
/v1/users/{id}/locallogin
Enable/disable local login for user
put-v1-users-byId-locallogin 1 param body → 200400404412
PUT
/v1/users/{id}/roles
Update user roles.
put-v1-users-byId-roles 1 param body → 200400404412
GET
/v1/users/username/{username}
Retrieve user details by username
get-v1-users-username-byUsername 1 param → 200400404412
PUT
/v1/users/{id}/passwordexpiration
Update if a user must change their password at next login
put-v1-users-byId-passwordexpiration 1 param body → 200400404412
User Accounts 1
GET
/v1/useraccounts
Retrieve an authenticated user's account details
useraccounts_getByAuth → 200400404412
Teams 9
GET
/v1/teams
Retrieve teams for the current company
teams_getAll → 200400412
POST
/v1/teams
Add a team
teams_create body → 201400412
GET
/v1/teams/{id}
Get a team's details
teams_getById 1 param → 200400412
DELETE
/v1/teams/{id}
delete a team
teams_delete 1 param → 204400412
PATCH
/v1/teams/{id}
Update team's details
teams_update 1 param body → 200400412
POST
/v1/teams/{id}/members
Add team members
teams_members_add 1 param body → 200400412
DELETE
/v1/teams/{id}/members
Remove team members
teams_members_delete 1 param body → 200400412
POST
/v1/teams/{id}/owners
Add team owners
teams_members_owners_add 1 param body → 200400412
DELETE
/v1/teams/{id}/owners
Remove team owners
teams_members_owners_remove 1 param body → 200400412
Event Logs 3
POST
/v1/activitylogsearch
Retrieve count and activity log entries matching search criteria
activitylogs_getByExpression body → 200400412
POST
/v1/activitylogsearch/export
Export filtered event log data to JSON or CSV formats
activitylogs_getAllByExpression body → 200400412
GET
/v1/activitytypes
Retrieve types of activities used for event logging
activitylogtypes_get → 200400412
VSatellite 14
POST
/v1/edgeinstances/{id}/update
Trigger manual update of Satellite Instance
create-edgeinstances-update 1 param → 202400404412
GET
/v1/edgeencryptionkeys
Retrieve Satellite Encryption Keys
edgeencryptionkeys_getAll 1 param → 200
GET
/v1/edgeencryptionkeys/{id}
Retrieve SatelliteEncryption Key By Id
edgeencryptionkeys_getById 1 param → 200400404412
GET
/v1/edgeinstances
Retrieve Satellite Instances
edgeinstances_getAll 1 param → 200
GET
/v1/edgeinstances/{id}
Retrieve Satellite Instance By Id
edgeinstances_getById 2 params → 200400404412
PUT
/v1/edgeinstances/{id}
Update Satellite Instance
edgeinstances_update 1 param body → 200400404412
POST
/v1/pairingcodes/satellite
Create Pairing Code for Satellite Instance
pairingcodes_create body → 201400
POST
/v1/recoverycodes/satellite
Create Recovery Code for Satellite Instance
recoverycodes_create body → 201400
GET
/v1/edgeworkers
Retrieve Satellite Workers
edgeworkers_getAll 1 param → 200
POST
/v1/edgeworkers
Create Satellite Worker
edgeworkers_create body → 201400412
POST
/v1/edgeworkers/{id}/pair
Pair Satellite Worker with Satellite Instance
edgeworkers_pair 1 param body → 200400412
DELETE
/v1/edgeworkers/{id}
Delete Satellite Worker
edgeworker_delete 1 param → 204400404412
GET
/v1/updatesconfig
Retrieve Updates configuration
updatesconfig_get → 200
PATCH
/v1/updatesconfig
Create or Update Configuration
updatesconfig_patch body → 200
Webhooks 4
PUT
/v1/connectors/{id}
Update Connector properties
connectors_update 1 param body → 200400404412
DELETE
/v1/connectors/{id}
Delete a Connector
connectors_delete 1 param → 204400404412
GET
/v1/connectors
Retrieve all Connectors for a company
connectors_getAll → 200400412
POST
/v1/connectors
Create a Connector
connectors_create body → 201400
Certificate Inventory Monitoring 5
GET
/outagedetection/v1/inventorymonitoringconfig/{type}
Get the details of the current inventory monitoring configuration
inventorymonitoringconfiguration_getByType 1 param → 200400404412
PUT
/outagedetection/v1/inventorymonitoringconfig/{type}
Updates existing inventory monitoring configuration
inventorymonitoringconfiguration_update 1 param body → 200400412
PUT
/outagedetection/v1/inventorymonitoringconfig/{type}/scheduler
Update inventory monitoring scheduler by type
inventorymonitoringconfigurationscheduler_update 2 params → 200400412
GET
/v1/expirationnotifications/tenantconfiguration
Retrieve the certificate expiration notification configuration
get-v1-tenant-expiration-notification-configuration → 200400401500
PUT
/v1/expirationnotifications/tenantconfiguration
Update the certificate expiration notification configuration
put-v1-tenant-expiration-notification-configuration body → 200400401500
Certificate Auto-renewal Monitoring 6
GET
/v1/autorenewal/tenantconfiguration
Retrieve the monitoring configuration
get-v1-tenant-renewal-configuration → 200400401500
PUT
/v1/autorenewal/tenantconfiguration
Update the monitoring configuration
put-v1-tenant-renewal-configuration body → 200400401500
POST
/v1/autorenewal/trigger
Attempt to initiate the certificate renewal check process now.
post-v1-run-autorenewal → 200
GET
/v1/autorenewal/status
Get the current certificate auto-renewal monitoring status
get-v1-status → 200401500
GET
/v1/autorenewal/{application_id}/configuration
Retrieve the monitoring configuration
get-v1-application-renewal-configuration 1 param → 200401500
PUT
/v1/autorenewal/{application_id}/configuration
Update the monitoring configuration
put-v1-application-renewal-configuration 1 param body → 200400401500
Certificate Expiration Reports 3
GET
/v1/expirationreports/tenantconfiguration
Retrieve the certificate expiration reports configuration
get-v1-tenant-expiration-reports-configuration → 200400401500
PUT
/v1/expirationreports/tenantconfiguration
Update the certificate expiration reports configuration
put-v1-tenant-expiration-reports-configuration body → 200400401500
POST
/v1/expirationreports/trigger
Attempt to initiate the certificate reports process.
post-v1-run-reports → 204
Tags 12
GET
/v1/tags
Retrieve all tags
tags_getAll → 200400412
POST
/v1/tags
Create a tag
tags_create body → 201400412
GET
/v1/tags/{name}
Retrieve tag by name
tags_getByName 1 param → 200400404412
DELETE
/v1/tags/{name}
Delete tag by name
tags_deleteByName 1 param → 202404412
GET
/v1/tags/{name}/values
Retrieve values for a tag
tags_get_values 1 param → 200400404412
POST
/v1/tags/{name}/values
Create tag values
tag_values_create 1 param body → 201400412
DELETE
/v1/tags/{name}/values/{value}
Delete a tag value
tags_deleteValueByName 2 params → 202404412
GET
/v1/tags/values
Retrieve values for all tags
tags_getAllValues → 200400412
POST
/v1/tags/creation
Create tags in bulk
tags_bulk_create body → 201400412
POST
/v1/tags/deletion
Delete tags in bulk
tags_bulk_delete body → 202404412
PATCH
/v1/tagsassignment
Replace, add, or delete tags or values
tags_assignToEntities body → 200400412
POST
/v1/tagsassignment/aggregates
Bulk operation to retrieve number of entities per tag
tags_assignmentAggregates body → 200400412
Workload Identity Manager Configurations 5
POST
/v1/distributedissuers/configurationsdeprecated
Create a new Issuer configuration
configurations_create body → 201400404
GET
/v1/distributedissuers/configurations
Get the details of all Issuer configurations
configurations_getAll → 200
GET
/v1/distributedissuers/configurations/{id}
Get configurations details for a specific Issuer configuration
configurations_getById 1 param → 200400404
PATCH
/v1/distributedissuers/configurations/{id}deprecated
Update an Issuer configuration's details
configurations_update 1 param body → 200400404
DELETE
/v1/distributedissuers/configurations/{id}
Remove an Issuer configuration
configurations_delete 1 param → 200400404
Workload Identity Manager Sub CA Providers 5
POST
/v1/distributedissuers/subcaproviders
Create a new Sub CA provider
subcaproviders_create body → 201400403404
GET
/v1/distributedissuers/subcaproviders
Get the details of all Sub CA providers
subcaproviders_getAll → 200
GET
/v1/distributedissuers/subcaproviders/{id}
Get a Sub CA provider's details
subcaproviders_getById 1 param → 200400404
PATCH
/v1/distributedissuers/subcaproviders/{id}
Update a Sub CA provider's details
subcaproviders_update 1 param body → 200400403404
DELETE
/v1/distributedissuers/subcaproviders/{id}
Remove a Sub CA provider
subcaproviders_delete 1 param → 200400403404
Workload Identity Manager Policies 5
POST
/v1/distributedissuers/policies
Create a new Workload Issuance policy
policies_create body → 201400403
GET
/v1/distributedissuers/policies
Get the details of all Workload Issuance policies
policies_getAll → 200
GET
/v1/distributedissuers/policies/{id}
Get a Workload Issuance policy's details
policies_getById 1 param → 200400404
PATCH
/v1/distributedissuers/policies/{id}
Update a Workload Issuance policy's details
policies_update 1 param body → 200400403404
DELETE
/v1/distributedissuers/policies/{id}
Remove a Workload Issuance policy
policies_delete 1 param → 200400403404
Workload Identity Manager Intermediate Certificates 1
GET
/v1/distributedissuers/intermediatecertificates
Get the details of all Issuer intermediate certificates
intermediatecertificates_getAll → 200
Certificate Approvals 8
POST
/v1/certificaterequests/{id}/approval/{decision}
Approve or reject pending certificate request
certificaterequests_approve 3 params body → 200400404412
POST
/v1/certificaterequests/approval/bulk/{decision}
Approve or reject multiple pending approval certificate requests
certificaterequests_bulk_approve 1 param body → 201400412
POST
/v1/certificaterequests/approvalrules
Create an approval rule for certificate requests
certificaterequests_approval_rule_create body → 201400412
GET
/v1/certificaterequests/approvalrules
Get all approval rules
certificaterequests_approval_rules_getAll → 200400412
GET
/v1/certificaterequests/approvalrules/{id}
Retrieve approval rule by id
certificaterequests_approval_rule_getById 1 param → 200400404412
PUT
/v1/certificaterequests/approvalrules/{id}
Update certificate request workflow approval rule
certificaterequests_approval_rule_update 1 param body → 200400404412
DELETE
/v1/certificaterequests/approvalrules/{id}
Delete certificate request workflow approval rule
certificaterequests_approval_rule_delete 1 param → 200400404412
GET
/v1/certificaterequests/approvalrequests/{entityId}
Retrieve approval request for specific certificate request
certificaterequests_approvalrequest 1 param → 200400404412
Certificate Revocation Approvals 5
POST
/v1/certificates/revocations/approvalrules
Create an approval rule for certificate revocation
certificaterevocations_approval_rule_create body → 201400412
GET
/v1/certificates/revocations/approvalrules
Get all certificate revocation approval rules
certificaterevocations_approval_rules_getAll → 200400412
GET
/v1/certificates/revocations/approvalrules/{id}
Retrieve certificate revocation approval rule by id
certificaterevocations_approval_rule_getById 1 param → 200400404412
PUT
/v1/certificates/revocations/approvalrules/{id}
Update certificate revocation workflow approval rule
certificaterevocations_approval_rule_update 1 param body → 200400404412
DELETE
/v1/certificates/revocations/approvalrules/{id}
Delete certificate revocation workflow approval rule
certificaterevocations_approval_rule_delete 1 param → 200400404412
Plugins 8
GET
/v1/plugins
Retrieve all plugins
get-v1-plugins 2 params → 200
POST
/v1/plugins
Create a local plugin
post-v1-plugins body → 201
GET
/v1/plugins/{id}
Retrieve plugin by ID
get-v1-plugins-id 1 param → 200
PATCH
/v1/plugins/{id}
Update a local plugin
patch-v1-plugins-id 1 param body → 200401403
DELETE
/v1/plugins/{id}
Delete a local plugin
delete-v1-plugins-id 1 param → 204
POST
/v1/plugins/{id}/disablements
Disable a plugin
post-v1-plugins-id-exclusions 1 param → 201
DELETE
/v1/plugins/{id}/disablements
Remove plugin disablement
delete-v1-plugins-id-exclusions 1 param → 204
GET
/v1/plugins/disablements
Retrieve all disabled plugins
get-v1-plugins-exclusions → 200
Service Accounts 8
GET
/v1/serviceaccounts
Retrieves all the Service Accounts the user has access to
get-v1-serviceaccounts → 200400401500
POST
/v1/serviceaccounts
Creates a Service Account
create-v1-serviceaccounts body → 200400401500
GET
/v1/serviceaccounts/{id}
Gets a Service Account
get-v1-serviceaccounts-byId 1 param → 200400401500
PATCH
/v1/serviceaccounts/{id}
Updates a Service Account
patch-v1-serviceaccounts-byId 1 param body → 204400401500
DELETE
/v1/serviceaccounts/{id}
Deletes a Service Account
delete-v1-serviceaccounts-byId 1 param → 204400401500
GET
/v1/serviceaccounts/scopes
Retrieves all the Service Accounts Scopes available for the user
get-v1-serviceaccountscopes → 200400401500
PUT
/v1/serviceaccounts/{id}/ocitoken
Regenerate the OCI registry token for a Service Account with registry scope
put-v1-serviceaccounts-byId-ocitoken 1 param → 200400401500
PUT
/v1/serviceaccounts/{id}/credentials
Updates a Service Account credentials
put-v1-serviceaccounts-byId-credentials 1 param body → 200400401500

Schemas 453

The contract defines 453 schemas that model the data the API accepts and returns. The most detailed are ExtendedCertificateInformation (59 properties), CertificateInformation (58 properties), CertificateIssuingTemplateInformation2 (42 properties), CertificateIssuingTemplateInformation1 (35 properties). Each schema is shown below with its type and property counts.

AWSCloudProvider
object
2 properties 2 required
ActivityLogCondition
object
A Condition for filtering
4 properties
ActivityLogEntriesResponse
object
2 properties
ActivityLogEntryInformation
object
9 properties
ActivityLogFilter
object
3 properties
ActivityLogFilterOperand
object
2 properties
ActivityLogFilterOperands
object
2 properties
ActivityLogFilterOperator
string
An operator for filtering
ActivityLogName
object
2 properties
ActivityLogOrder
object
2 properties
ActivityLogType
object
3 properties
AddCredentialRequest
object
The properties representing a credential to add.
6 properties 4 required
AddCredentialsRequest
object
Array of credentials to add.
1 property 1 required
AddCredentialsResponse
object
The response for the add credentials action.
2 properties 2 required
AdvancedSettings
object
3 properties
AnyValue1
Can be any value - string, number, boolean, array or object.
AnyValue2
Can be any value - string, number, boolean, array or object.
AnyValue3
Can be any value - string, number, boolean, array or object.
AnyValue4
Can be any value - string, number, boolean, array or object.
AnyValue5
Can be any value - string, number, boolean, array or object.
AnyValue6
Can be any value - string, number, boolean, array or object.
AnyValue7
Can be any value - string, number, boolean, array or object.
AnyValue8
Can be any value - string, number, boolean, array or object.
AnyValue9
Can be any value - string, number, boolean, array or object.
ApiClientInformation
object
Represents the information of the client that is calling the API
2 properties
ApiKeyInformation
object
13 properties
ApiKeyStatus
string
ApiVersion
string
Indicates version of the API.
AppId
string
The application ID from the CyberArk provider.
AppRoleAuthenticationData
object
2 properties
Application
string
Application ID to associate with the service account
ApplicationInformation
object
15 properties
ApplicationOwnership
object
2 properties
ApplicationRenewalConfiguration
object
2 properties 2 required
ApplicationRequest
object
13 properties 6 required
ApplicationResponse
object
3 properties
ApplicationsAssignRequest
object
3 properties 3 required
ApplicationsAssignResponse
object
1 property
ApprovalDecisionRequest
object
1 property
ApprovalRequestInformation
object
13 properties
ApproverOutcomeInformation
object
6 properties
ApproverProperty
object
2 properties
ApproverPropertyOpenApi
object
Approver with id that can be only user type
2 properties
AuthType
string
The type of the authentication: password usernamepassword
AzureCloudProvider
object
1 property 1 required
BaseActivityLogFilter
object
Root expression for filtering
BaseActivityLogOrdering
object
Specify the ordering of a search result
1 property
BaseFilter
object
Root expression for filtering
BaseOrdering
object
Specify the ordering of a search result
1 property
BulkApprovalRequest
object
3 properties 1 required
BulkApprovalResponse
object
1 property
CAType
string
Type of CA this Sub CA provider works with
CMSAuthenticationType
string
The authentication type for the privileged access management: certificate - For authentication with a Certificate bundle userPassword - For authentication with…
CMSConfId
string
The Credential Manager Service configuration ID.
CMSConfigurationResponse
object
The information representing a Credential Manager Service configuration for response.
12 properties
CMSType
string
The type of the privileged access management: cyberark - For CyberArk privileged access management hashicorp - For HashiCorp privileged access management
CMSURL
string
The baseUrl of the privileged access management provider.
CSRAttributesInformation
object
Represents CSR attributes for certificate requests. Required when isVaaSGenerated is set to true and reuseCSR to false.
8 properties
Capability
string
CapabilityInformation
object
4 properties 3 required
CertificateAuthorityProductInformation1
object
5 properties
CertificateAuthorityProductInformation2
object
Product specific for external certificate authority
6 properties 1 required
CertificateCredentialData
object
4 properties
CertificateDeletionRequest
object
1 property 1 required
CertificateExpirationInventoryMonitoringConfig
object
CertificateImportInfo
object
Base64 encoding certificate content.
5 properties 1 required
CertificateImportInformation
object
List of the certificates and private key pairs to import
5 properties 3 required
CertificateImportRequest1
object
3 properties 3 required
CertificateImportRequest2
object
2 properties 1 required
CertificateImportResponse1
object
2 properties
CertificateImportResponse2
object
2 properties
CertificateImportStatusDetail
object
Status detail information for each certificate and private key imported related to the import id
4 properties
CertificateImportStatusDetailResponse
object
3 properties
CertificateInformation
object
58 properties
CertificateInstanceInformation
object
17 properties
CertificateInstanceValidationRequest
object
1 property 1 required
CertificateIssuingTemplateInformation1
object
35 properties
CertificateIssuingTemplateInformation2
object
42 properties
CertificateIssuingTemplateRequest
object
32 properties 6 required
CertificateIssuingTemplateResponse
object
1 property
CertificateOwnership
object
1 property
CertificateRecoveryRequest
object
2 properties 1 required
CertificateRequestApprovalConditionsFilterRuleInformation
object
3 properties
CertificateRequestApprovalExceptionsFilterRuleInformation
object
2 properties
CertificateRequestApprovalRuleDeleteResponseOpenApi
object
2 properties
CertificateRequestApprovalRuleOpenApi
object
13 properties
CertificateRequestApprovalRulesRequest
object
10 properties 4 required
CertificateRequestApprovalRulesResponseOpenApi
object
1 property
CertificateRequestApprovalRulesUpdateRequest
object
11 properties 4 required
CertificateRequestDocumentInformation
object
24 properties
CertificateRequestDocumentResponse
object
2 properties
CertificateRequestInformation1
object
26 properties
CertificateRequestInformation2
object
24 properties
CertificateRequestRequest
object
13 properties 3 required
CertificateRequestResponse
object
1 property
CertificateRequestResubmissionRequest
object
4 properties
CertificateResponse
object
2 properties
CertificateRetirementRequest
object
2 properties 1 required
CertificateRevocationApprovalConditionsFilterRuleInformation
object
1 property 1 required
CertificateRevocationApprovalExceptionsFilterRuleInformation
object
2 properties
CertificateRevocationApprovalRuleDeleteResponseOpenApi
object
2 properties
CertificateRevocationApprovalRuleOpenApi
object
12 properties
CertificateRevocationApprovalRulesRequest
object
9 properties 4 required
CertificateRevocationApprovalRulesResponseOpenApi
object
1 property
CertificateRevocationApprovalRulesUpdateRequest
object
10 properties 4 required
CertificateUsageMetadata
object
3 properties
CertificateValidationRequest
object
1 property 1 required
CertificateValidationResponse
object
1 property
CertificationRequestInformation
object
8 properties
Channel
string
ChartDetails
object
2 properties
ClientAuthentication
object
1 property 1 required
ClientAuthorization
object
1 property
CloudProviders
object
3 properties
CompanyId
string
The company ID
CompanyInformation
object
10 properties 2 required
CompanyType
string
Condition
object
A Condition for filtering
4 properties
ConfigurationCreateRequest
ConfigurationDeleteResponse
object
2 properties
ConfigurationGetResponse
object
7 properties 1 required
ConfigurationListResponse
object
1 property
ConfigurationUpdateRequest
object
9 properties
ConnectorsCreationRequest
object
2 properties 2 required
ConnectorsInformation
object
4 properties 4 required
ConnectorsResponse
object
1 property 1 required
ConnectorsUpdateRequest
object
1 property 1 required
CreateCMSConfigurationRequest
object
The information representing a Credential Manager Service configuration for creation purpose.
6 properties 3 required
CreateCMSConfigurationsRequest
object
The array of Credential Manager Service configurations to create.
1 property 1 required
CreateCMSConfigurationsResponse
object
The array of Credential Manager Service configurations created.
2 properties 2 required
CreateCMSDetails
CreateCredentialDetails
CreateCyberArkCredDetails
CreateCyberArkDetails
CreateHashiCorpCredDetails
CreateHashiCorpDetails
CreateServiceAccountRequestBody
CreateServiceAccountResponseBody
object
5 properties
CreateTeamRequest
object
5 properties 3 required
CreatedBy
string
The ID of the user whom created the credential.
CreatedOn
string
The date in ISO 8601 full-date format when the credential was created.
CredentialId
string
The ID of the Credential in our System.
CredentialName
string
The name of the Credential in our System.
CredentialResponse
object
The properties representing a Credential for response purposes.
13 properties 5 required
CustomAttributes1
object
Certificate request custom attributes
2 properties
CustomAttributes2
object
A certificate request custom attributes
2 properties
CustomAttributesInformation
object
Represents custom attributes for certificate requests
2 properties 1 required
CustomClaimsAliases
object
3 properties
CyberArkConfiguration
The configuration for the CyberArk app. It's required to set the value for the cmsType property to cyberark.
CyberArkConfigurationRequiredProp
The configuration for the CyberArk app. It's required to set the value for the cmsType property to cyberark.
2 required
CyberArkDetails
object
The CyberArk Credential information.
3 properties
CyberArkDetailsRequiredProp
2 required
DailyPatternInformation
object
2 required
DeleteCredentialsResponse
object
The response for the delete credentials action.
2 properties 2 required
Deployment
object
2 properties 2 required
Details
object
6 properties
Direction
string
An ordering direction
DistributedIssuerConfigurationGetResponse
object
14 properties 1 required
EdgeInstanceConnectionDetails
object
8 properties
EdgeInstanceHealthDetails
object
8 properties
EdgeInstanceInformation
object
27 properties
EdgeInstanceRequest
object
2 properties 1 required
EdgeInstanceResponse
object
1 property
EdgeInstanceStatusDetailsInformation
object
2 properties
EdgeStatus
string
EdgeType
string
EdgeWorkerDeleteResponse
object
2 properties
EdgeWorkerHealthDetails
object
11 properties
EdgeWorkerInformation
object
11 properties
EdgeWorkerRequest
object
3 properties
EdgeWorkerStatusDetailsInformation
object
2 properties
EdgeWorkersResponse
object
1 property
EncryptionDetails
object
2 properties
EncryptionKeyInformation
object
5 properties
EncryptionKeysResponse
object
1 property
EntityTag
object
2 properties
Error1
object
A single error. The numeric code is stable and matches the codes listed at the start of each cause in the endpoints' error-response descriptions, so clients ca…
3 properties
Error2
object
Hold the error details.
3 properties 2 required
ErrorInformation1
object
3 properties
ErrorInformation2
object
3 properties
ErrorInformation3
object
3 properties
ErrorInformation4
object
3 properties
ErrorInformation5
object
3 properties
ErrorInformation6
object
3 properties
ErrorInformation7
object
3 properties
ErrorInformation8
object
3 properties
ErrorInformation9
object
3 properties
ErrorResponse1
object
1 property
ErrorResponse10
object
1 property
ErrorResponse11
object
1 property
ErrorResponse2
object
1 property
ErrorResponse3
object
1 property
ErrorResponse4
object
1 property
ErrorResponse5
object
Holds the response body returned for errors.
1 property
ErrorResponse6
object
1 property
ErrorResponse7
object
1 property
ErrorResponse8
object
1 property
ErrorResponse9
object
1 property
ExportedActivityLogEntryInformation
object
7 properties
ExpressionNode
object
A node in the recursive search filter tree. A compound node uses an AND/OR operator and nests child nodes in operands; a leaf node uses a comparison operator o…
5 properties
ExtendedApplicationOwnership
object
4 properties
ExtendedCertificateInformation
object
59 properties
ExtendedCertificateInstanceInformation
object
18 properties
ExtendedCertificateInstanceResponse
object
2 properties
ExtendedConfigurationGetResponse
ExtendedKeyUsage
string
Extended key usage
ExtendedPolicyGetResponse
Facet
object
3 properties
Filter1
string
Filter2
object
3 properties
FilterOperand
object
2 properties
FilterOperands
object
2 properties
ForwardTrustProxyConfigurationGetResponse
object
Configuration that issues forward-trust proxy intermediate certificates. It references only a Sub CA provider; the policy, client authentication/authorization,…
2 properties 1 required
GeneralNamesData1
object
A certificate subject alternative name by type
9 properties
GeneralNamesData2
object
A certificate request subject alternative name (SAN) type
9 properties
GetCMSConfigurationsResponse
object
The array of Credential Manager Service configurations received.
2 properties 2 required
GetCredentialsResponse
object
Array of credentials received.
2 properties 2 required
GetServiceAccountScopesResponseBody
array
GetServiceAccountsByClientIDResponseBody
GetServiceAccountsResponseBody
array
GoogleCloudProvider
object
2 properties 2 required
HSMEdgeStatus
string
HashiCorpConfiguration
The configuration for the HashiCorp app. It's required to set the value for the cmsType property to hashicorp.
HashiCorpConfigurationRequiredProp
The configuration for the HashiCorp app. It's required to set the value for the cmsType property to hashicorp.
1 required
HashiCorpDetails
object
The HashiCorp Credential information.
2 properties
HashiCorpDetailsRequiredProp
2 required
ImportedCertificateInformation
object
9 properties
IntegrationServiceCreationRequest
object
8 properties 4 required
IntegrationServiceDetailsResponse
object
2 properties
IntegrationServiceInformation
object
14 properties
IntegrationServiceUpdateRequest
object
6 properties
IntermediateCertificateGetResponse
object
19 properties
IntermediateCertificateListResponse
object
1 property
InventoryMonitoringConfig
object
1 property
InventoryMonitoringConfigRequest
object
1 property
InventoryMonitoringConfiguration
object
1 property 1 required
InventoryMonitoringConfigurationResponse
object
3 properties
InventoryMonitoringSchedulerInformation
object
2 properties
InvitationInformation
object
5 properties
InvitationRequest
object
1 property 1 required
InvitationResponse
object
1 property
IssuingTemplateDomainsSyncInformation
object
3 properties
IssuingTemplateDomainsSyncResponse
object
1 property
IssuingTemplatesDomainsSyncRequest
object
3 properties 3 required
JWTClient
object
5 properties 4 required
JWTJWKSAuthentication
object
3 properties 2 required
JWTOIDCAuthentication
object
4 properties 3 required
JWTStandardClaimsAuthentication
object
3 properties 3 required
KeyAlgorithm1
string
Key algorithm type
KeyAlgorithm2
string
KeyAlgorithmInformation
object
Key algorithm
2 properties 2 required
KeyTypeInformation1
object
1 property
KeyTypeInformation2
object
1 property
KeyTypeParameters1
object
3 properties 3 required
KeyTypeParameters2
object
3 properties 1 required
KeyUsage
string
Key usage
LastModifiedBy
string
The ID of the user whom modified the credential.
LastModifiedOn
string
The date in ISO 8601 full-date format when the credential was modified.
Link
object
7 properties
LocalLoginRequest
object
1 property
LocalizationResource
object
Translation map for the UI being rendered. This map is used with the manifest schema. The keys represent the values provided for the "x-localizationKey" proper…
1 property
MachineBatchProvisioningResultInformation
object
7 properties
MachineCreationRequest
object
9 properties 3 required
MachineDiscoveryResultInformation
object
10 properties
MachineDocumentInformation
object
15 properties
MachineDocumentResponse
object
2 properties
MachineIdentityCreationRequest
object
4 properties 2 required
MachineIdentityDocumentInformation
object
16 properties
MachineIdentityDocumentResponse
object
2 properties
MachineIdentityInformation
object
12 properties
MachineIdentityResponse
object
1 property
MachineIdentitySearchRequest
object
3 properties
MachineIdentityUpdateRequest
object
3 properties
MachineIdentityWorkflowInformation
object
2 properties
MachineIdentityWorkflowRequest
object
2 properties 1 required
MachineInformation
object
22 properties
MachineOwnership
object
1 property
MachineUpdateRequest
object
10 properties
MachineWorkflowRequest
object
2 properties
MachinesResponse
object
1 property
MachinesSearchRequest
object
3 properties
Manifest
object
8 properties 5 required
MediaType
object
5 properties
MetadataInformation
object
2 properties
MinTLSVersion
string
Minimum required TLS protocol version
Name
string
The Name of CMS configuration
NamespaceChartDetails
object
2 properties
NamespaceStatusDetails
object
3 properties
NaryOperator
string
An operator for filtering
NewCookie
object
11 properties
NodeCondition
object
4 properties
NodeInfo
object
1 property
NodeStatusDetails
object
2 properties
Operator
string
Order
object
2 properties
OrderObject
object
2 properties
Ordering
object
1 property
OwnerIdAndType
object
2 properties 2 required
Page1
object
Specify pagination on the search request
2 properties
Page2
object
Specify pagination on the search request
2 properties
Paging
object
2 properties
PairingCodeInformation
object
7 properties
PairingCodeRequest
object
3 properties
PatchServiceAccountByClientIDRequestBody
Persona
string
Plugin
object
10 properties 8 required
PluginResponse
object
1 property 1 required
PluginType
string
Used for differentiation between different types of plugins.
PodStatusDetails
object
7 properties
PolicyCreateRequest
PolicyDeleteResponse
object
2 properties
PolicyGetResponse
object
13 properties
PolicyListResponse
object
1 property
PolicyUpdateRequest
object
9 properties
ProductEntitlement1
string
ProductEntitlement2
string
ProductEntitlementInformation
object
3 properties 3 required
Property
object
5 properties
ProviderConfigInformation
object
2 properties
ProviderInformation
object
3 properties
ProviderInputInformation
object
4 properties
ProvisionCertificateWorkflowInputInformation
object
1 property 1 required
PublicPluginCreationRequest
object
3 properties 2 required
PublicPluginUpdateRequest
object
3 properties
PutServiceAccountByClientIDCredentialsRequestBody
object
1 property 1 required
PutServiceAccountByClientIDCredentialsResponseBody
object
1 property
PutServiceAccountByClientIDOCITokenResponseBody
object
1 property
Recipient
object
2 properties 2 required
RecommendedSettingsInformation1
object
8 properties
RecommendedSettingsInformation2
object
9 properties
RecommendedSettingsKeyTypeInformation1
object
3 properties
RecommendedSettingsKeyTypeInformation2
object
3 properties
RecommendedSettingsKeyTypeParameter
object
3 properties
RecommendedSettingsRequest
object
9 properties
RecoveryCodeInformation
object
8 properties
RecoveryCodeRequest
object
1 property 1 required
Reference
object
The machine referenced.
2 properties 2 required
ReferenceType
string
The type of the reference: machine
References
array
The machines referenced.
Response
object
17 properties
ResponseCMSDetails
An string containing the JSON content representing the details of the specific privileged access management.
ResponseCredentialDetails
ResponseCyberArkCredDetails
ResponseCyberArkDetails
ResponseHashiCorpCredDetails
ResponseHashiCorpDetails
Role1
string
Role2
string
RolesRequest
object
2 properties
SANs
object
Subject alternative names
4 properties
SSOStatus
string
ScanafiConfigResponseV1
object
3 properties
SchedulerPatternInformation1
object
1 property 1 required
SchedulerPatternInformation2
object
1 property 1 required
SchedulerPatternInformation3
object
1 property 1 required
Scope
string
The service account authorization scopes
ScopeDetails
object
The service account authorization scopes detailed
3 properties 2 required
SearchOperand
A search filter operand — a string, integer, or boolean. Date-time operands are ISO-8601 strings; non-string scalars are coerced to their string form for evalu…
ServiceAccountBaseObject
ServiceAccountBaseObjectNoKey
object
11 properties
ServiceAccountBasePatchObjectNoKey
object
9 properties
ServiceAccountDetails
ServiceAccountDetailsNoKey
ServiceAccountInformation
object
16 properties
ServiceAccountPatchBaseObject
StatusResponse
object
Details about the current in-progress certificate auto-renewal process, and the most recently completed process.
2 properties 1 required
StatusResponseItem
object
Details about the upcoming certificate auto-renewal run.
4 properties 4 required
StatusType
object
3 properties
SubCAProviderCreateRequest
SubCAProviderDeleteResponse
object
2 properties
SubCAProviderGetResponse
object
19 properties
SubCAProviderListResponse
object
1 property
SubCAProviderPKCS11Configuration
object
5 properties
SubCAProviderUpdateRequest
object
13 properties
SubjectAlternativeNamesByType
object
4 properties
SubjectAttributes
object
Subject attributes
6 properties
SystemRole
string
TSGId
string
The TSG identifier the credential belongs to.
TagAssignmentErrorInformation
object
Error information for tags not assigned
3 properties
TagInformation
object
5 properties
TagRequest
object
Array of tag and tag-value objects
2 properties 1 required
TagResponse
object
2 properties
TagValueInformation
object
4 properties
TagValuesRequest
object
1 property 1 required
TagValuesResponse
object
2 properties
TagsAndValuesInformation
object
2 properties
TagsAndValuesResponse
object
1 property
TagsAssignRequest
object
4 properties 1 required
TagsAssignResponse
object
1 property
TagsAssignResponseInformation
object
8 properties
TagsAssignmentAggregatesRequest
object
2 properties 1 required
TagsAssignmentAggregatesResponse
object
1 property
TagsAssignmentAggregatesResponseInformation
object
Represents a mapping of tag name to list of aggregates information
2 properties
TagsBulkRequest
object
1 property
Target
object
2 properties 2 required
TargetsInformation
object
1 property 1 required
TeamId
string
The ID of a team.
TeamInformation1
object
8 properties
TeamInformation2
object
10 properties
TeamMembersRequest
object
1 property 1 required
TeamOwnersRequest
object
1 property 1 required
TeamRole
string
TeamsIds
array
The ID's of teams.
TeamsResponse
object
1 property
TenantExpirationNotificationConfiguration
object
6 properties
TenantExpirationReportsConfiguration
object
7 properties
TenantRenewalConfiguration
object
4 properties 2 required
TestCMSConfigurationRequest
object
The information representing a Credential Manager Service configuration for test purposes.
6 properties 1 required
TestCMSConfigurationResponse
object
The result of testing the Credential Manager Service configuration.
2 properties 2 required
TestCMSDetails
TestConnectionWorkflowRequest
object
6 properties
TestCredentialDetails
TestCredentialRequest
object
The properties representing a credential to test.
5 properties 1 required
TestCredentialResponse
object
The result of testing access to the credential.
2 properties 2 required
TestCyberArkCredDetails
TestCyberArkDetails
TestHashiCorpCredDetails
TestHashiCorpDetails
TokenAuthenticationData
object
1 property
TrackingDataInformation
object
1 property 1 required
UnaryOperator
string
An operator for filtering
UpdateCMSConfigurationRequest
object
The information representing a Credential Manager Service configuration for update.
6 properties 1 required
UpdateCMSDetails
UpdateCredentialDetails
UpdateCredentialRequest
object
The properties representing a credential to update.
5 properties 1 required
UpdateCyberArkCredDetails
UpdateCyberArkDetails
UpdateHashiCorpCredDetails
UpdateHashiCorpDetails
UpdateTeamRequest
object
3 properties
UpdatesConfigRequest
object
1 property 1 required
UpdatesConfigResponse
object
1 property
UpgradeStatus
string
UriBuilder
object
UserAccountResponse
object
3 properties
UserAccountType
string
UserAccountTypeRequest
object
1 property 1 required
UserForceLocalPasswordExpirationRequest
object
1 property 1 required
UserInformation1
object
17 properties
UserInformation2
object
22 properties
UserMatchingRule
object
3 properties 3 required
UserPasswordAuthenticationData
object
2 properties
UserResponse
object
1 property
UserStatus
string
UserType
string
VSatelliteId
string
The VSatellite ID
VSatelliteIds
array
An array of the VSatellite Ids which are connected to the CMS provider.
VisibilityConstraintsInformation
object
4 properties
WebhookProperties
object
Connector properties for webhook-based notifications. Webhook notifications are delivered as HTTP POST requests with a JSON body structured as: json { "events"…
2 properties 2 required
WeeklyPatternInformation
object
3 required
WorkType
string
Defines the type of supported workflow for the plugin.
WorkerServiceStatusDetails
object
2 properties
WorkerStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

venafi-certificate-manager-saas-openapi.yml Raw ↑

Other APIs Venafi publishes across the network.

Trust Protection Foundation WebSDK (Venafi Trust Protection Platform)
AE Profile APIs.io
#Certificates#PKI#Machine Identity#Certificate Lifecycle Management#Security
← Back to C APIs
API Details
ID
venafi:certificate-manager-saas
Base URL
https://api.venafi.cloud
Docs
https://developer.venafi.com/tlsprotectcloud/reference/tls-protect-overview
Provider
Venafi
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=certificate-manager-saas&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/certificate-manager-saas"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Certificate Manager - SaaS API (Venafi Control Plane), published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.