Healthcheck if API Key is working
curl --request GET \
--url https://api.offerclub.io/v1.0/health \
--header 'x-api-key: <api-key>'import requests
url = "https://api.offerclub.io/v1.0/health"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.offerclub.io/v1.0/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.offerclub.io/v1.0/health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.offerclub.io/v1.0/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.offerclub.io/v1.0/health")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.offerclub.io/v1.0/health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "ok",
"timestamp": "2026-06-06T12:00:00.000Z",
"deployId": "a1b2c3d4e5f6g7h8"
}{
"statusCode": 400,
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"errors": [
"email must be a string"
]
}
}{
"statusCode": 400,
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"errors": [
"email must be a string"
]
}
}{
"statusCode": 400,
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"errors": [
"email must be a string"
]
}
}Healthcheck
Healthcheck if API Key is working
GET
/
v1.0
/
health
Healthcheck if API Key is working
curl --request GET \
--url https://api.offerclub.io/v1.0/health \
--header 'x-api-key: <api-key>'import requests
url = "https://api.offerclub.io/v1.0/health"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.offerclub.io/v1.0/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.offerclub.io/v1.0/health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.offerclub.io/v1.0/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.offerclub.io/v1.0/health")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.offerclub.io/v1.0/health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "ok",
"timestamp": "2026-06-06T12:00:00.000Z",
"deployId": "a1b2c3d4e5f6g7h8"
}{
"statusCode": 400,
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"errors": [
"email must be a string"
]
}
}{
"statusCode": 400,
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"errors": [
"email must be a string"
]
}
}{
"statusCode": 400,
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"errors": [
"email must be a string"
]
}
}Authorizations
API key for authentication (can be generated in the settings)
Response
Just a healthcheck
The status of the health check
Example:
"ok"
The timestamp of the health check
Example:
"2026-06-06T12:00:00.000Z"
Opaque identifier of the current deploy. Set by CI at image-build time and used by the deploy pipeline to detect when a new image is serving. Carries no source-code info — "unknown" when running outside of a CI-built image.
Example:
"a1b2c3d4e5f6g7h8"
Was this page helpful?
⌘I