1. system
AFAX-v4
  • AFAX API V4
    • Documents
    • oauth
      • /oauth/token
    • faxes
      • /faxes
      • /faxes/binary
      • /faxes/{rfid}/cancel
      • /faxes
      • /faxes/{rfid}
      • /faxes/{rfid}/media
      • /faxes/{rfid}
    • webhooks
      • /webhooks
      • /webhooks
      • /webhooks/signing-secret
      • /webhooks/signing-secret
      • /webhooks/signing-secret/rotate
      • /webhooks/{id}
      • /webhooks/{id}
      • /webhooks/{id}/deliveries
      • /webhooks/{id}/rotate-secret
    • system
      • /system/health
        GET
    • Schemas
      • Webhook.WriteRequest
      • Webhook.Created
      • Webhook.AFAXWebhook
      • Webhook.SecretCreated
      • Webhook.SecretStatus
      • Webhook.Delivery
      • FaxSubmission.CreateFaxRequest
      • FaxSubmission.FaxSender
      • FaxSubmission.FaxRecipient
      • FaxSubmission.FaxDocumentSource
      • FaxSubmission.FaxCoverPage
      • FaxSubmission.CreateFaxResponse
      • FaxSubmission.FaxResourceLinks
      • FaxResult.FaxResult
      • FaxResult.FaxDocumentTotals
      • FaxResult.FaxOutcome
      • FaxResult.FaxResultPage
      • FaxResult.FaxLifecycleResponse
      • Auth.TokenResponse
  1. system

/system/health

GET
/system/health

Request

None

Responses

🟢200
application/json
Successful response
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.faxlink.ca/afx/v4//system/health'
Response Response Example
{
    "value": "string"
}
Modified at 2026-09-15 22:26:45
Previous
/webhooks/{id}/rotate-secret
Next
Webhook.WriteRequest
Built with