# Incident management

## **Scheduled Maintenance** <a href="#where-is-the-api-documentation" id="where-is-the-api-documentation"></a>

Planned maintenance by us or our partners will be communicated in advance via our email distribution list.

Our hosting provider performs security and stability updates on the 1st and 3rd Monday between 8:00pm - 2:00am CET of each month. During these maintenance windows, no service outages are expected. If there is an increased risk of service disruption, we will proactively inform you.

## Health endpoint <a href="#where-is-the-api-documentation" id="where-is-the-api-documentation"></a>

[https://demo.stage.fidentity.ch/api/v1/health ](https://demo.stage.fidentity.ch/api/v1/health)(*yourUrl*/api/v1/health).&#x20;

## Status query <a href="#where-is-the-api-documentation" id="where-is-the-api-documentation"></a>

To identify potential incidents, the tenant status can be queried. If the result is an empty array, the system is operating normally. Otherwise, an entry will indicate the severity of the issue. Requests:

* Stage: <https://status.stage.fidentity.ch/api/v1/status?severity=low,medium,high,blocker\\&tenant=yourTenant>
* Productive: <https://status.fidentity.ch/api/v1/status?severity=low,medium,high,blocker\\&tenant=yourTenant&#x20>;

{% hint style="info" %}
Replace 'yourTenant' with your actual tenant name. For example, use ...blocker\&tenant=<mark style="color:blue;">demo</mark> for <mark style="color:blue;">demo</mark>.stage.fidentity.ch
{% endhint %}

**Example result without incidents**

```
[]
```

**Example result with an incident**

{% code overflow="wrap" %}

```
[ { "id": "feaf51fd-77cb-43a2-8888-1c67143934e7", "from": "2024-02-01T16:30:36.315Z", "to": null, "customerInfo": { "de": "", "fr": "", "it": "", "en": "", "pt": "" }, "title": { "de": "Test incident", "fr": "", "it": "", "en": "", "pt": "" }, "tenant": "6838cc06cc0f66fd883b689489f306cc0ff59a052743eb0e81e6ac58465dd8e7", "tags": [], "severity": "blocker", "status": "pending" } ]
```

{% endcode %}

## Client and end user messages <a href="#where-is-the-api-documentation" id="where-is-the-api-documentation"></a>

During incidents, fidentity triggers messages to notify both customers and end users.

**Client message**

Clients receive incident updates directly on the fidentity dashboard.&#x20;

<figure><img src="https://882733581-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeMRAXlmouoJYab3amLJp%2Fuploads%2FFyQIgucGOjztSNUFLAMS%2Fimage.png?alt=media&#x26;token=d399c02c-3682-4e1c-a8f2-573eff56406e" alt=""><figcaption></figcaption></figure>

**End user message**

End users receive relevant updates tailored to the incident's impact— low, high, or blocker. For low-level incidents, messages serve as information and can be closed. High-level incidents are accompanied by a toast message guiding the user through the process. In the case of blocker incidents, a window appears, allowing the user to terminate the process.&#x20;

<figure><img src="https://882733581-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeMRAXlmouoJYab3amLJp%2Fuploads%2Fbgy0OcrNvfQWlTibBdqN%2Fimage.png?alt=media&#x26;token=3df26dd9-24a8-4f04-97d8-f5c7e3140916" alt=""><figcaption><p>Examples of end user messages from left to right: low-impact incident, high-impact incident, blocker incident.</p></figcaption></figure>