# Web Cloud › Internet › Monitoring API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Web Cloud product's sections: https://developers.eu.ovhcloud.com/reference/web-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 2 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/monitoring/

OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/web-cloud/internet/monitoring.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/web-cloud/internet/monitoring.json?format=openapi3

## Operations

- `GET /connectivity/monitoring/genericIncident/partners` — List the generic incidents for a partner
- `GET /connectivity/monitoring/genericIncident/public` — List the generic incidents

## List the generic incidents for a partner

`GET /1.0/connectivity/monitoring/genericIncident/partners`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/monitoring/#getPartnersGenericIncident

**Status:** Stable production version  
**IAM actions:** `account:apiovh:connectivity/monitoring/genericIncident/partners/get`

Returns the detected, validated and recently closed generic incidents, with their impacted operators, technologies, NRA/NRO and departments, and their estimated resolution date. Reserved for partners.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `creationDate` | query | string (date-time) |  | List only incidents created after this date |
| `endDate` | query | string (date-time) |  | List only incidents closed prior to this date |
| `status` | query | connectivity.monitoring.GenericIncidentStatusEnum |  | Filter by the status of the incident (detected, validated or closed) — one of `closed`, `detected`, `validated` |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | connectivity.monitoring.GenericIncident[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `comment` | string | read-only | Optional comment, that contains some information and updates about the generic incident |
| `creationDate` | string | read-only | Creation date, the generic incident has been detected |
| `default` | string | read-only | Type of fault |
| `departments` | string[] | read-only | List of impacted department codes |
| `endDate` | string | read-only | End date, the generic incident is resolved and closed |
| `estimatedResolutionDate` | string | read-only | Estimated resolution date for generic incident |
| `id` | integer | read-only | Generic incident id |
| `isNational` | boolean | read-only | Identify a national generic incident |
| `nature` | string | read-only | Details about the consequence of the default |
| `nra` | string[] | read-only | List of impacted NRA/NRO |
| `operators` | connectivity.OperatorEnum[] | read-only | List of impacted operators |
| `status` | connectivity.monitoring.GenericIncidentStatusEnum | read-only | Generic incident status — one of `closed`, `detected`, `validated` |
| `taskId` | integer | read-only | Task id |
| `taskReference` | string | read-only | Task reference created on Ovhcloud status web page |
| `technologies` | string[] | read-only | Impacted technologies |

```json
[
  {
    "comment": "string",
    "creationDate": "string",
    "default": "string",
    "departments": [
      "string"
    ],
    "endDate": "string",
    "estimatedResolutionDate": "string",
    "id": 0,
    "isNational": true,
    "nature": "string",
    "nra": [
      "string"
    ],
    "operators": [
      "AXIONE"
    ],
    "status": "closed",
    "taskId": 0,
    "taskReference": "string",
    "technologies": [
      "string"
    ]
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/connectivity/monitoring/genericIncident/partners" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/connectivity/monitoring/genericIncident/partners")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/connectivity/monitoring/genericIncident/partners");

print_r($result);
?>
```

## List the generic incidents

`GET /1.0/connectivity/monitoring/genericIncident/public`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/monitoring/#getGenericIncident

**Status:** Stable production version  
**Authentication:** none (public operation)

Returns the validated and recently closed generic incidents, with their impacted operators, technologies, NRA/NRO and departments, and their estimated resolution date. Filter on the dates and the status.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `creationDate` | query | string (date-time) |  | List only incidents created after this date |
| `endDate` | query | string (date-time) |  | List only incidents closed prior to this date |
| `status` | query | connectivity.monitoring.GenericIncidentStatusEnum |  | Filter by the status of the incident (validated or closed) — one of `closed`, `detected`, `validated` |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | connectivity.monitoring.GenericIncident[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `comment` | string | read-only | Optional comment, that contains some information and updates about the generic incident |
| `creationDate` | string | read-only | Creation date, the generic incident has been detected |
| `default` | string | read-only | Type of fault |
| `departments` | string[] | read-only | List of impacted department codes |
| `endDate` | string | read-only | End date, the generic incident is resolved and closed |
| `estimatedResolutionDate` | string | read-only | Estimated resolution date for generic incident |
| `id` | integer | read-only | Generic incident id |
| `isNational` | boolean | read-only | Identify a national generic incident |
| `nature` | string | read-only | Details about the consequence of the default |
| `nra` | string[] | read-only | List of impacted NRA/NRO |
| `operators` | connectivity.OperatorEnum[] | read-only | List of impacted operators |
| `status` | connectivity.monitoring.GenericIncidentStatusEnum | read-only | Generic incident status — one of `closed`, `detected`, `validated` |
| `taskId` | integer | read-only | Task id |
| `taskReference` | string | read-only | Task reference created on Ovhcloud status web page |
| `technologies` | string[] | read-only | Impacted technologies |

```json
[
  {
    "comment": "string",
    "creationDate": "string",
    "default": "string",
    "departments": [
      "string"
    ],
    "endDate": "string",
    "estimatedResolutionDate": "string",
    "id": 0,
    "isNational": true,
    "nature": "string",
    "nra": [
      "string"
    ],
    "operators": [
      "AXIONE"
    ],
    "status": "closed",
    "taskId": 0,
    "taskReference": "string",
    "technologies": [
      "string"
    ]
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/connectivity/monitoring/genericIncident/public" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/connectivity/monitoring/genericIncident/public")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/connectivity/monitoring/genericIncident/public");

print_r($result);
?>
```
