Documentation | CodeSign Secure

Method	Endpoint	Description
GET	/reports/certificate_report	Certificate report
GET	/reports/certificate_report/export	Export the certificate report
GET	/reports/client_report	Client report
GET	/reports/client_report/export	Export the client report
GET	/reports/daily-log	Daily log
GET	/reports/daily-log-file	Download the daily log
POST	/reports/daily-log/build-verification	Record a build verification result
GET	/reports/daily-log/export	Export the daily log
GET	/reports/expiry_certificates_graph/	Certificates by time to expiry
GET	/reports/key_algorithms_graph/	Certificates by key algorithm
GET	/reports/ksp_info/	Client usage summary
GET	/reports/log_report	Activity log
GET	/reports/log_report/export	Export the activity log
GET	/reports/signing_count_graph/	Signing volume by month
GET	/reports/signing_report	Signing report
GET	/reports/signing_report/export	Export the signing report
GET	/reports/syslog_file/	Download the system log

GET /reports/certificate_report

Returns the certificate inventory with validity dates and current state.

Request Parameters

Name	Located In	Type	Required	Description
from_date	Query	string (date)	No	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	No	End of the period, YYYY-MM-DD. The whole day is included.
environment_id	Query	array of integer (comma-separated)	No	Limit to these environments.
user_id	Query	array of integer (comma-separated)	No	Limit to items created by these users.
filters	Query	string	No	JSON array of {"field": .., "operator": .., "value": ..} objects, all of which must match. Fields: Certificate_Name, Algorithm, Environment_Name, Created_By, Created_Date, Expiry_Date. 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.
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/reports/certificate_report" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /reports/certificate_report/export

Returns the certificate report as a file.

Request Parameters

Name	Located In	Type	Required	Description
export_format	Query	string	No	File format to return: csv (default) or pdf.
from_date	Query	string (date)	Yes	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	Yes	End of the period, YYYY-MM-DD. The whole day is included.

Example Request

curl -X GET "https://<your domain>/api/reports/certificate_report/export?from_date=<from_date>&to_date=<to_date>" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /reports/client_report

Returns the signing clients that have connected, and how they were used.

Request Parameters

Name	Located In	Type	Required	Description
from_date	Query	string (date)	No	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	No	End of the period, YYYY-MM-DD. The whole day is included.

Example Request

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

Responses

Status Code	Description
200	The requested records.

GET /reports/client_report/export

Returns the client report as a file.

Request Parameters

Name	Located In	Type	Required	Description
export_format	Query	string	No	File format to return: csv (default) or pdf.
from_date	Query	string (date)	Yes	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	Yes	End of the period, YYYY-MM-DD. The whole day is included.

Example Request

curl -X GET "https://<your domain>/api/reports/client_report/export?from_date=<from_date>&to_date=<to_date>" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /reports/daily-log

Returns the appliance's day-to-day operational log.

Request Parameters

Name	Located In	Type	Required	Description
from_date	Query	string (date)	Yes	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	Yes	End of the period, YYYY-MM-DD. The whole day is included.
filters	Query	string	No	JSON array of {"field": .., "operator": .., "value": ..} objects, all of which must match. Fields: Severity, Date, Username, Source. 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.
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/reports/daily-log?from_date=<from_date>&to_date=<to_date>" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /reports/daily-log-file

Returns the daily log as a downloadable file.

Request Parameters

Name	Located In	Type	Required	Description
from_date	Query	string (date)	Yes	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	Yes	End of the period, YYYY-MM-DD. The whole day is included.

Example Request

curl -X GET "https://<your domain>/api/reports/daily-log-file?from_date=<from_date>&to_date=<to_date>" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /reports/daily-log/build-verification

Records the outcome of an origin or build verification check against the daily log, and notifies a recipient. Send as form data.

Request Body (application/json)

Field	Type	Required	Description
severity	string	Yes	INFO or Error, exactly as written.
message	string	Yes	Message to record.
email	string (email)	Yes	Recipient to notify.

Example Request

curl -X POST "https://<your domain>/api/reports/daily-log/build-verification" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"severity":"string","message":"string","email":"string"}'

Responses

Status Code	Description
201	The entry was recorded and the notification sent.

GET /reports/daily-log/export

Returns the daily log as a file.

Request Parameters

Name	Located In	Type	Required	Description
export_format	Query	string	No	File format to return: csv (default) or pdf.
from_date	Query	string (date)	Yes	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	Yes	End of the period, YYYY-MM-DD. The whole day is included.
filters	Query	string	No	JSON array of {"field": .., "operator": .., "value": ..} objects, all of which must match. Fields: Severity, Date, Username, Source. 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.

Example Request

curl -X GET "https://<your domain>/api/reports/daily-log/export?from_date=<from_date>&to_date=<to_date>" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /reports/expiry_certificates_graph/

Returns how many certificates expire within 7, 30, 60 and 90 days, and after that, as counts and percentages, for charting.

Request Parameters

Name	Located In	Type	Required	Description
from_date	Query	string (date)	No	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	No	End of the period, YYYY-MM-DD. The whole day is included.
environment_id	Query	array of integer (comma-separated)	No	Limit to these environments.
user_id	Query	array of integer (comma-separated)	No	Limit to items created by these users.

Example Request

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

Responses

Status Code	Description
200	The requested records.

GET /reports/key_algorithms_graph/

Returns how many certificates use each key algorithm, as counts and percentages, for charting.

Request Parameters

Name	Located In	Type	Required	Description
from_date	Query	string (date)	No	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	No	End of the period, YYYY-MM-DD. The whole day is included.
environment_id	Query	array of integer (comma-separated)	No	Limit to these environments.
user_id	Query	array of integer (comma-separated)	No	Limit to items created by these users.

Example Request

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

Responses

Status Code	Description
200	The requested records.

GET /reports/ksp_info/

Returns a summary of the signing clients registered against the licence.

Example Request

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

Responses

Status Code	Description
200	The requested records.

GET /reports/log_report

Returns the audit trail of actions taken on the appliance.

Request Parameters

Name	Located In	Type	Required	Description
from_date	Query	string (date)	No	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	No	End of the period, YYYY-MM-DD. The whole day is included.
application_id	Query	array of integer (comma-separated)	No	Limit to these applications.
environment_id	Query	array of integer (comma-separated)	No	Limit to these environments.
user_id	Query	array of integer (comma-separated)	No	Limit to items created by these users.
category	Query	array of string (comma-separated)	No	Limit to these activity categories, for example User Management.
filters	Query	string	No	JSON array of {"field": .., "operator": .., "value": ..} objects, all of which must match. Fields: Event_Time, Category. 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.
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/reports/log_report" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /reports/log_report/export

Returns the activity log as a file.

Request Parameters

Name	Located In	Type	Required	Description
export_format	Query	string	No	File format to return: csv (default) or pdf.
from_date	Query	string (date)	Yes	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	Yes	End of the period, YYYY-MM-DD. The whole day is included.

Example Request

curl -X GET "https://<your domain>/api/reports/log_report/export?from_date=<from_date>&to_date=<to_date>" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /reports/signing_count_graph/

Returns the number of completed signings in each month of the current year, for charting.

Request Parameters

Name	Located In	Type	Required	Description
from_date	Query	string (date)	No	Count only signings on or after this date, YYYY-MM-DD. Applies only when to_date is also sent.
to_date	Query	string (date)	No	Count only signings on or before this date, YYYY-MM-DD. Applies only when from_date is also sent.
job_id	Query	integer	No	Limit to one signing job, by its identifier.
environment_id	Query	array of integer (comma-separated)	No	Limit to these environments.
certificate_name	Query	array of string (comma-separated)	No	Limit to these certificates.
user_id	Query	array of integer (comma-separated)	No	Limit to items created by these users.

Example Request

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

Responses

Status Code	Description
200	The requested records.

GET /reports/signing_report

Returns signing activity: who signed what, with which certificate, in which environment, and whether it succeeded.

Request Parameters

Name	Located In	Type	Required	Description
from_date	Query	string (date)	No	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	No	End of the period, YYYY-MM-DD. The whole day is included.
job_id	Query	integer	No	Limit to one signing job, by its identifier.
environment_id	Query	array of integer (comma-separated)	No	Limit to these environments.
certificate_name	Query	array of string (comma-separated)	No	Limit to these certificates.
user_id	Query	array of integer (comma-separated)	No	Limit to items created by these users.
filters	Query	string	No	JSON array of {"field": .., "operator": .., "value": ..} objects, all of which must match. Fields: Job_ID, Environment_Name, Certificate_Name, Submitted_By, Submitted_On, Approval_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. Approval_Status takes only equals, with a state name (Failed, Pending, Approved, Signed, Rejected, Expired) or its number, -1 to 4.
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/reports/signing_report" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /reports/signing_report/export

Returns the signing report as a file.

Request Parameters

Name	Located In	Type	Required	Description
export_format	Query	string	No	File format to return: csv (default) or pdf.
from_date	Query	string (date)	Yes	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	Yes	End of the period, YYYY-MM-DD. The whole day is included.

Example Request

curl -X GET "https://<your domain>/api/reports/signing_report/export?from_date=<from_date>&to_date=<to_date>" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /reports/syslog_file/

Returns the system log as a downloadable file.

Request Parameters

Name	Located In	Type	Required	Description
from_date	Query	string (date)	No	Start of the period, YYYY-MM-DD.
to_date	Query	string (date)	No	End of the period, YYYY-MM-DD. The whole day is included.

Example Request

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

Responses

Status Code	Description
200	The requested records.

Reports

GET /reports/certificate_report

GET /reports/certificate_report/export

GET /reports/client_report

GET /reports/client_report/export

GET /reports/daily-log

GET /reports/daily-log-file

POST /reports/daily-log/build-verification

GET /reports/daily-log/export

GET /reports/expiry_certificates_graph/

GET /reports/key_algorithms_graph/

GET /reports/ksp_info/

GET /reports/log_report

GET /reports/log_report/export

GET /reports/signing_count_graph/

GET /reports/signing_report

GET /reports/signing_report/export

GET /reports/syslog_file/

On this Page: