NInixopus
Health Checks

Toggle health check

Changed on

Toggle health check.

Auth: Required (bearer token). Scope: Organization-scoped in authenticated context. Side effects: May mutate server state.

patch/api/v1/healthcheck/toggle

Request

  • Base URL
    http://:8080
  • URL
    http://:8080/api/v1/healthcheck/toggle
  • Auth
    none declared

Headers

Acceptstring

Request body */*

application_idstring uuid required

ID of the application to toggle health check for

enabledboolean

Whether the health check should be enabled

Example request

{
  "application_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response

OK

messagestring
statusstring

Changes

  • 09f18af670c4Revision changes
    • info

      api tag Health Checks added

    • info

      api tag api/v1/healthcheck removed

    • info

      api tag toggle removed

  • 2beb810c5221Revision changes
    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • info

      api operation id patchToggle removed and replaced with toggleHealthCheck

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/xml)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)