ROCKITPLAY API
  1. ROCKIT Edge - Admin API
ROCKITPLAY API
  • ROCKIT Edge - Admin API
    • Installation / Upgrade
      • get versions
      • 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
  • Schemas
    • Webhook Request Body
    • Import UrlSchema
  1. ROCKIT Edge - Admin API

Minimal Tests

Initial Installation#

Install the ROCKITPLAY Cloud Service following the instructions provided at Github.

Upgrade#

Before upgrading the ROCKITPLAY OCI Stack please switch the instance to the maintenance mode:
Login to the OCI Console
Navigate to Stacks, select the proper OCI Compartment, and select the ROCKITPLAY Stack.
Click on "Edit Variables" and select "Maintenance Mode".
Apply and wait until the apply job has concluded.
The ROCKITPLAY Cloud Service is now in maintenance mode. External requests are replied with an HTTP status code 429.
Pull the latest changes of the ROCKITPLAY OCI Stack from the Github repository.
cd rockitplay
git pull
Upgrade the ROCKITPLAY OCI Stack in the OCI Console:
Navigate to the ROCKITPLAY OCI Stack
Click on "Edit Stack".
Drag and drop the updated git folder, e.g., rockitplay to the stack.
Edit and check OCI Stack input variables.
Save
Execute "Plan" and read its output carefully. In particular, check for unwanted "destroy" operations.
If you agree with the plan, run "Apply"
After the update please verify the basic functionality as described in this section, i.e.,
Execute POST /srv/v1/ping to check the communication between ROCKIT Edge and ROCKIT Engine.
Run a test task ("hello world") by calling POST /srv/v1/hello to check the compute resource handling.
Note, that the ROCKITPLAY Cloud Instance is still in maintenance mode. Once the basic tests have succeeded please disable the maintenance mode in the OCI Console to resume normal operations:
Navigate to Stacks, select the proper OCI Compartment, and select the ROCKITPLAY Stack.
Click on "Edit Variables" and deselect "Maintenance Mode".
Apply and wait until the apply job has concluded.
Modified at 2026-01-26 14:38:17
Previous
ROCKIT Edge - Admin API
Next
get versions
Built with