Get all the tasks.

Prev Next
Get
/v1/tasks

Get all the tasks in the system.

Security
API Key: bearerToken
Header parameter nameAuthentication

A JWT bearer token to be passed once authenticated.

Query parameters
task_type
string

Task type.

Valid values[ "NODE_ATTESTATION", "CERTIFICATE_ISSUANCE", "BUILD_WHITELIST", "DOMAIN_WHITELIST" ]
status
string

Task status.

Valid values[ "PENDING", "CLOSED" ]
requester
string

UserName of requester.

approver
string

UserName of approver.

all_search
string

Search on Requester or Request.

limit
integer

Maximum numbers of tasks to return.

offset
integer

Number of tasks to skip from start.

sort_by
string

Sort fields. In the format of key1:ASC,key2:DESC,key3:DESC

base_filters
string

Filters to be applied on base query (count and results) key1:ASC,key2:DESC,key3:DESC

Responses
200

Search result for Task objects.

Expand All
object
metadata
object (SearchMetadata)
page
integer

Current page number

pages
integer

Total pages as per the item counts and page limit.

limit
integer

Number of items to limit in a page.

total_count
integer

Total number of unfiltered items.

filtered_count
integer

Total number of items as per the current filter.

items
Array of object (Task)
object
task_id
string (uuid)

Task Id.

requester_info
object (RequesterInfo)
user_id
string (uuid)

User Id.

user_name
string

User Name.

app_id
string (uuid)

App Id.

app_name
string

App Name.

requester_type
string

Type of requester.

Valid values[ "USER", "APP", "SYSTEM" ]
entity_id
string (uuid)

app_id, build_id, node_id, cert_id are entity_id for app_domain_whitelisting, build_whitelisting, node_attestation and certificate_issuance respectively.

task_type
string

The types of tasks supported.

Valid values[ "NODE_ATTESTATION", "CERTIFICATE_ISSUANCE", "BUILD_WHITELIST", "DOMAIN_WHITELIST" ]
status
object (TaskStatus)

Status info for a task.

created_at
integer (int64)

Task creation time

status_updated_at
integer (int64)

Time since the status change.

status
string

Status string for a task.

Valid values[ "INPROGRESS", "FAILED", "SUCCESS", "DENIED" ]
description
string

Task details.

approvals
Array of object (ApprovalInfo)
object
user_id
string (uuid)

User Id.

user_name
string

User Name.

status
string

Approval status.

Valid values[ "APPROVED", "DENIED" ]
denial_reason
string

Reason associated with the denial.

domains_added
Array of string
string
domains_removed
Array of string
string
group_id
string (uuid)

Group Id