Report Library API errors return both an HTTP status code and an error message. Errors caused by the client return a 4xx Client Error status code. Errors caused by the API service return a 5xx Server Error status code.
{
"code": "user_authentication_error",
"message": "User is not authenticated. Verify the API key in your request."
}| Name | Type | Description |
|---|---|---|
| errors | array | List of errors from the request. |
| .. code | string | Error code identifying a specific error. |
| .. message | string | Description of the error. |
| Status | Code | Description |
|---|---|---|
| 400 | disabled_report_type |
Report type disabled. API requests to edit a report or start a report run return this error if the report in the request is of a report type no longer enabled for the account. For a list of enabled report types, send a request to the List report types endpoint. For help reactivating report types, contact support. |
| 400 | missing_mandatory_field: {{variable}} |
The request is missing a required field. In the error response, {{variable}} returns the name of the required field. Update the field in the request and try again.
|
| 400 | invalid_date |
The run_until date is in the past. Submit another request with a run_until date in the future.
|
| 400 | invalid_column_identifiers |
One or more column_identifiers in the request are not supported for the chosen report_type. To get the column identifiers each report type supports, use the List columns endpoint.
|
| 400 | invalid_email |
The notification_emails parameter contains an invalid value.In the request body, make sure each object in the notification_emails array contains a valid user_id, first_name, last_name, and email that belongs to an admin user.
|
| 400 | invalid_filter |
Request contains one or more invalid filter. In the request body, make sure each filter object includes:
To get the filter and column identifiers each report type supports, use the List columns endpoint. For more information about filters, see Filters reference and examples. |
| 400 | invalid_limit | Invalid limit value. Pagination limits must be a positive integer. |
| 400 | invalid_offset | Invalid offset value. Pagination offset must be an integer greater than or equal to 0. |
| 400 | invalid_request: {{variable}} |
In the error code, the {{variable}} is replaced with the name of the field that contains an invalid value. Submit another request with a valid {{variable}} value.
|
| 400 | invalid_schedule |
The request includes an invalid schedule object.If frequency = WEEKLY, make sure your request includes a valid value for the repeat_every and weekday_to_run request parameters.If frequency = MONTHLY, make sure your request includes a valid value for the repeat_every and repeat_on request parameters. Also:
For examples of schedule objects with different structures, see How to build a report - Schedule report.
|
| 400 | invalid_sub_account_type |
The sub_account_filter_type request parameter contains an invalid value. For allowed values, check the reference documentation for the Create report or Edit report API endpoints. Also, make sure the request is not configured to omit data from both the parent account and all subaccounts. In other words, if the value of division_filter_type is EXCLUDE_ALL_DIVISIONS, the value of sub_account_filter_type cannot be EXCLUDE_ALL_SUB_ACCOUNTS.
|
| 400 | report_exists |
A report with this display_name value already exists. Submit another request with a unique display_name value.
|
| 400 | report_format_inapplicable |
The report type does not support one or more formats listed in the format array. For a list of formats each report type supports, use the List report types endpoint.
|
| 400 | report_not_found | The report with the given identifier does not exist. |
| 400 | invalid_report_type |
The report_type value is invalid. For a list of allowed report_type values, use the List report types endpoint.
|
| 401 | user_authentication_error | User associated with the API key is inactive, or the API key is missing or invalid. |
| 403 | user_forbidden | User missing required permissions. |
| 403 | custom_reports_not_enabled | Report Library is not enabled for the account. To request access to the Report Library, contact your DigiCert account manager. |
| 403 | report_type_not_found | Specified report type does not exist. To get a list of report types, use the List report types endpoint. |
| 404 | no_reports_found | No reports found with display names that match the name provided in your request. |
| 412 | json_response_size_exceeds_max | The JSON data for the report is too large to return in the API response. To get the data from this report run, use the Download report endpoint. |
| 412 | report_format_inapplicable | Report unavailable in the specified format. To get a list of formats you can request when downloading a generated report, use the Report details endpoint. |
| 412 | report_not_generated |
Report is still being generated. Try again when the report run status is READY.
|