Outages

The Outages screen allows you to manage the scheduled unavailability of one or more APIs, so that the maintenance is notified to the regulatory APIs of the ecosystem.

Throughout their lifecycle, Open Finance APIs go through unavailability periods, scheduled downtime to perform maintenance. These downtimes are called Outages and must be reported to the Open Finance ecosystem. To learn more, read Reports and Metrics (in Portuguese).

Create Outage

Allows you to register an unavailability through the button Create in the lower right corner of the screen. When you press it, fill in the fields:

Name

To identify the outage. It must contain up to 240 characters.

Explanation

With the explanation of the reasons for the unavailability.

Start

Date and time scheduled for the beginning of the unavailability.

End

Date and time scheduled for the end of the unavailability.

Unavailable Endpoints

To identify which endpoints will be unavailable. The list shows all the families and specific APIs available to your organization, you must select at least one.

It is possible to schedule the same unavailability for the whole ecosystem by checking the [All Endpoints] checkbox, or selecting specific families and APIs from the list.

Registered unavailabilities are returned to the regulatory API.

Details

Allows you to view an outage record in detail. By clicking on the arrow icon Details, you can see the explanation about the reasons for unavailability, expected date and time of closure and the unavailable endpoints during the process, as shown below:

details

Besides viewing the list of all registered outages, the grid allows you to:

  • Edit an outage that has not been executed yet Edit

  • Delete a registered outage Delete

  • Filter by period. By clicking on the funnel icon Funil, it is also possible to make a combined filter, adding the fields Name and Endpoint to the search.

To search for the information you have entered in the filter, click [SEARCH]. To clear the search, click [CLEAR].

filtro

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]