5.5 API Failure Handling

The following table provides the API Failure response codes and error messages:

Table 5-3 API Failure Response Codes and Error Messages

Status Error Code Typical Cause
400 INVALID_INPUT Request validation failed, a required field is missing or invalid, an unsupported enum value was supplied, DER key encoding was requested, or the renew request name does not match the path name.
400 MISSING_CERT_TO_BE_RENEWED Renew request does not include a non-blank oldCertificate value.
400 MAX_CERT_LIMIT_REACHED The maximum number of accepted certificate creation requests has been reached.
404/500 IO_READ_ERROR Retrieve could not find the generated certificate/key after waiting, or the generated file exists but could not be read.
409 ERR_REQUEST_REJECTED Certificate creation job was rejected during scheduling.
500 INVALID_CONFIG Required runtime or issuer configuration is missing or invalid.
500 CMP_COMMAND_FAILED CMP request failed or Operator CA rejected the request.
500 CMP_COMMAND_TIMEOUT CMP request timed out.
500 PROCESS_START_FAILURE CMP command process could not be started.

Problem responses use a common JSON schema:

{
  "title": "Invalid input",
  "status": 400,
  "detail": "Invalid input",
  "errorCode": "INVALID_INPUT",
  "invalidParams": []
}