Site unknown

Status #

404

Meaning #

The API responds with ‘Site unknown’ if you’ve executed a request against the route …

• /hybrid-core/v1/sites/:site_id
• /hybrid-core/v1/sites/:site_id/assets
• /hybrid-core/v1/sites/:site_id/assets/:asset_id
• /hybrid-core/v1/sites/:site_id/resources

and the path value for parameter site_id server-side didn’t led to a hit. Finally, you get that response, if the hybrid core site or it’s asset(s) or it’s resources view you’ve requested by it’s ID doesn’t exist.

Semantically the response status code is equivalent to the HyperText Transfer Protocol (HTTP) 404 Not Found response status code. It indicates that the server can’t find the requested resource. Links that lead to a 404 page are often called broken or dead links and can be subject to link rot.

On the one hand the 404 error is an error which is interpreted as a server-side problem. On the other hand, from the technical view the error belongs to a client-side issue, because at the moment when the request is fired by the client he should be aware about the existing site he is retrieving information about and it isn’t the fault of the server if the inquired site isn’t present. This is the reason why this type of error is categorized within the scope of client-side (4xx) responses.

Request #

GET https://api.gridscale.io/hybrid-core/v1/sites/xx01

Response #

Header:

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
...

Body:

{
  "errors": [
    {
      "type": "https://my.gridscale.io/docs/apis/problems/hybrid-core/v1/site-unknown",
      "title": "Site unknown",
      "status": 404,
      "detail": "The site with ID 'xx01' is unknown.",
      "DocURL": "https://my.gridscale.io/docs/apis/hybrid-core/v1/introduction",
    }
  ]
}