Ping Endpoint

The ping endpoint accepts heartbeat signals from your jobs.

Base URL

https://ping.pakyas.com/ping/{public_id}

The public_id is the unique identifier for your check, shown in the dashboard.

Endpoints

Success Ping

Signal that a job completed successfully.

curl -fsS https://ping.pakyas.com/ping/{public_id}

Method	GET or POST
Response	200 OK

Start Ping

Signal that a job has started.

curl -fsS https://ping.pakyas.com/ping/{public_id}/start

Method	GET or POST
Response	200 OK

Fail Ping

Signal that a job has failed.

curl -fsS https://ping.pakyas.com/ping/{public_id}/fail

Method	GET or POST
Response	200 OK

Exit Code Ping

Signal completion with a specific exit code. Non-zero is treated as failure.

curl -fsS https://ping.pakyas.com/ping/{public_id}/1

Method	GET or POST
Response	200 OK
Path Parameter	Exit code (0-255)

Duration Tracking

For accurate duration measurement, send the measured time with your completion ping:

Header (recommended):

curl -H "X-Pakyas-Duration: 1523" https://ping.pakyas.com/ping/{id}

Query parameter:

curl "https://ping.pakyas.com/ping/{id}?duration=1523"

The server uses this value if provided, otherwise calculates duration from start/end timestamps.

Notes:

• Duration is only accepted on completion pings (success/fail), not start pings
• Must be a non-negative integer in milliseconds
• Maximum: 7 days (604,800,000 ms)
• Client-supplied duration is trusted; Pakyas does not verify it

Request Body

For POST requests, you can include a body with error details:

curl -X POST https://ping.pakyas.com/ping/{public_id}/fail \
  -H "Content-Type: text/plain" \
  -d "Error: Connection refused to database"

The body is stored and included in alerts. Maximum size: 10KB.

Response Codes

Code	Meaning
200	Ping accepted
404	Check not found
413	Body too large

Examples

From Cron

# Simple success ping
0 * * * * /path/to/job.sh && curl -fsS https://ping.pakyas.com/ping/{id}

# With start/success/fail
0 * * * * curl -fsS https://ping.pakyas.com/ping/{id}/start && /path/to/job.sh && curl -fsS https://ping.pakyas.com/ping/{id} || curl -fsS https://ping.pakyas.com/ping/{id}/fail

From Script

#!/bin/bash
curl -fsS https://ping.pakyas.com/ping/{id}/start

if ./my-job.sh 2>&1 | tee /tmp/output.log; then
  curl -fsS https://ping.pakyas.com/ping/{id}
else
  curl -fsS https://ping.pakyas.com/ping/{id}/fail -d @/tmp/output.log
fi

From Python

import requests

def ping_success(check_id):
    requests.get(f"https://ping.pakyas.com/ping/{check_id}")

def ping_fail(check_id, error_message):
    requests.post(
        f"https://ping.pakyas.com/ping/{check_id}/fail",
        data=error_message
    )

Reliability

• Pings are idempotent - sending the same ping multiple times is safe
• Timeout: 10 seconds recommended
• Retry: 1-2 retries on failure is recommended for critical jobs