Service

These resources are public and are mainly for service discovery operations (identification and availability checks).

Information

GET /_info

Get the server public information, mainly to allow service discovery.

This entry point does not require any authentication.

Example request

curl https://rock-demo.obiba.org/_info

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "name": "rock-demo",
  "type": "rock",
  "tags": [
    "default"
  ]
}

Request Headers

Accept – */*

Response Headers

Content-Type – application/json

Status Codes

200 OK – Server is alive and functional.
500 Internal Server Error – Server is alive but not functional.

Check

GET /_check

Get whether the server is functional, to be used for periodic service availability checks. No content is returned, only the response status is meaningful: 200 OK is positive, whereas any other response indicates a problem.

This entry point does not require any authentication.

Example request

curl https://rock-demo.obiba.org/_check

Example response

HTTP/1.1 200 OK

Status Codes

200 OK – Server is alive and functional.
500 Internal Server Error – Server is alive but not functional.