pki_api.yaml

Reference for the pki_api.yaml

Secure Comms PKI API
 0.0.1 

[ Base URL: localhost:5666/zdmp/api/v1 ]
/openapi/enterprise-tier/secure-communication/pki_api.yaml

API for managing certificates and self-signed CA

Manages C Authorities

GET​/zdmp​/api​/v1​/ca
Main route to manage C Authorities
POST​/zdmp​/api​/v1​/ca
Main route to manage C Authorities
PUT​/zdmp​/api​/v1​/ca
Main route to manage C Authorities

Get C Authority details

Get a certificate of a C Authority

DELETE​/zdmp​/api​/v1​/ca​/{caId}
Get a certificate of a C Authority
GET​/zdmp​/api​/v1​/ca​/{caId}
Get a certificate of a C Authority
GET​/zdmp​/api​/v1​/info
Get a certificate of a C Authority

Manages certificates of a particular CA_Authority

GET​/zdmp​/api​/v1​/cert
Main route to manage certificates
POST​/zdmp​/api​/v1​/cert
Main route to manage certificates
PUT​/zdmp​/api​/v1​/cert
Main route to manage certificates

Get certificate details

Revokes a certificate

Get or changes the status of a certificate

GET​/zdmp​/api​/v1​/cert​/status​/{certId}
Get current status of a certificate
PUT​/zdmp​/api​/v1​/cert​/status​/{certId}
Get current status of a certificate

Get or renew a certificate or private key

DELETE​/zdmp​/api​/v1​/cert​/{certid}
Get a certificate or private key
GET​/zdmp​/api​/v1​/cert​/{certid}
Get a certificate or private key
PUT​/zdmp​/api​/v1​/cert​/{certid}
Get a certificate or private key
Last modified March 1, 2021