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

Acknowledge Warning / Expire Task

PATCH
https://Example-Server.com/be/v1/tasks
Last modified:2025-05-08 12:00:04
This endpoint allows you to acknowledge warnings or expire upload tasks in ROCKIT Edge.
Warnings do not block execution but signal potential issues. Acknowledging a warning marks it as reviewed but does not fix the root cause. The warning will remain visible until the issue is resolved and the process retried.
In addition to acknowledging warnings, this endpoint also allows you to expire upload tasks. Expiring a task is necessary when something goes wrong during the upload process—such as exceptions, failed transfers, or incomplete data. Expiring a task also automatically acknowledges its warning.

Use this when:#

You want to track which warnings have been reviewed.
You need to differentiate between new and previously acknowledged warnings.
An upload task failed, and you need to manually expire it to prevent further issues or to allow for cleanup/retry.

Important:#

Acknowledging a warning does not retry or fix the task. If the task is in an error state, you must correct the issue and trigger a retry where applicable.
Expiring a task marks it as failed and acknowledged, but does not automatically trigger a new upload—you must manually retry or restart the process if needed.

Required Permissions#

tasks.update
See Roles for more details.

Request

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}}
Body Params application/json
name
string 
required
Unique and immutable identifier of the task.
Match pattern:
/^[A-Za-z0-9_[\]]{2,50}$/
acknowledged
boolean 
optional
Bool to acknowledge the warning of a specific task
expired
boolean 
optional
Bool to expire a upload task. This also automaitcally acknowledges the warning.
Example
{
  "name": "exampleTaskname",
  "acknowledged": true,
  "expired": true
}

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 PATCH '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}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "exampleTaskname",
    "acknowledged": true,
    "expired": true
}'

Responses

🟢200200: success
application/json
Body
status
string 
required
Indicates that the request to acknowledge warnings on tasks was successful.
totalCount
integer 
required
An integer representing the total number of tasks after the acknowledgment.
tasks
array [object {3}] 
required
An array of task summary objects (each containing key details such as task name, service, and status) that reflects the updated state after acknowledging warnings.
name
string 
required
service
string 
required
status
string 
required
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
Task Details
Next
Subscribe
Built with