REST API

Probes Endpoint

Updated: October 14, 2024

Get All Probes Information

GET /management/probes

Response

If successful, returns a JSON representation of all probes information.

Status Codes

  • 200 _OK_ - Success.

Sample

curl -u Administrator:Administrator \ http://localhost:8080/nuxeo/api/v1/management/probes
{ "entity-type": "probes", "entries": [ { "name": "ldapDirectories", "status": { "neverExecuted": true, "success": false, "infos": { "info": "[unavailable]" } }, "history": { "lastRun": null, "lastSuccess": "1970-01-01T00:00:00", "lastFail": "1970-01-01T00:00:00" }, "counts": { "run": 0, "success": 0, "failure": 0 }, "time": 0 }, ...other happy probes... ] }

Get Probe Information

GET /management/probes/PROBE_NAME

Path Parameters

Parameter Name Type Description Notes
PROBE_NAME string The probe name. Optional

If no PROBE_NAME is passed, return all probes information, see Get All Probes Information.

Response

If successful, returns a JSON representation of the requested probe information.

Status Codes

  • 200 _OK_ - Success.
  • 404 Not Found - Probe with the given PROBE_NAME does not exist.

Sample

curl -u Administrator:Administrator \ http://localhost:8080/nuxeo/api/v1/management/probes/ldapDirectories
{ "name": "ldapDirectories", "status": { "neverExecuted": true, "success": false, "infos": { "info": "[unavailable]" } }, "history": { "lastRun": null, "lastSuccess": "1970-01-01T00:00:00", "lastFail": "1970-01-01T00:00:00" }, "counts": { "run": 0, "success": 0, "failure": 0 }, "time": 0 }

Run a Probe

POST /management/probes/PROBE_NAME

Path Parameters

Parameter Name Type Description
PROBE_NAME string The probe name.

Response

If successful, returns a JSON representation of the run probe information.

Status Codes

  • 200 _OK_ - Success.
  • 404 Not Found - Probe with the given PROBE_NAME does not exist.

Sample

curl -X POST -u Administrator:Administrator \ http://localhost:8080/nuxeo/api/v1/management/probes/ldapDirectories
{ "name": "ldapDirectories", "status": { "neverExecuted": false, "success": true, "infos": { "info": "No configured LDAP directory" } }, "history": { "lastRun": "2019-10-31T16:45:49.514", "lastSuccess": "2019-10-31T16:45:49.514", "lastFail": "1970-01-01T00:00:00" }, "counts": { "run": 1, "success": 1, "failure": 0 }, "time": 1 }