ROCKITPLAY API
  1. Tasks
ROCKITPLAY API
  • ROCKIT Edge - Admin API
    • Minimal Tests
      • ping
      • submit test task
    • Admin Edge Organizations
      • Create Organization
      • Delete Organization
  • ROCKIT Edge - Backend API
    • Backend Edge Organizations
      • Create Organization
      • Delete Organization
    • Authentication
      • user login
      • authentication
    • Account Management
      • get user details
      • list users
      • Modify user
      • delete users
      • Create User / Create Machine User
    • Deployments
      • Creating Deployments
      • Get Deployments
      • Get Deployment Details
      • Modify Deployment
      • Deleting Deployments
    • Apps
      • Creating Apps
      • Import native builds
      • App Details
      • List Apps
      • patch app
      • Delete Apps
    • Triggers
      • Process Traces
      • Retry Task
    • Tasks
      • Listing Tasks
        GET
      • Task Details
        GET
      • Acknowledge Warning / Expire Task
        PATCH
    • Subscriptions
      • Subscribe
      • List Subscriptions
      • Unsubscribe
    • Roles
      • List Roles
      • Create Role
      • Patch Role
      • Role Details
      • Delete Roles
  • Changelog
    • Changelog
  1. Tasks

Listing Tasks

GET
https://Example-Server.com/be/v1/tasks
Last modified:2025-05-08 12:00:04
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 for more details.

Request

Query Params
offset
integer 
optional
Pagination offset.
Example:
0
limit
integer 
optional
Pagination limit.
Default:
10
Example:
10
appName
string 
optional
Filter by app name (supports partial matches, case sensitive).
Example:
example_app
taskGroup
string 
optional
Filter by task group (supports partial matches, case sensitive)
Example:
example_group
status[]
array[string]
optional
Filter by task status. Supported values: allocating, pending, configuring, preparing, running, finalizing, done, failed, canceled, unfinished.
Example:
["running","pending"]
taskTypes[]
array [array] 
optional
Filter by task types. Supported values: build,deploy,replication,cleanup,migration,test,export,import,backup,restore
Example:
["build","deploy"]
string 
optional
created
string 
optional
Filter tasks created after a specific ISO date.
Example:
2025-01-01T00:00:00Z
order[]
array[string]
optional
Sorting order. Supported fields for sorting: appName, taskType, created. +/- for Ascending/Descending (no +/- results in ascending order)
Example:
["-created","appName"]
Header Params
x-rockit-beauth-token
string 
optional
ROCKIT Edge backend authentication token (POST /be/v1/auth) or API key (POST /be/v1/apikeys)
Mutually excluded with x-rockit-api-key.
Example:
{{_edge_org_admin_beauth_token}}
x-rockit-orgname
string 
optional
Unique and immutable organization identifier obtained from the ROCKIT Edge administrator.
Requires x-rockit-username and x-rockit-api-key.
Example:
{{EDGE_ORG_NAME}}
x-rockit-username
string 
optional
Unique and immutable username which is accociated with the apikey.
Requires x-rockit-orgname and x-rockit-api-key.
Example:
adminPrincipal
x-rockit-api-key
string 
optional
Unique and imuutable apikey which is accociated with an machine user.
Mutually excluded with x-rockit-beauth-token. Requires x-rockit-username and x-rockit-orgname.
Example:
{{_adminPrincipal_apiKey}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://Example-Server.com/be/v1/tasks?offset=0&limit=10&appName=example_app&taskGroup=example_group&status[]=running&status[]=pending&taskTypes[]=build&taskTypes[]=deploy&created=2025-01-01T00:00:00Z&order[]=-created&order[]=appName' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}'

Responses

🟢200200: success
application/json
Body
status
string 
required
Indicates that the task listing operation was successful.
totalCount
integer 
required
An integer representing the total number of tasks that match the query.
tasks
array [object {3}] 
required
An array of task summary objects, where each task object includes:
name
string 
required
The unique identifier of the task.
service
string 
required
The service associated with the task (e.g., "engine" or "edge").
status
string 
required
The current status of the task (for example, "done", "pending", etc.).
Example
{
  "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"
    }
  ]
}
🟠400400: missing-param
🟠401401: token-expired
Previous
Retry Task
Next
Task Details
Built with