Interface ProbesApi

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract ProbeEntry getProbe(@Path(value = "probeId") String probeId) Check readiness and liveness of the repository Note: this endpoint is available in Alfresco 6.0 and newer versions.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getProbe

        @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/probes/{probeId}") abstract ProbeEntry getProbe(@Path(value = "probeId") String probeId)

        Check readiness and liveness of the repository Note: this endpoint is available in Alfresco 6.0 and newer versions. Returns a status of 200 to indicate success and 503 for failure. The readiness probe is normally only used to check repository startup. The liveness probe should then be used to check the repository is still responding to requests. Note: No authentication is required to call this endpoint. The endpoint is owned by defaultname service owner

        Parameters:
        probeId - The name of the probe: * -ready- * -live- (required)