diff --git a/api-ref/source/diagnostics.inc b/api-ref/source/diagnostics.inc index 64ae109a72..0a03876efe 100644 --- a/api-ref/source/diagnostics.inc +++ b/api-ref/source/diagnostics.inc @@ -1,7 +1,4 @@ .. -*- rst -*- -.. needs:parameter_verification -.. needs:example_verification -.. needs:body_verification ============================================ Servers diagnostics (servers, diagnostics) @@ -16,7 +13,9 @@ Show Server Diagnostics Shows basic usage data for a server. -Policy defaults enable only users with the administrative role. Cloud providers can change these permissions through the ``policy.json`` file. +Policy defaults enable only users with the administrative role. Cloud +providers can change these permissions through the ``policy.json`` +file. Normal response codes: 200 @@ -33,8 +32,13 @@ Request Response -------- -**Example Server diagnostics: JSON response** +The response format for diagnostics is backend hypervisor specific, +and not well defined. This should be considered a debug interface +only, and not relied upon by programmatic tools. + +**Example Server diagnostics** + +Below is an example of diagnostics for a libvirt based server instance. .. literalinclude:: ../../doc/api_samples/os-server-diagnostics/server-diagnostics-get-resp.json :language: javascript -