Skip to content
Pakyas

API Overview

Pakyas provides a RESTful HTTP API for all operations.

Base URLs

Section titled “Base URLs”
EnvironmentURL
Productionhttps://api.pakyas.com/api/v1
Ping Endpointhttps://ping.pakyas.com

Authentication

Section titled “Authentication”

API Keys

Section titled “API Keys”

Generate an API key from your organization settings. Include it in requests:

Terminal window
curl -H "Authorization: Bearer pk_live_xxx" \
  https://api.pakyas.com/api/v1/checks

JWT Tokens

Section titled “JWT Tokens”

For browser/CLI authentication, use JWT tokens obtained via login.

Endpoints

Section titled “Endpoints”

Ping API

Section titled “Ping API”
MethodEndpointDescription
GET/POST/ping/{public_id}Success ping
GET/POST/ping/{public_id}/startStart ping
GET/POST/ping/{public_id}/failFail ping
GET/POST/ping/{public_id}/{exit_code}Ping with exit code

Management API

Section titled “Management API”
MethodEndpointDescription
GET/checksList checks
POST/checksCreate check
GET/checks/{id}Get check
PUT/checks/{id}Update check
DELETE/checks/{id}Delete check

See individual endpoint pages for details.

Rate Limits

Section titled “Rate Limits”
  • Ping API: Unlimited
  • Management API: 1000 requests/minute per organization

Error Handling

Section titled “Error Handling”

Errors return JSON with error field:

{
  "error": "Check not found"
}

Next Steps

Section titled “Next Steps”