ROCKITPLAY API
  1. Minimal Tests
ROCKITPLAY API
  • ROCKIT Edge - Admin API
    • Minimal Tests
      • ping
        POST
      • submit test task
        POST
    • 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
      • 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. Minimal Tests

submit test task

POST
https://Example-Server.com/adm/v1/hello
Last modified:2025-04-24 15:52:08
Besides the lambda function test (POST /adm/v1/ping) the task submission and execution can be verified by invoking POST /adm/v1/hello. This endpoint schedules a simple "Hello World" compute task verifying the correct configuration of OCI with respect to:
compute resource configuration and
compute resource usage authentication.

Request

Header Params
x-rockit-admin-token
string 
required
Example:
{{EDGE_ADMIN_TOKEN}}
Body Params application/json
message
string 
required
maintenance
boolean 
required
Example
{
  "message": "hello",
  "maintenance": false
}

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/adm/v1/hello' \
--header 'x-rockit-admin-token: eyAHFjsnk...' \
--header 'Content-Type: application/json' \
--data-raw '{
    "message": "hello",
    "maintenance": false
}'

Responses

🟢200OK
application/json
Body
status
string 
required
Indicates that the test task submission was successful.
message
string 
required
Provides a confirmation note, verifying that the task submission has been processed correctly.
Example
{
  "status": "success",
  "message": "hello task submitted"
}
🟠401Unauthorized
🟠400Invalid Param
Previous
ping
Next
Create Organization
Built with