The Availability API (formerly the Maintenance API) is a REST API endpoint on the FRAGTrack™ Customer API. It allows customers to inform the FRAGTrack™ cloud about the known availability periods of the installation to which the FRAGTrack™ device is connected.
This webhook into the FRAGTrack™ cloud allows the customer to use any means available to report the installation's known status as needed.
API Request
The endpoint to facilitate the communication from the customer site to FRAGTrack™ cloud is:
POST: /fragtrack/api/v1/installations/{installationId}/maintenance
Payload
The JSON request payload contains two properties, as shown below.
{
"Offline": true,
"Date": "2024-12-05T01:04:46.756Z"
}
When submitting the request, the:
- Offline property should indicate if the installation is available or not. A request should be sent for each value change of this property
- Date property should indicate the current UTC date for the status change value
Status Codes
On receipt and processing of the request the API will return a status code for the integration to determine the success of the call, being:
- 204 - the request was successfully received and processed
- 400 - the request was malformed and could not be processed
- 500 - something unexpected occurred
Integration
It is expected that the request will be made through a customer-owned integration.
Typical integrations can originate from various sources, such as WhatsUp Gold integration to Powershell or Bash scripts triggered by a customer system.
The BlastIQ™ Support can assist with integration guidance and supply parameterized scripts if needed.
Authentication and Authorization
The API requires a service user for authentication and authorization, which can be obtained from the BlastIQ™ Support Team.