Interface Task

interface Task {
    authorizationID?: string;
    createdAt?: string;
    cron?: string;
    description?: string;
    every?: string;
    flux: string;
    id: string;
    labels?: Labels;
    lastRunError?: string;
    lastRunStatus?: "failed" | "success" | "canceled";
    latestCompleted?: string;
    links?: {
        labels?: string;
        logs?: string;
        members?: string;
        owners?: string;
        runs?: string;
        self?: string;
    };
    name: string;
    offset?: string;
    org?: string;
    orgID: string;
    ownerID?: string;
    status?: TaskStatusType;
    updatedAt?: string;
}

Properties

authorizationID? createdAt? cron? description? every? flux id labels? lastRunError? lastRunStatus? latestCompleted? links? name offset? org? orgID ownerID? status? updatedAt?

Properties

OptionalauthorizationID

authorizationID?: string

An authorization ID. Specifies the authorization used when the task communicates with the query engine.

To find an authorization ID, you can use the GET /api/v2/authorizations endpoint to list authorizations.

Optional ReadonlycreatedAt

createdAt?: string

Optionalcron

cron?: string

A Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.

Optionaldescription

description?: string

A description of the task.

Optionalevery

every?: string

The interval (duration literal) at which the task runs. every also determines when the task first runs, depending on the specified time.

flux

flux: string

The Flux script that the task executes.

Readonlyid

id: string

Optionallabels

labels?: Labels

Optional ReadonlylastRunError

lastRunError?: string

Optional ReadonlylastRunStatus

lastRunStatus?: "failed" | "success" | "canceled"

Optional ReadonlylatestCompleted

latestCompleted?: string

A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.

Optional Readonlylinks

links?: {
    labels?: string;
    logs?: string;
    members?: string;
    owners?: string;
    runs?: string;
    self?: string;
}

name

name: string

The name of the task.

Optionaloffset

offset?: string

A duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.

Optionalorg

org?: string

An organization name. Specifies the organization that owns the task.

orgID

orgID: string

An organization ID. Specifies the organization that owns the task.

OptionalownerID

ownerID?: string

A user ID. Specifies the owner of the task.

To find a user ID, you can use the GET /api/v2/users endpoint to list users.

Optionalstatus

status?: TaskStatusType

Optional ReadonlyupdatedAt

updatedAt?: string

Settings

Member Visibility

On This Page

Properties