REST API Error Codes

Error Codes

Whenever there is an error processing your API request, the API will return a straightforward JSON error message carrying a success response object set to false, an error code as well as a text-based error type.

You will find an example error as well as a list of all possible error codes and messages below.

Example Error:

{
    "success": false,
    "error": {
        "code": 2803,
        "type": "certificate_not_found"
    }
}

Errors - General:

Error Code / Type Description
101
invalid_access_key
101 / invalid_access_key User has provided an invalid API access key.
103
invalid_api_function
103 / invalid_api_function User has provided an invalid API function.
2800
incorrect_request_type
2800 / incorrect_request_type User has made a non-supported API request.
2801
permission_denied
2801 / permission_denied User does not have the permissions to access this resource.
2802
missing_certificate_hash
2802 / missing_certificate_hash User has not provided a certificate ID (hash).
2803
certificate_not_found
2803 / certificate_not_found The given certificate ID (hash) could not be found.

Errors - Create Certiticate:

Error Code / Type Description
2804
cannot_issue_certificate_unpaid_upgrade_invoices
2804 / cannot_issue_certificate_unpaid_upgrade_invoices The current certificate cannot be issued due to unpaid invoices on user account.
2805
invalid_certificate_type
2805 / invalid_certificate_type User has provided an invalid certificate type.
2806
missing_certificate_type
2806 / missing_certificate_type User has not provided a valid certificate type.
2807
invalid_certificate_validity
2807 / invalid_certificate_validity User has not provided a valid certificate validity.
2808
invalid_certificate_domain
2808 / invalid_certificate_domain User has not provided one or more invalid certificate domains.
2809
wildcard_domains_not_allowed_in_multidomain_certificate
2809 / wildcard_domains_not_allowed_in_multidomain_certificate Wildcards cannot be included in multi-domain certificates.
2810
invalid_domains_in_multidomain_request
2810 / invalid_domains_in_multidomain_request User has not provided one or more invalid domains in multi-domain request.
2811
duplicate_domains_in_array
2811 / duplicate_domains_in_array User has not provided one or more duplicate domains.
2812
missing_certificate_domains
2812 / missing_certificate_domains User has not provided any certificate domains.
2813
cannot_replace_certificate_other_replacement_in_draft
2813 / cannot_replace_certificate_other_replacement_in_draft Only issued certificates can be renewed or replaced by a new certificate.
2814
permission_denied_on_original_certificate
2814 / permission_denied_on_original_certificate User does not have the permissions to access certificate to renew.
2815
original_certificate_not_active
2815 / original_certificate_not_active Only issued certificates can be renewed or replaced by a new certificate.
2816
cannot_find_original_certificate
2816 / cannot_find_original_certificate Certificate to renew was not found.
2817
certificate_limit_reached
2817 / certificate_limit_reached Limit of certificates on user account was reached.
2818
invalid_certificate_csr
2818 / invalid_certificate_csr User has not provided a valid CSR value.
2819
missing_certificate_csr
2819 / missing_certificate_csr User has not provided a CSR value.
2820
internal_error_failed_processing_csr
2820 / internal_error_failed_processing_csr Internal error processing CSR. Please contact support if this error occurs.
2821
internal_error_failed_creating_certificate
2821 / internal_error_failed_creating_certificate Internal error generating certificate. Please contact support if this error occurs.
2839
duplicate_certificates_found
2839 / duplicate_certificates_found Domain can no longer be protected using Free Plan, upgrade to Basic Plan required.

Errors - Verify Domains:

Error Code / Type Description
2822
failed_showing_certificate
2822 / failed_showing_certificate The requested certificate could not be retrieved.
2823
failed_validating_certificate
2823 / failed_validating_certificate Domain verification failed and must be retried.
2824
missing_validation_emails
2824 / missing_validation_emails User has not provided a validation email for each domain in certificate.
2825
missing_validation_email
2825 / missing_validation_email User has not provided a validation email for each domain in certificate.
2826
internal_error_while_valdating_domain_control
2826 / internal_error_while_valdating_domain_control Internal error verifying domains. Please contact support if this error occurs.
2827
invalid_validation_method
2827 / invalid_validation_method User has provided an in invalid domain verification method.
2828
missing_validation_method
2828 / missing_validation_method User has not provided a domain verification method.
2829
incorrect_certificate_validation_type
2829 / incorrect_certificate_validation_type User has provided an in invalid domain verification method or value.
2830
certificate_not_eligible
2830 / certificate_not_eligible The given certificate is not eligible for domain verification.
2831
certificate_not_ready_to_validate
2831 / certificate_not_ready_to_validate The given certificate is not ready for domain verification.

Errors - Download Certiticate:

Error Code / Type Description
2832
certificate_not_issued
2832 / certificate_not_issued The given certificate has not been issued yet.

Errors - Cancel Certiticate:

Error Code / Type Description
2833
certificate_cannot_be_cancelled
2833 / certificate_cannot_be_cancelled The given certificate cannot be cancelled due to its status.
2834
failed_cancelling_certificate
2834 / failed_cancelling_certificate Internal error cancelling certificate. Try again or contact support.

Errors - Delete Certiticate:

Error Code / Type Description
2835
certificate_cannot_be_deleted
2835 / certificate_cannot_be_deleted The given certificate cannot be deleted due to its status.
2836
failed_deleting_certificate
2836 / failed_deleting_certificate Internal error deleting certificate. Try again or contact support.

Errors - Resend Verification:

Error Code / Type Description
2837
failed_resending_email
2837 / failed_resending_email Internal error resending verification email. Try again or contact support.

Errors - Get Verification Status:

Error Code / Type Description
2838
failed_getting_validation_status
2838 / failed_getting_validation_status Error retrieveing domain verification status. Try again and make sure Email Verification is selected.