Skip to content
Welly Welly Developers
Contact us
  1. API reference
  2. Utility

Utility

Endpoints that tell you about the API itself rather than about Welly's data.

Check the connection#

GEThttps://api.welly.no/v1/ping

Answers at once with a pong. Use it to check that your system reaches the API, for example in a health check. It needs no key and reads no data.

Authentication
None
Operation id
ping

Parameters

This endpoint takes no parameters.

Returns a ping object

  • objectstringRequired

    What this object is.

    "ping"
  • pongbooleanRequired

    Always true. If you can read it, you reached the API.

    true

Errors

StatusCodeWhen
405 method_not_allowed

The endpoint does not answer this method.

429 rate_limited

Too many requests.

500 internal_error

Something went wrong on our side. Try again; send us the request id if it lasts.
cURL 
curl https://api.welly.no/v1/ping
PHP and JavaScript examples come with the first SDKs.
Responses

200 The API is reachable.

{
  "object": "ping",
  "pong": true
}

The API is reachable.

405 The endpoint does not answer this method.

{
  "error": {
    "type": "invalid_request_error",
    "code": "method_not_allowed",
    "message": "This endpoint does not answer POST.",
    "param": null,
    "doc_url": "https://developer.welly.no/docs/errors#method_not_allowed",
    "request_id": "req_6b1d0c9e2f4a4d1c"
  }
}

The endpoint does not answer this method.

429 Too many requests.

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Too many requests. Wait for the time in Retry-After.",
    "param": null,
    "doc_url": "https://developer.welly.no/docs/errors#rate_limited",
    "request_id": "req_6b1d0c9e2f4a4d1c"
  }
}

Too many requests.

500 Something went wrong on our side. Try again; send us the request id if it lasts.

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An internal error occurred.",
    "param": null,
    "doc_url": "https://developer.welly.no/docs/errors#internal_error",
    "request_id": "req_6b1d0c9e2f4a4d1c"
  }
}

Something went wrong on our side. Try again; send us the request id if it lasts.