# Web Cloud › Internet › Maintenance 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/maintenance/

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

## Operations

- `GET /connectivity/maintenance/workPlanned/partners` — List the work planned by operators for a partner
- `GET /connectivity/maintenance/workPlanned/public` — List the work planned by operators

## List the work planned by operators for a partner

`GET /1.0/connectivity/maintenance/workPlanned/partners`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/maintenance/#getPartnersPlannedWork

**Status:** Stable production version  
**IAM actions:** `account:apiovh:connectivity/maintenance/workPlanned/partners/get`

Returns the planned work operations of network operators, with their dates, duration, impact, impacted NRA/NRO and departments. Reserved for partners.

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | connectivity.maintenance.WorkPlanned[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `dateBegin` | string | read-only | Begin date, the work planned operation starts at this time |
| `dateEnd` | string | read-only | End date, the work planned operation finishes at the time |
| `departments` | string[] | read-only | List of impacted department codes |
| `description` | string | read-only | Description of the work planned operation |
| `duration` | string (duration) | read-only | Duration of the work planned operation |
| `fallback` | boolean | read-only | Fallback planned for the operation |
| `fallbackDateBegin` | string (date-time) | read-only | Fallback operation starts at this time |
| `fallbackDateEnd` | string (date-time) | read-only | Fallback operation ends at this time |
| `id` | integer | read-only | Work Planned operation id |
| `impact` | string | read-only | Impact of the work planned operation |
| `interventionType` | connectivity.maintenance.InterventionTypeEnum | read-only | Intervention type — one of `BACKBONE_MAINTENANCE`, `CARD_SWAP_WITH_IMPACT`, `CLUSTER_AN_ROUTER_MIGRATION`, `CORRECTIVE_MAINTENANCE`, `DSLAM_LINK_UPGRADE_WITHOUT_CARD_SWAP`, `DSLAM_UPGRADE_WITH_IMPACT`, `FIBER_CABLE_LINK_SWAP`, `FIBER_CONNECTION_WITH_IMPACT`, `FIBER_MAINTENANCE`, `FIBER_THIRD_PARTY_WORK_WITH_IMPACT`, `IP_BACKBONE_LINK_MIGRATION_WITH_IMPACT`, `IP_BACKBONE_SWITCH_UPGRADE_WITH_IMPACT`, … |
| `nras` | string[] | read-only | List of impacted NRA/NRO |
| `operator` | connectivity.OperatorEnum | read-only | Operator — one of `AXIONE`, `BOUYGUES`, `KOSC`, `ORANGE`, `OVH`, `SFR` |
| `technology` | string | read-only | Technology impacted by the work planned operation |
| `zone` | string | read-only | Zone of the work planned operation |

```json
[
  {
    "dateBegin": "string",
    "dateEnd": "string",
    "departments": [
      "string"
    ],
    "description": "string",
    "duration": "string",
    "fallback": true,
    "fallbackDateBegin": "2024-01-01T12:00:00Z",
    "fallbackDateEnd": "2024-01-01T12:00:00Z",
    "id": 0,
    "impact": "string",
    "interventionType": "BACKBONE_MAINTENANCE",
    "nras": [
      "string"
    ],
    "operator": "AXIONE",
    "technology": "string",
    "zone": "string"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/connectivity/maintenance/workPlanned/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/maintenance/workPlanned/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/maintenance/workPlanned/partners");

print_r($result);
?>
```

## List the work planned by operators

`GET /1.0/connectivity/maintenance/workPlanned/public`

Link: https://developers.eu.ovhcloud.com/reference/web-cloud/internet/maintenance/#getPlannedWork

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

Returns the planned work operations of network operators, with their dates, duration, impact, impacted NRA/NRO and departments. Filter on the begin and end dates.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `beginDate` | query | string (date-time) |  | List only work planned started after this date |
| `endDate` | query | string (date-time) |  | List only work planned ending prior to this date |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | connectivity.maintenance.WorkPlanned[] | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `dateBegin` | string | read-only | Begin date, the work planned operation starts at this time |
| `dateEnd` | string | read-only | End date, the work planned operation finishes at the time |
| `departments` | string[] | read-only | List of impacted department codes |
| `description` | string | read-only | Description of the work planned operation |
| `duration` | string (duration) | read-only | Duration of the work planned operation |
| `fallback` | boolean | read-only | Fallback planned for the operation |
| `fallbackDateBegin` | string (date-time) | read-only | Fallback operation starts at this time |
| `fallbackDateEnd` | string (date-time) | read-only | Fallback operation ends at this time |
| `id` | integer | read-only | Work Planned operation id |
| `impact` | string | read-only | Impact of the work planned operation |
| `interventionType` | connectivity.maintenance.InterventionTypeEnum | read-only | Intervention type — one of `BACKBONE_MAINTENANCE`, `CARD_SWAP_WITH_IMPACT`, `CLUSTER_AN_ROUTER_MIGRATION`, `CORRECTIVE_MAINTENANCE`, `DSLAM_LINK_UPGRADE_WITHOUT_CARD_SWAP`, `DSLAM_UPGRADE_WITH_IMPACT`, `FIBER_CABLE_LINK_SWAP`, `FIBER_CONNECTION_WITH_IMPACT`, `FIBER_MAINTENANCE`, `FIBER_THIRD_PARTY_WORK_WITH_IMPACT`, `IP_BACKBONE_LINK_MIGRATION_WITH_IMPACT`, `IP_BACKBONE_SWITCH_UPGRADE_WITH_IMPACT`, … |
| `nras` | string[] | read-only | List of impacted NRA/NRO |
| `operator` | connectivity.OperatorEnum | read-only | Operator — one of `AXIONE`, `BOUYGUES`, `KOSC`, `ORANGE`, `OVH`, `SFR` |
| `technology` | string | read-only | Technology impacted by the work planned operation |
| `zone` | string | read-only | Zone of the work planned operation |

```json
[
  {
    "dateBegin": "string",
    "dateEnd": "string",
    "departments": [
      "string"
    ],
    "description": "string",
    "duration": "string",
    "fallback": true,
    "fallbackDateBegin": "2024-01-01T12:00:00Z",
    "fallbackDateEnd": "2024-01-01T12:00:00Z",
    "id": 0,
    "impact": "string",
    "interventionType": "BACKBONE_MAINTENANCE",
    "nras": [
      "string"
    ],
    "operator": "AXIONE",
    "technology": "string",
    "zone": "string"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/1.0/connectivity/maintenance/workPlanned/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/maintenance/workPlanned/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/maintenance/workPlanned/public");

print_r($result);
?>
```