Errors

Let's learn more about the RocketCAD API Errors & Error Codes you may encounter when building.

The RocketCAD API takes advantage of conventional HTTP response codes to indicate the success or failure of an API request in addition to our built-in error codes to assist you in building your integration.

In general: Codes in the 2XX range indicate success whereas codes in the 4XX range indicate failure in the information provided (ie; a missing API Key or other required body parameter). Failures in the 5XX range indicate a server-side failure with RocketCAD, and are rare.

Example: 200

{
    "status": "success",
    "response": {
        "success": true,
        "message": "This API Key is valid & associated with an active community."
        "requestID": "OLV213JN6XL1BLS"
    }
}

This is an example response from the Ping API Endpoint.

Example: 400

{
    "statusCode": 400,
    "body": {
        "status": "MISSING_DATA",
        "message": "Missing parameter for workflow ping: parameter api_key"
    }
}

This is an example response from the Ping API Endpoint.

Example: 404

{
    "statusCode": 404,
    "body": {
        "status": "NOT_FOUND",
        "message": "Workflow not found ping"
    }
}

This is an example response from the Ping API Endpoint.

Common RocketCAD Errors

In addition to conventional HTTP response codes, RocketCAD has a built-in error code system designed to assist you in troubleshooting.

In general: Codes in the 1XX range will indicate an API Key issue (ie; missing permissions, invalid key) and codes in the 2XX range will indicate a Rate Limiting issue (ie; you've been rate limited, are approaching a rate limit)

Example: 1A

{
    "status": "success",
    "response": {
        "success": false,
        "message": "The provided API Key is not valid or lacks permissions. modcol.co/e1a",
        "requestID": "3KUXZ1KUNUDJN7S"
    }
}

This is an example response from the Ping API Endpoint

Example 2A

{
    "status": "success",
    "response": {
        "success": false,
        "message": "This API Key has been rate limited, please try your request again in a moment. modcol.co/e2a",
        "requestID": "IU7DRSTYVNLLA2V"
    }
}

This is an example response from the Ping API Endpoint

To better troubleshoot an individual error, see the endpoint's documentation.