Health API Reference

Introduction

This API provides health status or availability for the PerformYard API.

Checking the Availability of the PerformYard REST API

This API endpoint allows checking that the API is available and responsive.

HTTP GET

https://api.talent.performyard.com/health

CURL Example

curl --location 'https://api.talent.performyard.com/health' \ --header 'Accept: application/json' \ --header 'x-api-id: {{X-API-ID}}' \ --header 'x-api-key: {{X-API-KEY}}'

Response 

HTTP 200 OK

Body

{ 
    "healthy": "<boolean>", 
    "gitHash": "<string>", 
    "gitHashShort": "<string>", 
    "gitBranch": "<string>", 
    "environment": "<string>" 
}