InfluxDB 2.0 JavaScript client
Home > @influxdata/influxdb-client-apis > GetTasksRequest
Signature:
interface GetTasksRequest
| Property | Modifiers | Type | Description |
|---|---|---|---|
| after? | string | (Optional) A task ID. Only returns tasks created after the specified task. | |
| limit? | number | <p>(Optional) The maximum number of tasks to return. Default is 100. The minimum is 1 and the maximum is 500.</p><p>To reduce the payload size, combine _type=basic_ and _limit_ (see _Request samples_). For more information about the basic response, see the _type_ parameter.</p> |
|
| name? | string | (Optional) A task name. Only returns tasks with the specified name. Different tasks may have the same name. | |
| org? | string | (Optional) An organization name. Only returns tasks owned by the specified organization. | |
| orgID? | string | (Optional) An organization ID. Only returns tasks owned by the specified organization. | |
| status? | string | (Optional) A task status. Only returns tasks that have the specified status (active or inactive). |
|
| type? | string | (Optional) A task type (basic or system). Default is system. Specifies the level of detail for tasks in the response. The default (system) response contains all the metadata properties for tasks. To reduce the response size, pass basic to omit some task properties (flux, createdAt, updatedAt). |
|
| user? | string | (Optional) A user ID. Only returns tasks owned by the specified user. |