ATatlassian
Heartbeats

Ping Heartbeat (PATCH)

Changed on

Pings the heartbeat with given name. Heartbeat ping requests processed asynchronously, it does not check if the heartbeat exists or not before responding. Please note that receiving a PONG response does not necessarily mean that the heartbeat exists.

patch/api/{cloudId}/v1/teams/{teamId}/heartbeats/ping

Request

  • Base URL
    https://api.atlassian.com/jsm/ops
  • URL
    https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/heartbeats/ping
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.stg.atlassian.com/authorize
      Token URL: https://auth.stg.atlassian.com/oauth/token scopes: read:ops-config:jira-service-management, write:ops-config:jira-service-management

Path parameters

teamIdstring required

Identifier of the heartbeat owning team.

Query parameters

namestring required

Name of the heartbeat for identification.

Response

Returned if the request is successful.

messagestring

Example response

{
  "message": "PONG - Heartbeat received"
}

Changes