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

ping

POST
https://Example-Server.com/adm/v1/ping
Last modified:2025-04-24 15:52:08
After a deployment of a ROCKIT Edge instance it is recommended to verify that the endpoints can be reached. As simple test please invoke POST /adm/v1/ping which verifies
the proper API Gateway configuration
Lambda function configuration
OCI authentication
Database access
Slack notification

Request

Header Params
Content-Type
string 
required
Example:
application/json

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/ping' \
--header 'Content-Type: application/json'

Responses

🟢200Success
application/json
Body
status
string 
required
Indicates that the ping request was successful.
message
string 
required
Returns a confirmation message (typically "pong") to signal that the API is reachable and operational.
Example
{
    "status": "success",
    "message": "pong"
}
🟠401Unauthorized
Modified at 2025-04-24 15:52:08
Previous
Minimal Tests
Next
submit test task
Built with