Sign inTry Free

Data API Error Handling

Warning

SingleStore 9.0 gives you the opportunity to preview, evaluate, and provide feedback on new and upcoming features prior to their general availability. In the interim, SingleStore 8.9 is recommended for production workloads, which can later be upgraded to SingleStore 9.0.

On successful processing of SingleStore's Data API requests, the server returns the 200 OK HTTP status line. On Data API request failure, the server returns a status code for the error along with a message describing the issue. The error messages are returned as bare strings in the response body.

The following table provides a list of HTTP response status codes that are used for handling errors in SingleStore’s Data API requests.

HTTP Status Code

Description

400 Bad Request

A general error code used for client request issues for reasons, such as:

  • Request body is not JSON

  • Request body does not match the input schema

  • SQL is malformed

  • Context database does not exist

401 Unauthorized

  • Invalid authentication credentials

  • Authentication failed

When using JWTs to authenticate, this error code may indicate the following issues:

  • The specified JWT is invalid

  • Invalid JWT signature, i.e., the JWT signature cannot be verified using JWKS fetched from the engine

403 Forbidden

Authorization error from SingleStore

404 Not Found

Path not found

405 Method Not Allowed

Incorrect HTTP method used for the endpoint specified

408 Request Timeout

Timeout while waiting for the client to provide a complete request with the headers and the JSON body

500 Internal Server Error

A general error code used to handle many different error conditions and are generally considered unexpected. For example, you might receive this error if some of your data partitions are offline during a query or if the HTTP service is unable to communicate with the underlying SingleStore node.

504 Gateway Timeout

Timeout while communicating with the underlying SingleStore node

Last modified: January 25, 2023

Was this article helpful?

Was this article helpful?

Verification instructions

Note: You must install cosign to verify the authenticity of the SingleStore file.

Use the following steps to verify the authenticity of singlestoredb-server, singlestoredb-toolbox, singlestoredb-studio, and singlestore-client SingleStore files that have been downloaded.

You may perform the following steps on any computer that can run cosign, such as the main deployment host of the cluster.

  1. (Optional) Run the following command to view the associated signature files.

    curl undefined

  2. Download the signature file from the SingleStore release server.

    • Option 1: Click the Download Signature button next to the SingleStore file.

    • Option 2: Copy and paste the following URL into the address bar of your browser and save the signature file.

    • Option 3: Run the following command to download the signature file.

      curl -O undefined

  3. After the signature file has been downloaded, run the following command to verify the authenticity of the SingleStore file.

    echo -n undefined |
        cosign verify-blob --certificate-oidc-issuer https://oidc.eks.us-east-1.amazonaws.com/id/CCDCDBA1379A5596AB5B2E46DCA385BC \
          --certificate-identity https://kubernetes.io/namespaces/freya-production/serviceaccounts/job-worker \
          --bundle undefined \
          --new-bundle-format -
    Verified OK