The Availability module offers the following options to get data via API:
- REST
- GraphQL
- Pub/Sub
However, please be aware that the GraphQL and Pub/Sub have limited implementation currently, but have the option to be enabled & expanded upon customer request. Please reach out to your Gridsz contact person to learn more about this.
And as with other Gridsz API’s, you are required to have a whitelisted IP address and valid Bearer token. In case you need your IP whitelisted or a (new) token, please reach out to Gridsz support via a ticket.
Availability Service (REST)
Through this REST API, you will be able to do actions based on Address, Connection and Fiber level.
Additionally, it includes functionality such as getting all relevant patch details via the Patch History API call. Furthermore, the latest API to directly write overrides on a connection is also added via the Override API.
The table below shows the URLs to use, while the Swagger icon links to the UI version. The REST International API is the default for new implementations, the country specific REST APIs will be deprecated over time.
