Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong.

Status codes

Here is a list of the different categories of status codes returned by the GroundControl API. Use these to understand if a request was successful.

Name
2xx
Type
Description
A 2xx status code indicates a successful response.
Name
4xx
Type
Description
A 4xx status code indicates a client error — this means that either the resource doesn't exist or the parameters in the request are not valid. You should check the response for further information.
Name
5xx
Type
Description
A 5xx status code indicates a server error.

Error responses

Whenever a request is unsuccessful, the GroundControl API will return an error response with an errors object or a message attribute. You can use this information to understand better what has gone wrong and how to fix it.

Name
errors
Type
Description
This attribute is used when one or more parameters used in the request are not passing static validation.
Name
message
Type
Description
This attribute is used when there's a logical error while processing the request.

Error response

  {
    "errors": {
      "body.name": "is required"
    }
  }

Error response

  {
    "message": "Flag not found"
  }