Documentation | CodeSign Secure

Method	Endpoint	Description
GET	/certificate_manage/activecerts/	List active certificates
GET	/certificate_manage/certificateDetailsByName/{certificateName}/	Get a certificate by name
POST	/certificate_manage/certificateDetailsByName/{certificateName}/	Create a certificate record by name
GET	/certificate_manage/certificate_names	List certificate names
POST	/certificate_manage/certificate_status/active/	Activate a certificate
POST	/certificate_manage/certificate_status/inactive/	Deactivate a certificate
GET	/certificate_manage/certificates	List certificates
POST	/certificate_manage/certificates	Add a certificate record
GET	/certificate_manage/certificates/{id}/	Get a certificate
PUT	/certificate_manage/certificates/{id}/	Replace a certificate record
PATCH	/certificate_manage/certificates/{id}/	Update a certificate record
GET	/certificate_manage/certificatesTriggers/	List certificate expiry reminders
POST	/certificate_manage/certificatesTriggers/	Create a certificate expiry reminder
GET	/certificate_manage/certificatesTriggers/{id}/	Get a certificate expiry reminder
PUT	/certificate_manage/certificatesTriggers/{id}/	Replace a certificate expiry reminder
PATCH	/certificate_manage/certificatesTriggers/{id}/	Update a certificate expiry reminder
GET	/certificate_manage/downloadCSR/	Download a certificate signing request
POST	/certificate_manage/download_multiple_certificates/	Download several certificates
GET	/certificate_manage/downloadcertificate/	Download a certificate
PUT	/certificate_manage/edit_environment/{certificate_id}/	Change a certificate's environment
GET	/certificate_manage/get_certificate_data/	List supported algorithms
GET	/certificate_manage/importCertificate/	List imported certificates
POST	/certificate_manage/importCertificate/	Import a certificate
GET	/certificate_manage/importCertificate/{id}/	Get an imported certificate
PUT	/certificate_manage/importCertificate/{id}/	Replace an imported certificate record
PATCH	/certificate_manage/importCertificate/{id}/	Update an imported certificate record
GET	/certificate_manage/mappedProjects/{certificate_id}/	List applications a certificate is mapped to
POST	/certificate_manage/mappedProjects/{certificate_id}/	Map a certificate to an application
GET	/certificate_manage/selfSignCertificate/	List self-signed certificates
POST	/certificate_manage/selfSignCertificate/	Create a self-signed certificate
GET	/certificate_manage/selfSignCertificate/{id}/	Get a self-signed certificate
PUT	/certificate_manage/selfSignCertificate/{id}/	Replace a self-signed certificate record
PATCH	/certificate_manage/selfSignCertificate/{id}/	Update a self-signed certificate record
GET	/certificate_manage/signRequest/	List certificate signing requests
POST	/certificate_manage/signRequest/	Generate a certificate signing request
GET	/certificate_manage/signRequest/{id}/	Get a certificate signing request
PUT	/certificate_manage/signRequest/{id}/	Replace a signing request record
PATCH	/certificate_manage/signRequest/{id}/	Update a signing request record
PUT	/certificate_manage/update_key_usage	Set certificate key usage

GET /certificate_manage/activecerts/

Returns the certificates currently available for signing.

Request Parameters

Name	Located In	Type	Required	Description
key	Query	string	No	Narrow the result to one key.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/activecerts/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /certificate_manage/certificateDetailsByName/{certificateName}/

Returns the details of one certificate, looked up by name rather than identifier.

Request Parameters

Name	Located In	Type	Required	Description
certificateName	Path	string	Yes	Name of the certificate.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/certificateDetailsByName/<certificateName>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /certificate_manage/certificateDetailsByName/{certificateName}/

Creates a certificate record against the supplied name.

Request Parameters

Name	Located In	Type	Required	Description
certificateName	Path	string	Yes	Name of the certificate.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	No	Certificate description
common_name	string	No	Common name
organization_name	string	No	Organization name
organization_unit	string	No	Organization unit
country_code	string	No	Country code
state_province	string	No	State province
locality	string	No	Locality
email	string (email)	No	Email
key_algorithm	string	No	Key algorithm
valid_from	string (date-time)	No	Valid from
valid_to	string (date-time)	No	Valid to
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
FileName	string	No	FileName
key_alias	string	No	Key alias
Is_deleted	boolean	No	Is deleted
key_usage	string	No	Key usage

Example Request

curl -X POST "https://<your domain>/api/certificate_manage/certificateDetailsByName/<certificateName>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","created_user":1}'

Responses

Status Code	Description
201	The operation completed.

GET /certificate_manage/certificate_names

Returns the names of the available certificates, for populating a picker.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/certificate_names" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /certificate_manage/certificate_status/active/

Marks a certificate as available for signing.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Name of the certificate

Example Request

curl -X POST "https://<your domain>/api/certificate_manage/certificate_status/active/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string"}'

Responses

Status Code	Description
200	The operation completed.

POST /certificate_manage/certificate_status/inactive/

Marks a certificate as unavailable for signing. Existing signatures are unaffected.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Name of the certificate

Example Request

curl -X POST "https://<your domain>/api/certificate_manage/certificate_status/inactive/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string"}'

Responses

Status Code	Description
200	The operation completed.

GET /certificate_manage/certificates

Returns every certificate held on the appliance, with its type, validity dates and current state. Expired certificates are reported as inactive.

Request Parameters

Name	Located In	Type	Required	Description
algorithm	Query	string	No	Limit to one key algorithm, for example RSA or ECDSA.
size	Query	string	No	Limit to one key size in bits, for example 2048 or 256.
status	Query	string	No	Limit to one state: active, inactive or expired.
filters	Query	string	No	JSON array of {"field": .., "operator": .., "value": ..} objects, all of which must match. Fields: Certificate_Name, Algorithm, Size, Valid_Till, Environment, Status. Text fields take equals, not_equals, contains, not_contains, starts_with or ends_with; date fields take date_is, date_is_not, date_is_before or date_is_after with a YYYY-MM-DD value. Unknown fields and operators are ignored. Status takes only equals, with Active, Inactive or Expired.
page	Query	integer	No	1-based page number. Defaults to 1.
count	Query	integer	No	Records per page. Defaults to 10.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/certificates" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /certificate_manage/certificates

Creates a certificate record. The fields and their types are listed under Parameters.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	No	Certificate description
common_name	string	No	Common name
organization_name	string	No	Organization name
organization_unit	string	No	Organization unit
certifcateType	integer	Yes	CertifcateType
country_code	string	No	Country code
state_province	string	No	State province
locality	string	No	Locality
email	string (email)	No	Email
key_algorithm	string	No	Key algorithm
valid_from	string (date-time)	No	Valid from
valid_to	string (date-time)	No	Valid to
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
key_alias	string	No	Key alias
Is_deleted	boolean	No	Is deleted
key_usage	string	No	Key usage
eid	string	No	Eid

Example Request

curl -X POST "https://<your domain>/api/certificate_manage/certificates" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certifcateType":1,"created_user":1}'

Responses

Status Code	Description
201	The operation completed.

GET /certificate_manage/certificates/{id}/

Returns a single certificate by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/certificates/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /certificate_manage/certificates/{id}/

Replaces a certificate record. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	No	Certificate description
common_name	string	No	Common name
organization_name	string	No	Organization name
organization_unit	string	No	Organization unit
certifcateType	integer	Yes	CertifcateType
country_code	string	No	Country code
state_province	string	No	State province
locality	string	No	Locality
email	string (email)	No	Email
key_algorithm	string	No	Key algorithm
valid_from	string (date-time)	No	Valid from
valid_to	string (date-time)	No	Valid to
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
key_alias	string	No	Key alias
Is_deleted	boolean	No	Is deleted
key_usage	string	No	Key usage
eid	string	No	Eid

Example Request

curl -X PUT "https://<your domain>/api/certificate_manage/certificates/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certifcateType":1,"created_user":1}'

Responses

Status Code	Description
200	The record after the update.

PATCH /certificate_manage/certificates/{id}/

Updates selected fields of a certificate record. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	No	Certificate description
common_name	string	No	Common name
organization_name	string	No	Organization name
organization_unit	string	No	Organization unit
certifcateType	integer	Yes	CertifcateType
country_code	string	No	Country code
state_province	string	No	State province
locality	string	No	Locality
email	string (email)	No	Email
key_algorithm	string	No	Key algorithm
valid_from	string (date-time)	No	Valid from
valid_to	string (date-time)	No	Valid to
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
key_alias	string	No	Key alias
Is_deleted	boolean	No	Is deleted
key_usage	string	No	Key usage
eid	string	No	Eid

Example Request

curl -X PATCH "https://<your domain>/api/certificate_manage/certificates/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certifcateType":1,"created_user":1}'

Responses

Status Code	Description
200	The record after the update.

GET /certificate_manage/certificatesTriggers/

Returns the configured expiry reminders: how many days before expiry a notice is sent, and who receives it.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/certificatesTriggers/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /certificate_manage/certificatesTriggers/

Configures an expiry reminder. Fields are listed under Parameters.

Request Body (application/json)

Field	Type	Required	Description
triggerEmails	array of object	Yes
triggerDays	array of object	Yes

Example Request

curl -X POST "https://<your domain>/api/certificate_manage/certificatesTriggers/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"triggerEmails":[],"triggerDays":[]}'

Responses

Status Code	Description
201	The operation completed.

GET /certificate_manage/certificatesTriggers/{id}/

Returns one expiry reminder by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/certificatesTriggers/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /certificate_manage/certificatesTriggers/{id}/

Replaces the reminder. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Request Body (application/json)

Field	Type	Required	Description
triggerEmails	array of object	Yes
triggerDays	array of object	Yes

Example Request

curl -X PUT "https://<your domain>/api/certificate_manage/certificatesTriggers/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"triggerEmails":[],"triggerDays":[]}'

Responses

Status Code	Description
200	The record after the update.

PATCH /certificate_manage/certificatesTriggers/{id}/

Updates selected fields. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Request Body (application/json)

Field	Type	Required	Description
triggerEmails	array of object	Yes
triggerDays	array of object	Yes

Example Request

curl -X PATCH "https://<your domain>/api/certificate_manage/certificatesTriggers/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"triggerEmails":[],"triggerDays":[]}'

Responses

Status Code	Description
200	The record after the update.

GET /certificate_manage/downloadCSR/

Returns a generated certificate signing request as a file.

Request Parameters

Name	Located In	Type	Required	Description
csrName	Query	string	Yes	Name of the signing request.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/downloadCSR/?csrName=<csrName>" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /certificate_manage/download_multiple_certificates/

Returns the named certificates together as a zip archive.

Request Body (application/json)

Field	Type	Required	Description
certificate_names_list	array of string	Yes	Names of the certificates to include.

Example Request

curl -X POST "https://<your domain>/api/certificate_manage/download_multiple_certificates/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_names_list":[]}'

Responses

Status Code	Description
200	The operation completed.

GET /certificate_manage/downloadcertificate/

Returns a single certificate file.

Request Parameters

Name	Located In	Type	Required	Description
certificateName	Query	string	Yes	Name of the certificate.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/downloadcertificate/?certificateName=<certificateName>" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /certificate_manage/edit_environment/{certificate_id}/

Moves a certificate to a different environment.

Request Parameters

Name	Located In	Type	Required	Description
certificate_id	Path	integer	Yes	Identifier of the certificate.

Request Body (application/json)

Field	Type	Required	Description
environment_id	integer	Yes	Environment to move the certificate to.
environment_name	string	Yes	Name of the target environment.
modified_user_id	integer	Yes	User making the change.

Example Request

curl -X PUT "https://<your domain>/api/certificate_manage/edit_environment/<certificate_id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"environment_id":1,"environment_name":"string","modified_user_id":1}'

Responses

Status Code	Description
200	The record after the update.

GET /certificate_manage/get_certificate_data/

Returns the key algorithms and sizes available when creating a certificate, for populating a picker.

Request Parameters

Name	Located In	Type	Required	Description
type	Query	string	No	Limit to one certificate type.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/get_certificate_data/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /certificate_manage/importCertificate/

Returns the certificates imported into the appliance.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/importCertificate/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /certificate_manage/importCertificate/

Imports a certificate issued elsewhere and associates it with a key held in the hardware security module. Fields are listed under Parameters.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	Yes	Certificate description
password	string	No	Password
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
valid_to	string (date-time)	No	Valid to
key_usage	string	No	Key usage
key_alias	string	No	Key alias
eid	string	No	Eid
environment_id	integer	Yes	Environment id

Example Request

curl -X POST "https://<your domain>/api/certificate_manage/importCertificate/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certificate_description":"string","created_user":1,"environment_id":1}'

Responses

Status Code	Description
201	The operation completed.

GET /certificate_manage/importCertificate/{id}/

Returns one imported certificate by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/importCertificate/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /certificate_manage/importCertificate/{id}/

Replaces the record. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	Yes	Certificate description
password	string	No	Password
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
valid_to	string (date-time)	No	Valid to
key_usage	string	No	Key usage
key_alias	string	No	Key alias
eid	string	No	Eid
environment_id	integer	Yes	Environment id

Example Request

curl -X PUT "https://<your domain>/api/certificate_manage/importCertificate/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certificate_description":"string","created_user":1,"environment_id":1}'

Responses

Status Code	Description
200	The record after the update.

PATCH /certificate_manage/importCertificate/{id}/

Updates selected fields. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	Yes	Certificate description
password	string	No	Password
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
valid_to	string (date-time)	No	Valid to
key_usage	string	No	Key usage
key_alias	string	No	Key alias
eid	string	No	Eid
environment_id	integer	Yes	Environment id

Example Request

curl -X PATCH "https://<your domain>/api/certificate_manage/importCertificate/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certificate_description":"string","created_user":1,"environment_id":1}'

Responses

Status Code	Description
200	The record after the update.

GET /certificate_manage/mappedProjects/{certificate_id}/

Returns the applications and environments the certificate may be used with.

Request Parameters

Name	Located In	Type	Required	Description
certificate_id	Path	integer	Yes	Identifier of the certificate.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/mappedProjects/<certificate_id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /certificate_manage/mappedProjects/{certificate_id}/

Associates the certificate with an application and environment.

Request Parameters

Name	Located In	Type	Required	Description
certificate_id	Path	integer	Yes	Identifier of the certificate.

Request Body (application/json)

Field	Type	Required	Description
project_id	integer	Yes	Project id

Example Request

curl -X POST "https://<your domain>/api/certificate_manage/mappedProjects/<certificate_id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"project_id":1}'

Responses

Status Code	Description
201	The operation completed.

GET /certificate_manage/selfSignCertificate/

Returns the certificates created as self-signed on this appliance.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/selfSignCertificate/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /certificate_manage/selfSignCertificate/

Generates a key pair inside the hardware security module and issues a self-signed certificate for it. The private key is created in the module and cannot be exported. Subject and key fields are listed under Parameters.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	Yes	Certificate description
common_name	string	Yes	Common name
organization_name	string	Yes	Organization name
organization_unit	string	Yes	Organization unit
country_code	string	Yes	Country code
state_province	string	Yes	State province
locality	string	Yes	Locality
email	string (email)	Yes	Email
key_algorithm	string	Yes	Key algorithm
valid_from	string (date-time)	Yes	Valid from
valid_to	string (date-time)	Yes	Valid to
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
key_usage	string	No	Key usage
key_renewal	boolean	No	Key renewal
environment_id	integer	Yes	Environment id

Example Request

curl -X POST "https://<your domain>/api/certificate_manage/selfSignCertificate/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certificate_description":"string","common_name":"string","organization_name":"string","organization_unit":"string","country_code":"string","state_province":"string","locality":"string","email":"string","key_algorithm":"string","valid_from":"string","valid_to":"string","created_user":1,"environment_id":1}'

Responses

Status Code	Description
201	The operation completed.

GET /certificate_manage/selfSignCertificate/{id}/

Returns one self-signed certificate by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/selfSignCertificate/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /certificate_manage/selfSignCertificate/{id}/

Replaces the record. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	Yes	Certificate description
common_name	string	Yes	Common name
organization_name	string	Yes	Organization name
organization_unit	string	Yes	Organization unit
country_code	string	Yes	Country code
state_province	string	Yes	State province
locality	string	Yes	Locality
email	string (email)	Yes	Email
key_algorithm	string	Yes	Key algorithm
valid_from	string (date-time)	Yes	Valid from
valid_to	string (date-time)	Yes	Valid to
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
key_usage	string	No	Key usage
key_renewal	boolean	No	Key renewal
environment_id	integer	Yes	Environment id

Example Request

curl -X PUT "https://<your domain>/api/certificate_manage/selfSignCertificate/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certificate_description":"string","common_name":"string","organization_name":"string","organization_unit":"string","country_code":"string","state_province":"string","locality":"string","email":"string","key_algorithm":"string","valid_from":"string","valid_to":"string","created_user":1,"environment_id":1}'

Responses

Status Code	Description
200	The record after the update.

PATCH /certificate_manage/selfSignCertificate/{id}/

Updates selected fields. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	Yes	Certificate description
common_name	string	Yes	Common name
organization_name	string	Yes	Organization name
organization_unit	string	Yes	Organization unit
country_code	string	Yes	Country code
state_province	string	Yes	State province
locality	string	Yes	Locality
email	string (email)	Yes	Email
key_algorithm	string	Yes	Key algorithm
valid_from	string (date-time)	Yes	Valid from
valid_to	string (date-time)	Yes	Valid to
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
key_usage	string	No	Key usage
key_renewal	boolean	No	Key renewal
environment_id	integer	Yes	Environment id

Example Request

curl -X PATCH "https://<your domain>/api/certificate_manage/selfSignCertificate/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certificate_description":"string","common_name":"string","organization_name":"string","organization_unit":"string","country_code":"string","state_province":"string","locality":"string","email":"string","key_algorithm":"string","valid_from":"string","valid_to":"string","created_user":1,"environment_id":1}'

Responses

Status Code	Description
200	The record after the update.

GET /certificate_manage/signRequest/

Returns the certificate signing requests generated on this appliance.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/signRequest/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /certificate_manage/signRequest/

Generates a key pair inside the hardware security module and produces a certificate signing request for submission to a certificate authority. Subject and key fields are listed under Parameters.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	Yes	Certificate description
common_name	string	Yes	Common name
organization_name	string	Yes	Organization name
organization_unit	string	Yes	Organization unit
country_code	string	Yes	Country code
state_province	string	Yes	State province
locality	string	Yes	Locality
email	string (email)	Yes	Email
key_algorithm	string	Yes	Key algorithm
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
key_usage	string	No	Key usage
eid	string	No	Eid

Example Request

curl -X POST "https://<your domain>/api/certificate_manage/signRequest/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certificate_description":"string","common_name":"string","organization_name":"string","organization_unit":"string","country_code":"string","state_province":"string","locality":"string","email":"string","key_algorithm":"string","created_user":1}'

Responses

Status Code	Description
201	The operation completed.

GET /certificate_manage/signRequest/{id}/

Returns one certificate signing request by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Example Request

curl -X GET "https://<your domain>/api/certificate_manage/signRequest/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /certificate_manage/signRequest/{id}/

Replaces the record. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	Yes	Certificate description
common_name	string	Yes	Common name
organization_name	string	Yes	Organization name
organization_unit	string	Yes	Organization unit
country_code	string	Yes	Country code
state_province	string	Yes	State province
locality	string	Yes	Locality
email	string (email)	Yes	Email
key_algorithm	string	Yes	Key algorithm
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
key_usage	string	No	Key usage
eid	string	No	Eid

Example Request

curl -X PUT "https://<your domain>/api/certificate_manage/signRequest/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certificate_description":"string","common_name":"string","organization_name":"string","organization_unit":"string","country_code":"string","state_province":"string","locality":"string","email":"string","key_algorithm":"string","created_user":1}'

Responses

Status Code	Description
200	The record after the update.

PATCH /certificate_manage/signRequest/{id}/

Updates selected fields. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this all_ certificates_ table.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name
certificate_description	string	Yes	Certificate description
common_name	string	Yes	Common name
organization_name	string	Yes	Organization name
organization_unit	string	Yes	Organization unit
country_code	string	Yes	Country code
state_province	string	Yes	State province
locality	string	Yes	Locality
email	string (email)	Yes	Email
key_algorithm	string	Yes	Key algorithm
isArchive	boolean	No	IsArchive
isActivate	boolean	No	IsActivate
created_user	integer	Yes	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
key_usage	string	No	Key usage
eid	string	No	Eid

Example Request

curl -X PATCH "https://<your domain>/api/certificate_manage/signRequest/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string","certificate_description":"string","common_name":"string","organization_name":"string","organization_unit":"string","country_code":"string","state_province":"string","locality":"string","email":"string","key_algorithm":"string","created_user":1}'

Responses

Status Code	Description
200	The record after the update.

PUT /certificate_manage/update_key_usage

Records what a certificate may be used for.

Request Body (application/json)

Field	Type	Required	Description
id	integer	Yes	Identifier of the certificate.
key_usage	string	Yes	Key usage to apply.

Example Request

curl -X PUT "https://<your domain>/api/certificate_manage/update_key_usage" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"id":1,"key_usage":"string"}'

Responses

Status Code	Description
200	The record after the update.

Certificates

GET /certificate_manage/activecerts/

GET /certificate_manage/certificateDetailsByName/{certificateName}/

POST /certificate_manage/certificateDetailsByName/{certificateName}/

GET /certificate_manage/certificate_names

POST /certificate_manage/certificate_status/active/

POST /certificate_manage/certificate_status/inactive/

GET /certificate_manage/certificates

POST /certificate_manage/certificates

GET /certificate_manage/certificates/{id}/

PUT /certificate_manage/certificates/{id}/

PATCH /certificate_manage/certificates/{id}/

GET /certificate_manage/certificatesTriggers/

POST /certificate_manage/certificatesTriggers/

GET /certificate_manage/certificatesTriggers/{id}/

PUT /certificate_manage/certificatesTriggers/{id}/

PATCH /certificate_manage/certificatesTriggers/{id}/

GET /certificate_manage/downloadCSR/

POST /certificate_manage/download_multiple_certificates/

GET /certificate_manage/downloadcertificate/

PUT /certificate_manage/edit_environment/{certificate_id}/

GET /certificate_manage/get_certificate_data/

GET /certificate_manage/importCertificate/

POST /certificate_manage/importCertificate/

GET /certificate_manage/importCertificate/{id}/

PUT /certificate_manage/importCertificate/{id}/

PATCH /certificate_manage/importCertificate/{id}/

GET /certificate_manage/mappedProjects/{certificate_id}/

POST /certificate_manage/mappedProjects/{certificate_id}/

GET /certificate_manage/selfSignCertificate/

POST /certificate_manage/selfSignCertificate/

GET /certificate_manage/selfSignCertificate/{id}/

PUT /certificate_manage/selfSignCertificate/{id}/

PATCH /certificate_manage/selfSignCertificate/{id}/

GET /certificate_manage/signRequest/

POST /certificate_manage/signRequest/

GET /certificate_manage/signRequest/{id}/

PUT /certificate_manage/signRequest/{id}/

PATCH /certificate_manage/signRequest/{id}/

PUT /certificate_manage/update_key_usage

On this Page: