Skip to content
BudSense Partner API - prod

Health check endpoint

GET
/v1/service/health
curl --request GET \
  --url https://example.com/v1/service/health

This endpoint is used to verify that the service is up and running.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”
Media typeapplication/json
object
status
required
string
timestamp
required
integer
Examplegenerated
{
  "status": "example",
  "timestamp": 1
}

Headers

Section titled “ Headers ”
Access-Control-Allow-Origin
string
default: *
Example
*

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

401

Section titled “ 401 ”
Media typeapplication/json
object
body
required
code
required
integer
message
required
string
suggestion
required
string
title
required
string
Examplegenerated
{
  "body": "example",
  "code": 1,
  "message": "example",
  "suggestion": "example",
  "title": "example"
}

Headers

Section titled “ Headers ”
Access-Control-Allow-Origin
string
default: *
Example
*

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

500

Section titled “ 500 ”
Media typeapplication/json
object
body
required
code
required
integer
message
required
string
suggestion
required
string
title
required
string
Examplegenerated
{
  "body": "example",
  "code": 1,
  "message": "example",
  "suggestion": "example",
  "title": "example"
}

Headers

Section titled “ Headers ”
Access-Control-Allow-Origin
string
default: *
Example
*

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link