ROCKITPLAY API
  1. Triggers
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
        POST
      • Retry Task
        POST
    • Tasks
      • Listing Tasks
      • Task Details
      • Acknowledge Warning / Expire Task
    • Subscriptions
      • Subscribe
      • List Subscriptions
      • Unsubscribe
    • Roles
      • List Roles
      • Create Role
      • Patch Role
      • Role Details
      • Delete Roles
  • Changelog
    • Changelog
  1. Triggers

Retry Task

POST
https://Example-Server.com/be/v1/trigger
Last modified:2025-05-08 12:00:04
This endpoint is used to retry a failed task in ROCKIT Edge. If a task has failed due to incorrect parameters or a temporary issue, this endpoint allows triggering a retry after the issue has been resolved.
There are various issues which may cause a deployment task to fail such as:
invalid Deployment parameters (such as credentials)
destination origin is temporarily not reachable.
If a deployment task fails the App goes into an error state until the issue has been resolved. If the Deployment has invalid parameters please fix it first (see Modify Deployment) and invoke this endpoint.
It the destination origin is not reachable please contact the origin's administrator / support. Once the issue has been resolved initiate a retry by invoking this endpoint.

Required Permissions#

trigger.create
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)
Example:
{{_edge_org_admin_beauth_token}}
x-rockit-orgname
string 
optional
Example:
{{EDGE_ORG_NAME}}
x-rockit-username
string 
optional
Example:
adminPrincipal
x-rockit-api-key
string 
optional
Example:
{{_adminPrincipal_apiKey}}
Body Params application/json
retry
object 
required
Type of event, here: 'retry' for retrying a failed task.
taskName
string 
required
Identifier of the Task.
Example
{
  "retry": {
    "taskName": "exampleTask"
  }
}

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 POST 'https://Example-Server.com/be/v1/trigger' \
--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 '{
    "retry": {
        "taskName": "exampleTask"
    }
}'

Responses

🟢200Success
application/json
Body
statusCode
integer 
required
An integer (typically 200) indicating that the retry request was accepted.
status
string 
required
A string confirming that the retry operation was successful.
message
string 
required
A confirmation message (such as "publish task triggered") that indicates the retry action has been initiated.
Example
{
  "statusCode": 200,
  "status": "success",
  "message": "publish task triggered"
}
🟠400Invalid Param
🟠401Unauthorized
Previous
Process Traces
Next
Listing Tasks
Built with