[comment]: # ({0d3af930-0d3af930})
# maintenance.get

[comment]: # ({/0d3af930-0d3af930})

[comment]: # ({9b458513-a04dd4c9})
### Description

`integer/array maintenance.get(object parameters)`

La méthode permet de récupérer les maintenances selon les paramètres donnés.

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type.
Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur.
Voir [User roles](/manual/web_interface/frontend_sections/users/user_roles) pour plus d’informations.
:::

[comment]: # ({/9b458513-a04dd4c9})

[comment]: # ({5e94d811-9ca798d7})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Paramètre|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|groupids|ID/array|Retourner uniquement les maintenances attribuées aux groupes d'hôtes donnés.|
|hostids|ID/array|Retourner uniquement les maintenances attribuées aux hôtes donnés.|
|maintenanceids|ID/array|Retourner uniquement les maintenances avec les ID donnés.|
|selectHostGroups|query|Retourner une propriété [`hostgroups`](/manual/api/reference/hostgroup/object) avec les groupes d'hôtes attribués à la maintenance.|
|selectHosts|query|Retourner une propriété [`hosts`](/manual/api/reference/host/object) avec les hôtes attribués à la maintenance.|
|selectTags|query|Retourner une propriété [`tags`](/manual/api/reference/maintenance/object#problem-tag) avec les tags de problème de la maintenance.|
|selectTimeperiods|query|Retourner une propriété [`timeperiods`](/manual/api/reference/maintenance/object#time-period) avec les périodes de temps de la maintenance.|
|sortfield|string/array|Trier le résultat selon les propriétés données.<br><br>Valeurs possibles : `maintenanceid`, `name`, `maintenance_type`, `active_since`, `active_till`.|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/5e94d811-9ca798d7})

[comment]: # ({07ca11ca-7223bab1})
### Valeurs de retour

`(integer/array)` Renvoie soit :

-   un tableau d'objets ;
-   le nombre d'objets récupérés, si le paramètre `countOutput` a été utilisé.

[comment]: # ({/07ca11ca-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Exemples

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({f81f6983-0b1cb387})
#### Récupération des maintenances

Récupérez toutes les maintenances configurées, ainsi que les données sur les groupes d’hôtes assignés, les périodes de temps définies et les tags de problème.

[Requête](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectHostGroups": "extend",
        "selectTimeperiods": "extend",
        "selectTags": "extend"
    },
    "id": 1
}
```

Réponse :

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "maintenanceid": "3",
            "name": "Sunday maintenance",
            "maintenance_type": "0",
            "description": "",
            "active_since": "1358844540",
            "active_till": "1390466940",
            "tags_evaltype": "0",
            "hostgroups": [
                {
                    "groupid": "4",
                    "name": "Zabbix servers",
                    "flags": "0",
                    "uuid": "6f6799aa69e844b4b3918f779f2abf08"
                }
            ],
            "timeperiods": [
                {
                    "timeperiod_type": "3",
                    "every": "1",
                    "month": "0",
                    "dayofweek": "1",
                    "day": "0",
                    "start_time": "64800",
                    "period": "3600",
                    "start_date": "2147483647"
                }
            ],
            "tags": [
                {
                    "tag": "service",
                    "operator": "0",
                    "value": "mysqld",
                },
                {
                    "tag": "error",
                    "operator": "2",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/f81f6983-0b1cb387})

[comment]: # ({c56425b7-dbcf678a})
### Voir aussi

-   [Hôte](/manual/api/reference/host/object#host)
-   [Groupe d'hôtes](/manual/api/reference/hostgroup/object#host-group)
-   [Période de temps](object#time-period)

[comment]: # ({/c56425b7-dbcf678a})

[comment]: # ({f0ec3c40-50ed5be3})
### Source

CMaintenance::get() dans *ui/include/classes/api/services/CMaintenance.php*.

[comment]: # ({/f0ec3c40-50ed5be3})