[comment]: # ({d981e093-d981e093})
# task.get

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

[comment]: # ({f5b508b8-79cf46cd})
### Description

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

The method allows to retrieve tasks according to the given parameters.

::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/users/user_roles)
for more information.
:::

[comment]: # ({/f5b508b8-79cf46cd})

[comment]: # ({cb569210-cd6e3f53})
### Parameters

`(object)` Parameters defining the desired output.

The method supports the following parameters.

|Parameter|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|taskids|ID/array|Return only tasks with the given IDs.|
|output|query|These parameters are described in the [reference commentary](/manual/api/reference_commentary#common_get_method_parameters).|
|preservekeys|boolean|^|

[comment]: # ({/cb569210-cd6e3f53})

[comment]: # ({e1126edc-e1126edc})
### Return values

`(integer/array)` Returns an array of objects.

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

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

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

[comment]: # ({47c016bb-8d9c84cb})
#### Retrieve task by ID

Retrieve all the data about the task with the ID "1".

[Request](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "task.get",
    "params": {
        "output": "extend",
        "taskids": "1"
    },
    "id": 1
}
```

Response:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "taskid": "1",
            "type": "7",
            "status": "3",
            "clock": "1601039076",
            "ttl": "3600",
            "proxyid": null,
            "request": {
                "alerting": {
                    "stats": [
                        "alerts"
                    ],
                    "top": {
                        "media.alerts": 10
                    }
                },
                "lld": {
                    "stats": "extend",
                    "top": {
                        "values": 5
                    }
                }
            },
            "result": {
                "data": {
                    "alerting": {
                        "alerts": 0,
                        "top": {
                            "media.alerts": []
                        },
                        "time": 0.000663
                    },
                    "lld": {
                        "rules": 0,
                        "values": 0,
                        "top": {
                            "values": []
                        },
                        "time": 0.000442
                    }
                },
                "status": "0"
            }
        }
    ],
    "id": 1
}
```

[comment]: # ({/47c016bb-8d9c84cb})

[comment]: # ({58f08e8d-e1d2d11a})
### See also

-   [Task](/manual/api/reference/task/object)
-   ['Execute now' request object](/manual/api/reference/task/object#execute-now-request-object)
-   ['Refresh proxy configuration' request object](/manual/api/reference/task/object#refresh-proxy-configuration-request-object)
-   ['Diagnostic information' request object](/manual/api/reference/task/object#diagnostic-information-request-object)

[comment]: # ({/58f08e8d-e1d2d11a})

[comment]: # ({85e7fa97-85e7fa97})
### Source

CTask::get() in *ui/include/classes/api/services/CTask.php*.

[comment]: # ({/85e7fa97-85e7fa97})