Skip to main content
POST
/
orgs
/
{organization}
/
servers
/
{server}
/
sites
/
{site}
/
heartbeats
Create heartbeat
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/heartbeats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Heartbeat',
    'grace_period' => 2,
    'frequency' => 1,
    'custom_frequency' => '* * * * *'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
{
  "data": {
    "id": "<string>",
    "type": "heartbeats",
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    },
    "attributes": {
      "name": "<string>",
      "status": "pending",
      "grace_period": 1,
      "frequency": 1,
      "custom_frequency": "<string>",
      "ping_url": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://forge.laravel.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
organization
string
required

The organization slug

​
server
integer
required

The server ID

​
site
integer
required

The site ID

Body

application/json
​
name
string
required

The name of the heartbeat.

Maximum string length: 255
Example:

"My Heartbeat"

​
grace_period
enum<integer>
required

The duration (in minutes) after which a heartbeat is considered missing.

Available options:
1,
2,
5,
10,
30,
60
Example:

2

​
frequency
enum<integer>
required

The interval (in minutes) at which the client is expected to send a ping.

Available options:
1,
5,
10,
30,
60,
1440,
10080,
312480,
-1
Example:

1

​
custom_frequency
string

A cron expression representing the custom frequency at which the client is expected to send a ping, if the frequency is set to -1.

Example:

"* * * * *"

Response

HeartbeatResource

​
data
HeartbeatResource · object
required