Get Task

GET

/api/v1/tasks/{database}/{schema}/{task_name}

curl --request GET \
  --url https://example.com/api/v1/tasks/example/example/example

Get information about a specific task.

Args: database: Database name schema: Schema name task_name: Task name

Returns: TaskInfo with task details

Raises: HTTPException: If task not found or request fails

Parameters

Path Parameters

database

required

Database

Database name

string

Database name

schema

required

Schema

Schema name

string

Schema name

task_name

required

Task Name

Task name

string

Task name

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

TaskInfo

Task information model.

object

name

required

Name

Task name

string

database_name

required

Database Name

Database name

string

schema_name

required

Schema Name

Schema name

string

owner

Any of:

string

string

null

null

comment

Any of:

string

string

null

null

warehouse

Any of:

string

string

null

null

schedule

Any of:

string

string

null

null

state

required

State

Task state (STARTED, SUSPENDED)

string

definition

Any of:

string

string

null

null

condition

Any of:

string

string

null

null

allow_overlapping_execution

Allow Overlapping Execution

Allow concurrent executions

boolean

error_integration

Any of:

string

string

null

null

last_committed_on

Any of:

string

string format: date-time

null

null

last_suspended_on

Any of:

string

string format: date-time

null

null

created_on

Any of:

string

string format: date-time

null

null

resumed_on

Any of:

string

string format: date-time

null

null

predecessor_tasks

Predecessor Tasks

List of predecessor task names

Array<string>

dependent_tasks

Dependent Tasks

List of dependent task names

Array<string>

task_timeout_minutes

Any of:

integer

integer

null

null

suspend_task_after_num_failures

Suspend Task After Num Failures

Auto-suspend after N failures

integer

default: 10

task_auto_retry_attempts

Any of:

integer

integer

null

null

target_completion_interval

Any of:

string

string

null

null

Example

{
  "allow_overlapping_execution": false,
  "suspend_task_after_num_failures": 10
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}