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

Task Details

GET
https://Example-Server.com/be/v1/tasks/{taskName}
Last modified:2025-05-08 12:00:04
This endpoint allows you to list details of a specific task, including status and exceptions.

Required Permissions#

tasks.read
See Roles for more details.

Request

Path Params
taskName
string 
required
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 --request GET 'https://Example-Server.com/be/v1/tasks/' \
--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

🟢200OK
application/json
Body
status
string 
required
Indicates that the task listing operation was successful.
task
object 
required
An object containing detailed information about the task, including:
name
string 
required
The task's unique identifier.
appName
string 
required
The name of the app associated with the task.
buildName
string 
required
The build identifier related to the task.
taskType
string 
required
The type of the task (e.g., "dltar", "mkraw", etc.).
status
string 
required
The current state of the task.
steps
object 
required
An object with timestamps indicating when the task was created, started, and finished.
userData
object 
optional
An optional object providing additional details in case of an exception such as, the URL and size (in bytes) for a download task (typically under a property like "dltar").
alert
object 
optional
An optional object in case of an exception details (for instance, HTTP download failure information or file read errors) if the task encountered warnings or issues.
Example
{
  "status": "success",
  "task": {
    "name": "ExampleOrg-sushi-0003-1739273968-dltar",
    "appName": "sushi",
    "buildName": "0003",
    "taskType": "dltar",
    "status": "failed",
    "steps": {
      "created": "2025-02-11T11:39:31.541Z",
      "started": "2025-02-11T11:40:16.504Z",
      "finished": "2025-02-11T11:40:52.577Z"
    },
    "userData": {
      "dltar": {
        "url": "https://rockitplay-demo.akamaized.net/engine-fixtures/sushi/native-build.tar?token=exp=2041235666~acl=/engine-fixtures/sushi/*~hmac=df869da8c71a05f6a77ee7ed5a5902abd76e22734953d976973d6748d14beaf4",
        "sizeBytes": 1788272645
      }
    },
    "alert": {
      "exception": {
        "httpDownloadFailed": {
          "sizeBytesActual": 178827264,
          "sizeBytesExpected": 1788272645
        }
      }
    }
  }
}
🟠400400: missing-param
🟠401401: token-expired
Previous
Listing Tasks
Next
Acknowledge Warning / Expire Task
Built with