# Listing Tasks
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/be/v1/tasks:
get:
summary: Listing Tasks
deprecated: false
description: >-
This endpoint allows you to list all ongoing tasks of your organization
on the ROCKIT Edge. Tasks can be filtered by various parameters,
including app name, task group, status, type, and creation date. The
response can also be paginated and sorted.
### Required Permissions
`tasks.read`
See [Roles](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more details.
tags:
- ROCKIT Edge - Backend API/Tasks
parameters:
- name: offset
in: query
description: Pagination offset.
required: false
example: 0
schema:
type: integer
- name: limit
in: query
description: Pagination limit.
required: false
example: 10
schema:
type: integer
default: 10
- name: appName
in: query
description: Filter by app name (supports partial matches, case sensitive).
required: false
example: example_app
schema:
type: string
- name: taskGroup
in: query
description: Filter by task group (supports partial matches, case sensitive)
required: false
example: example_group
schema:
type: string
- name: status[]
in: query
description: >-
Filter by task status. Supported values: allocating, pending,
configuring, preparing, running, finalizing, done, failed, canceled,
unfinished.
required: false
example:
- running
- pending
schema:
type: array
items:
type: string
- name: taskTypes[]
in: query
description: >
Filter by task types. Supported values:
build,deploy,replication,cleanup,migration,test,export,import,backup,restore
required: false
example:
- build
- deploy
schema:
type: array
items:
type: array
items:
type: string
- name: created
in: query
description: Filter tasks created after a specific ISO date.
required: false
example: '2025-01-01T00:00:00Z'
schema:
type: string
- name: order[]
in: query
description: >-
Sorting order. Supported fields for sorting: appName, taskType,
created. +/- for Ascending/Descending (no +/- results in ascending
order)
required: false
example:
- '-created'
- appName
schema:
type: array
items:
type: string
- name: Authorization
in: header
description: >-
Use the access token obtained from [`POST
/be/v1/login`](https://edge.api.cloud.rockitplay.com/user-login-org-11611254e0.md)
or [`POST
/be/v1/refresh`](https://edge.api.cloud.rockitplay.com/refresh-11630082e0.md)
as Bearer token.
Mutually excluded with `x-rockit-api-key`.
required: true
example: Bearer {{_edge_org_admin_access_token}}
schema:
type: string
- name: x-rockit-tenant
in: header
description: >
Unique and immutable tenancy identifier obtained from the ROCKIT
Edge administrator.
Requires `x-rockit-username`,
`x-rockit-orgname` and `x-rockit-api-key`.
required: true
example: '{{EDGE_TENANT_NAME}}'
schema:
type: string
- name: x-rockit-orgname
in: header
description: >
Unique and immutable organization identifier obtained from the
ROCKIT Edge administrator.
Requires `x-rockit-tenant`,
`x-rockit-username` and `x-rockit-api-key`.
required: true
example: '{{EDGE_ORG_NAME}}'
schema:
type: string
- name: x-rockit-username
in: header
description: >
Unique and immutable username which is associated with the apikey.
Requires `x-rockit-tenant`, `x-rockit-orgname` and
`x-rockit-api-key`.
required: true
example: adminPrincipal
schema:
type: string
- name: x-rockit-api-key
in: header
description: >-
Unique and immutable apikey which is associated with an machine
user.
Mutually excluded with `Authorization` header. Requires
`x-rockit-tenant`, `x-rockit-username` and `x-rockit-orgname`.
required: true
example: '{{_adminPrincipal_apiKey}}'
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Indicates that the task listing operation was successful.
totalCount:
type: integer
description: >-
An integer representing the total number of tasks that
match the query.
tasks:
type: array
items:
type: object
properties:
name:
type: string
description: The unique identifier of the task.
appName:
type: string
description: >-
The unique identifier of the app associated to the
task.
buildName:
type: string
description: The build identifier if applicable, e.g., "0001"
taskGroup:
type: string
description: >-
Identifier of the task group. Tasks belonging to the
same group are scheduled in parallel.
taskType:
type: string
enum:
- dltar
- mkraw
- mkseq
- mkdxf
- mkpat
- publish
- sync
- deploy
x-apidog-enum:
- value: dltar
name: ' Download native build tarball from URL'
description: ''
- value: mkraw
name: ' Create ROCKIT RAW image'
description: ''
- value: mkseq
name: ' Compute ROCKIT sequence information'
description: ''
- value: mkdxf
name: ' Generate ROCKIT image'
description: ''
- value: mkpat
name: ' Compute patch files'
description: ''
- value: publish
name: ' Publish data from ROCKIT Engine to ROCKIT Edge'
description: ''
- value: sync
name: ' Synchronize data from ROCKIT Edge from ROCKIT Engine'
description: ''
- value: deploy
name: ' Deploy files to CDN origin'
description: ''
description: Type identifier of the task
service:
type: string
description: >-
The service associated with the task (e.g., "engine"
or "edge").
status:
type: string
description: >-
The current status of the task (for example, "done",
"pending", etc.).
results:
type: boolean
description: >-
Specifies if additional task result data are
attached to this task.
required:
- name
- appName
- taskGroup
- taskType
- service
- status
x-apidog-orders:
- name
- appName
- buildName
- taskGroup
- taskType
- service
- status
- results
x-apidog-ignore-properties: []
description: >-
An array of task summary objects, where each task object
includes:
required:
- status
- totalCount
- tasks
x-apidog-orders:
- status
- totalCount
- tasks
x-apidog-ignore-properties: []
examples:
'1':
summary: '200: success'
value:
status: success
totalCount: 13
tasks:
- name: exampleorg-sushi-0001-1732886919-dltar
service: engine
status: done
- name: exampleorg-sushi-0001-1732887061-mkraw
service: engine
status: done
- name: exampleorg-sushi-0001-1732887229-mkdxf
service: engine
status: done
- name: exampleorg-sushi-0001-1732887357-publish
service: engine
status: done
- name: exampleorg-sushi-0001-1732887364-deploy
service: edge
status: done
- name: exampleorg-sushi-0002-1733149403-dltar
service: engine
status: pending
- name: exampleorg-sushi-0002-1733154780-dltar
service: engine
status: done
- name: exampleorg-sushi-0002-1733154909-mkraw
service: engine
status: done
- name: exampleorg-sushi-0002-1733155066-mkpat
service: engine
status: done
- name: exampleorg-sushi-0002-1733155262-mkdxf
service: engine
status: done
'2':
summary: '400: missing-param'
value:
status: failed
error: missing-param
message: x-rockit-beauth-token missing
detail: header parameter x-rockit-beauth-token is required
'3':
summary: '401: token-expired'
value:
status: failed
error: token-expired
message: expired token
headers: {}
x-apidog-name: '200: success'
'400':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more
invalid or missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example,
"name invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected
pattern for the organization name)
x-apidog-orders:
- 01JQNHT32YZB54D5ZJ7AFQ95EN
required:
- status
- error
- message
- detail
x-apidog-refs:
01JQNHT32YZB54D5ZJ7AFQ95EN:
$ref: '#/components/schemas/Invalid%20Param'
x-apidog-ignore-properties:
- status
- error
- message
- detail
headers: {}
x-apidog-name: '400: missing-param'
'401':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was
rejected because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose
the failure.
x-apidog-orders:
- 01JQNHTEWQGFB3YH0T7KYWVE5T
required:
- status
- error
- message
x-apidog-refs:
01JQNHTEWQGFB3YH0T7KYWVE5T:
$ref: '#/components/schemas/unauthorized'
x-apidog-ignore-properties:
- status
- error
- message
headers: {}
x-apidog-name: '401: token-expired'
security: []
x-apidog-folder: ROCKIT Edge - Backend API/Tasks
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/732774/apis/api-11779680-run
components:
schemas:
Invalid Param:
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more invalid or
missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example, "name
invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected pattern for the
organization name)
required:
- status
- error
- message
- detail
x-apidog-orders:
- status
- error
- message
- detail
x-apidog-ignore-properties: []
x-apidog-folder: ''
unauthorized:
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was rejected
because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose the
failure.
required:
- status
- error
- message
x-apidog-orders:
- status
- error
- message
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
Bearer token:
type: bearer
scheme: bearer
description: >-
Enter your Access Token. You can obtain this by calling the /be/v1/login
endpoint. Use the Refresh token to get a new Access token when it
expires.
servers:
- url: https://Example-Server.com
description: Default
security: []
```