Responses

In case the request is successful, the body of the response is usually returned in the form of a JSON object. The exception to this is the processing of DELETE requests. This causes the HTTP 204 status to succeed and the response body to be empty.

Within this JSON object, the resource root that was the target of the request is set as the key. This is the singular word when the request is applied to a single object, and the plural word when the collection is processed.

For example, sending a GET request to /v1/stacklets/$STACKLET_ID will return an object with a key named "stacklet". However, if you send a GET request to a general collection at /v1/stacklets, you will get an object with a key named "stacklet".

The values ​​for these keys are usually single-object JSON objects and an array of objects for a request on a collection of objects.

Example

Response for a Single Object

{
  "stacklet": {
    "name": "example.com"
    . . .
  }
}

Response for an Object Collection

{
  "stacklets": [
    {
      "name": "example.com"
      . . .
    },
    {
      "name": "second.com"
      . . .
    }
  ]
}