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

Body Params application/json

Example
{
    "name": "exampleTaskname",
    "acknowledged": true,
    "expired": true
}

Request Code 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

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
Modified at 2025-05-08 12:00:04
Previous
Task Details
Next
Subscribe
Built with