Skip to main content

Status API

This set of endpoints is used to determine the status of an instance. This is useful when conducting some maintenance activities.

All three of the endpoints below require that the port is available and Java is running.

Note

These checks only relay Nexus Repository's state and are not hardware checks. They do not validate whether an external database is functional/reachable or if disk access is available; those tasks require dedicated monitoring software. Nexus Repository can only report on its own internal state.

Status Endpoint

GET /service/rest/v1/status

This endpoint validates that the server can respond to read requests.

Curl Example

curl -X GET http://localhost:8081/service/rest/v1/status

The response code contains the information. A 200 indicates the instance can serve read requests, a 503 otherwise.

Writable Endpoint

GET /service/rest/v1/status/writable

This endpoint validates that server can respond to read and write requests (i.e., that Nexus Repository is not in read-only mode).

Curl Example

curl -X GET http://localhost:8081/service/rest/v1/status/writable

The response code contains the information. A 200 indicates the instance can serve write and read requests, a 503 otherwise.

Check Endpoint

GET /service/rest/v1/status/check

This endpoint returns the results of the system status checks.

Curl Example

curl -X GET http://localhost:8081/service/rest/v1/status/check

The response contains the system status check results, such as in the example below:

Note

These results are also available in the user interface under Administration → Support → Status.

Click here to expand...

{
  "additionalProp1": {
    "healthy": true,
    "message": "string",
    "error": {
      "cause": "string",
      "stackTrace": [
        {
          "methodName": "string",
          "fileName": "string",
          "lineNumber": 0,
          "className": "string",
          "nativeMethod": true
        }
      ],
      "message": "string",
      "localizedMessage": "string",
      "suppressed": [
        "string"
      ]
    },
    "details": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "time": 0,
    "duration": 0,
    "timestamp": "string"
  },
  "additionalProp2": {
    "healthy": true,
    "message": "string",
    "error": {
      "cause": "string",
      "stackTrace": [
        {
          "methodName": "string",
          "fileName": "string",
          "lineNumber": 0,
          "className": "string",
          "nativeMethod": true
        }
      ],
      "message": "string",
      "localizedMessage": "string",
      "suppressed": [
        "string"
      ]
    },
    "details": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "time": 0,
    "duration": 0,
    "timestamp": "string"
  },
  "additionalProp3": {
    "healthy": true,
    "message": "string",
    "error": {
      "cause": "string",
      "stackTrace": [
        {
          "methodName": "string",
          "fileName": "string",
          "lineNumber": 0,
          "className": "string",
          "nativeMethod": true
        }
      ],
      "message": "string",
      "localizedMessage": "string",
      "suppressed": [
        "string"
      ]
    },
    "details": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "time": 0,
    "duration": 0,
    "timestamp": "string"
  }
}