API Reference
Get health
GET
/
health
JavaScript
import CompaniesSocial from '@alloy.rest/companies.social';
const client = new CompaniesSocial();
const response = await client.health.check();
console.log(response.status);package main
import (
"context"
"fmt"
"github.com/alloy-rest/companies.social-sdk-go"
"github.com/alloy-rest/companies.social-sdk-go/option"
)
func main() {
client := companiessocial.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Health.Check(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Status)
}
{
"status": "<string>"
}Response
200 - application/json
Service health check
Was this page helpful?
⌘I
JavaScript
import CompaniesSocial from '@alloy.rest/companies.social';
const client = new CompaniesSocial();
const response = await client.health.check();
console.log(response.status);package main
import (
"context"
"fmt"
"github.com/alloy-rest/companies.social-sdk-go"
"github.com/alloy-rest/companies.social-sdk-go/option"
)
func main() {
client := companiessocial.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Health.Check(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Status)
}
{
"status": "<string>"
}