CA REST API v1 - dogtagpki/pki GitHub Wiki

Overview

This page describes the services provided by CA REST API v1.

Certificate Services

Path	Method	Service
`/ca/rest/certs`	`GET`	List Certificates
`/ca/rest/certs/search`	`POST`	Search Certificates
`/ca/rest/certs/{id}`	`GET`	Retrieve Certificate
`/ca/rest/config/cert/signing`	`GET`	Retrieve Signing Certificate
`/ca/rest/config/cert/transport`	`GET`	Retrieve Transport Certificate
`/ca/rest/agent/certs/{id}`	`GET`	Review Certificate
`/ca/rest/agent/certs/{id}/revoke`	`POST`	Revoke Certificate
`/ca/rest/agent/certs/{id}/revoke-ca`	`POST`	Revoke Signing Certificate
`/ca/rest/agent/certs/{id}/unrevoke`	`POST`	Unrevoke Certificate

Certificate Request Services

Path	Method	Service
`/ca/rest/certrequests/profiles`	`GET`	List Certificate Request Templates
`/ca/rest/certrequests/profiles/{id}`	`GET`	Retrieve Certificate Request Template
`/ca/rest/certrequests`	`POST`	Submit Certificate Request
`/ca/rest/certrequests/{id}`	`GET`	Retrieve Certificate Request
`/ca/rest/agent/certrequests`	`GET`	List Certificate Requests
`/ca/rest/agent/certrequests/{id}`	`GET`	Review Certificate Request
`/ca/rest/agent/certrequests/{id}/approve`	`POST`	Approve Certificate Request
`/ca/rest/agent/certrequests/{id}/reject`	`POST`	Reject Certificate Request
`/ca/rest/agent/certrequests/{id}/cancel`	`POST`	Cancel Certificate Request
`/ca/rest/agent/certrequests/{id}/update`	`POST`	Update Certificate Request
`/ca/rest/agent/certrequests/{id}/validate`	`POST`	Validate Certificate Request
`/ca/rest/agent/certrequests/{id}/assign`	`POST`	Assign Certificate Request
`/ca/rest/agent/certrequests/{id}/unassign`	`POST`	Unassign Certificate Request

Certificate Profile Services

Path	Method	Service
`/ca/rest/profiles`	`GET`	List Certificate Profiles
`/ca/rest/profiles`	`POST`	Create Certificate Profile
`/ca/rest/profiles/{id}`	`GET`	Get Certificate Profile
`/ca/rest/profiles/{id}`	`PUT`	Update Certificate Profile
`/ca/rest/profiles/{id}`	`POST`	Enable Certificate Profile
`/ca/rest/profiles/{id}`	`POST`	Disable Certificate Profile
`/ca/rest/profiles/{id}`	`DELETE`	Delete Certificate Profile

Certificate Authority Services

Path	Method	Service
`/ca/rest/authorities`	`GET`	List Certificate Authorities
`/ca/rest/authorities`	`POST`	Create Certificate Authority
`/ca/rest/authorities/{id}`	`GET`	Get Certificate Authority
`/ca/rest/authorities/{id}`	`DELETE`	Delete Certificate Authority
`/ca/rest/authorities/{id}/cert`	`GET`	Get Certificate Authority Certificate
`/ca/rest/authorities/{id}/chain`	`GET`	Get Certificate Authority Certificate Chain
`/ca/rest/authorities/{id}/enable`	`POST`	Enable Certificate Authority
`/ca/rest/authorities/{id}/disable`	`POST`	Disable Certificate Authority

Security Domain Services

Path	Method	Service
`/ca/rest/securityDomain/installToken`	`GET`	Get Install Token
`/ca/rest/securityDomain/domainInfo`	`GET`	Get Security Domain Info
`/ca/rest/securityDomain/hosts`	`GET`	Get Security Domain Hosts
`/ca/rest/securityDomain/hosts/{id}`	`GET`	Get Security Domain Host
`/ca/rest/securityDomain/hosts/{id}`	`DELETE`	Delete Security Domain Host

Deprecated Pages

Deprecated pages to be removed - see latest docs here

= Account Services =

Path	Service
	Login
	Logout

= User Services =

Path	Service
	List Users
	Retrieve User
	Add User
	Replace User
	Modify User
	Delete User

= User Certificate Services =

Path	Service
	List User Certificates
	Add User Certificate
	Retrieve User Certificate
	Delete User Certificate

= User Roles Services =

Path	Service
	List User Roles
	Add User Role
	Delete User Role

= Group Services =

Path	Service
	List Groups
	Retrieve Group
	Add Group
	Modify Group
	Delete Group

= Group Member Services =

Path	Service
	List Group Members
	Retrieve Group Member
	Add Group Member
	Delete Group Member

See Also

PKI CA Java API

Tip	To find a page in the Wiki, enter the keywords in search field, press Enter, then click Wikis.

⚠️ GitHub.com Fallback ⚠️