Health API Reference

Introduction

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

Requirements

Calling this API endpoint requires an API Key and API ID. See Getting Started with PerformYard API for details on creating API keys and API Authentication for authentication flow.

Checking PerformYard REST API Health

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

Returns some basic information about the health of PerformYard's REST API.

CURL Example

curl --location -X GET "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 (200)

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