Account

Health check

GET/v1/ping

Returns immediately if the API is up. No authentication required and not metered — safe to poll from a load balancer, uptime monitor, or status dashboard without affecting your usage.

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

Query parameters

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Responses

Successful Response

application/json

Response Ping V1 Ping Headfields returned to you

Type: object

GET/v1/ping

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/ping' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{}

Successful Response200

application/json