ROCKITPLAY API
  1. Changelog
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 (user+pw+org)
      • Authentication
    • Account Management
      • get user details
      • list users
      • Modify user
      • delete users
      • Create User / Create Machine User
      • Create User / Create Machine User Copy
    • 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
      • Task Details
      • Acknowledge Warning / Expire Task
    • Subscriptions
      • Subscribe
      • List Subscriptions
      • Unsubscribe
    • Roles
      • List Roles
      • Create Role
      • Patch Role
      • Role Details
      • Delete Roles
    • API Keys
      • Create API Key
      • Delete API Key
    • Commit
      • Commit
  • Changelog
    • Changelog
  1. Changelog

Changelog

2025-11-04#

Fixes in API documentation
Improved stability

2025-10-15#

New user management:
Backend and frontend users have been combined. There are only instance-wide cross-organization ROCKITPLAY users now. Hence, the resource beUsers is now referred to as users. This affects most /be/v1//roles endpoints.
Users are invited by email when created (POST /adm/v1/orgs or POST /be/v1/users). Passwords are now entirely controlled by the users and not by the ROCKITPLAY organization admin anymore.
Invitation emails can be re-send using PATCH /be/v1/users with {sendInvitation:true}
User's can trigger a password reset using the new endpoint POST /be/v1/resetpw.
Improved stability

2025-05-08#

Introducing Roles for managing permissions for user.

Modified Endpoints#

POST /be/v1/users
fixed response schema
POST /be/v1/deployments
added information about supported AWS S3 origins
PATCH /be/v1/deployments
added information about request header parameters hostname, location, bucket, and prefix for AWS S3
POST /be/v1/subscriptions
removed success event
added events end and exception

Added Endpoints#

GET /be/v1/keys
List available access keys
GET /be/v1/trainings
Returns current training statistics information

2025-05-08#

Introducing Roles for managing permissions for user.

Modified Endpoints#

PATCH /be/v1/apps
No longer supports the following params:
nTracesReliable
minCoverage
maxCoverage
minTraceTimeSec
nProcessTracesMin
uploadTrace
POST /be/v1/users
Now supports creation of user with roles. It still supports the creation of machine user.

Added Endpoints#

GET /be/v1/users
GET /be/v1/users/{username}
PATCH /be/v1/users
DELETE /be/v1/users
POST /be/v1/User
GET /be/v1/roles/{username}
GET /be/v1/roles
PATCH /be/v1/roles
DELETE /be/v1/roles

2025-04-24#

Modified Endpoints#

PATCH /be/v1/Tasks
Added the ability to expire upload tasks by using the optional body parameter expire.

Removed Endpoints#

POST /adm/v1/initialize
From now on the initialization will be invoked automatically by the service and there is no need to invoke it manually anymore.

2025-03-11#

Modified Endpoints#

POST /be/v1/apps
Removed body parameter needed only for Rockit-Streaminstaller. Removed parameters are:exePath and shortcut.
PAT /be/v1/apps
Removed body parameter needed only for Rockit-Streaminstaller. Removed parameters are:exePath and shortcut.

2025-02-19#

Modified Endpoints#

POST /be/v1/deployments
Updated behavior: Import requests (POST /builds) now always publish on a depot. If an app is registered with a deployment, it will also be deployed there.
GET /be/v1/apps
Updated error state handling: If an app deployment fails, it will now be marked as error instead of remaining in processing.
Added error query parameter to filter apps in an error state.
PATCH /be/v1/deployments
Updated deployment credential handling: If credentials were incorrect, updating them now allows Retry Task to reattempt failed tasks.
GET /be/v1/tasks
Introduced detailed failure indicators for debugging import errors.
If an import fails due to an incorrect URL, wrong sizeBytes, or an invalid tarball, you can now inspect GET /tasks/{taskId} for potential exceptions and errors.
POST /be/v1/trigger
Retry is now only possible after fixing the cause of failure.

Added Endpoints#

POST /be/v1/orgs
Introducing a backend variant of creating organizations.
DELETE /be/v1/orgs
Introducing a backend variant of deleting organizations.
POST /be/v1/trigger
This endpoint initializes the processing of collected traces.
PATCH /be/v1/tasks/acknowledge-warning
Endpoint to acknowledge warnings.
POST /be/v1/subscriptions
This endpoint can be used to subscribe your webservice or slack channel to events emitted from the ROCKIT Edge.
DELETE /be/v1/subscriptions/{{subscriptionName}}
This endpoint can be used to un-subscribe your webservice or slack channel from events emitted from the ROCKIT Edge.
GET /be/v1/subscriptions
This endpoint can be used to list all the Organization's subscriptions of events on the ROCKIT Edge.

2025-01-15#

Modified Endpoints#

DELETE /adm/v1/orgs DELETE /adm/v1/orgs/{ORG_NAME}
Modified: Request body parameters are now path and/or query parameter
DELETE /be/v1/users DELETE /be/v1/users/{USER_NAME}
Modified: Request body parameters are now path and/or query parameter
DELETE /be/v1/deployments DELETE /be/v1/deployments/{DEPLOYMENT_NAME}
Modified: Request body parameters are now path and/or query parameter
DELETE /be/v1/apps DELETE /be/v1/apps/{appname}
Modified: Request body parameters are now path and/or query parameter
GET /be/v1/apps
Introduced pagination with offset and limit query parameters. Added support for filtering via name, processing, and exporting query parameters. Sorting is now supported via the order query parameter. Order supports sorting by the following fields: name, label, created, updated
GET /be/v1/apps/{APP_NAME}
Supports query parameter fields to selectively retrieve specific fields of an app. The available fields are:name, label, iCurBuild, maxBuilds, processing, exporting, sizeBytes, created, updated, deployed, dxfName, files, shortcut, appDataPath, execPath, nKeys, nTraces
GET /be/v1/tasks
Introduced pagination with offset and limit query parameters. Added support for filtering via the following query parameters: appName, taskTypes, status, created, order

Added Endpoints#

GET /be/v1/deployments
New Endpoint introduced with pagination (offset and limit query parameters). Support for filtering via error query parameter. Sorting is supported via the order query parameter. Order supports the field name.
GET /be/v1/deployments/{DEPLOYMENT_NAME}
Response to include details based on deployment configurations.
Modified at 2025-11-09 20:35:37
Previous
Commit
Built with