Skip to main content
The Upsun API uses standard HTTP status codes to indicate the success or failure of a request.

​
Status codes

CodeStatusDescription
200OKRequest succeeded. Response body contains the requested resource.
201CreatedResource created successfully. Response body contains the new resource.
204No ContentRequest succeeded with no response body (typically for deletions).
400Bad RequestInvalid request parameters or body. Check the error message for details.
401UnauthorizedMissing or expired access token. Re-authenticate and retry.
403ForbiddenValid token but insufficient permissions for the requested action.
404Not FoundThe requested resource does not exist.
409ConflictResource already exists or a state conflict prevents the action.

​
HAL response structure

Successful responses use the HAL (Hypertext Application Language) format. Most responses include:

​
_links

Most GET endpoints return a _links object defining available actions on the resource. The self key contains a fully qualified URL and an OpenAPI schema reference. Additional keys use fragment identifiers (e.g., #edit, #delete) to describe available operations: 
{
  "_links": {
    "self": {
      "href": "/api/projects/abcdefghij1234567890",
      "meta": { ... }
    },
    "#delete": {
      "href": "/api/projects/abcdefghij1234567890",
      "meta": {
        "delete": {
          "responses": { ... },
          "parameters": []
        }
      }
    }
  }
}

​
_embedded

Requests to endpoints which create or modify objects, such as POST, PATCH, or DELETE requests, include an _embedded key in their response. It contains the created or modified object, identical to what would be returned by a subsequent GET request for that resource.
Last modified on March 6, 2026