HealthCheck

In order to use this healthcheck endpoint:

• Check that your clientId is authorized to your tenant in the Visma Developer Portal
• Check that your clientId is authorized to at least any of these scopes (upload,list,download,delete) in the Visma Developer Portal
• Use a valid authorization token from Visma Connect
• Create a Get request to the method’s /healthcheck URI

Example - healthcheck Request

GET v1.0/healthcheck
HTTP/1.1
Host: fileapi.youforce.com
Authorization: Bearer xxxxxxxxx

If the request succeeds, the response includes a 200 OK HTTP status code, along with a JSON object that contains the general status of the File API and the status of each endpoint.

The possible values for the general status of the service are:

• Operational: When the status of all the endpoints is “healthy”
• Major Outage: When the status of any of the most frequently used endpoints is “unhealthy”. These endpoints are:
  • Publisher UploadMultipart
  • Subscriber Delivery
  • Subscriber List
  • Subscriber Download
• Partial Outage: When the status of the most frequently used endpoints is “healthy” but the status of any of the less frequently used endpoints is “unhealthy”. These endpoints are:
  • Publisher UploadResumable
  • Publisher List
  • Publisher Download
  • Subscriber DownloadByChunks
  • Subscriber Delete

Example - Successful response of Healhcheck endpoint

HTTP/1.1 200
{
    "status": "Operational",
    "publisher": {
        "list": {
            "status": "Healthy",
            "checkedAt": "2024-10-22T16:21:06Z"
        },
        "uploadMultipart": {
            "status": "Healthy",
            "checkedAt": "2024-10-22T16:21:02Z"
        },
        "uploadResumable": {
            "status": "Healthy",
            "checkedAt": "2024-10-22T16:21:02Z"
        },
        "download": {
            "status": "Healthy",
            "checkedAt": "2024-10-22T16:21:01Z"
        }
    },
    "subscriber": {
        "delivery": {
            "status": "Healthy",
            "checkedAt": "2024-10-22T16:21:03Z"
        },
        "list": {
            "status": "Healthy",
            "checkedAt": "2024-10-22T16:21:02Z"
        },
        "download": {
            "status": "Healthy",
            "checkedAt": "2024-10-22T16:21:03Z"
        },
        "downloadByChunks": {
            "status": "Healthy",
            "checkedAt": "2024-10-22T16:21:03Z"
        },
        "delete": {
            "status": "Healthy",
            "checkedAt": "2024-10-22T16:21:03Z"
        }
    }
}