# ROCKITPLAY API

## Docs
- [ROCKIT Edge - Admin API](https://edge.api.cloud.rockitplay.com/rockit-edge-admin-api-2441430f0.md): 
- ROCKIT Edge - Admin API [Minimal Tests](https://edge.api.cloud.rockitplay.com/minimal-tests-2440983f0.md): 
- [ROCKIT Edge - Backend API](https://edge.api.cloud.rockitplay.com/rockit-edge-backend-api-2442704f0.md): 
- ROCKIT Edge - Backend API [Authentication](https://edge.api.cloud.rockitplay.com/authentication-2442708f0.md): 
- ROCKIT Edge - Backend API [Account Management](https://edge.api.cloud.rockitplay.com/account-management-2442900f0.md): 
- ROCKIT Edge - Backend API [Deployments](https://edge.api.cloud.rockitplay.com/deployments-2442901f0.md): 
- ROCKIT Edge - Backend API [Apps](https://edge.api.cloud.rockitplay.com/apps-2442903f0.md): 
- ROCKIT Edge - Backend API [Roles](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md): 
- Changelog [Changelog](https://edge.api.cloud.rockitplay.com/changelog-807395m0.md): 

## API Docs
- ROCKIT Edge - Admin API > Minimal Tests [ping](https://edge.api.cloud.rockitplay.com/ping-11591046e0.md): 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
- ROCKIT Edge - Admin API > Minimal Tests [submit test task](https://edge.api.cloud.rockitplay.com/submit-test-task-11591048e0.md): 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:
- ROCKIT Edge - Admin API > Admin Edge Organizations [Create Organization](https://edge.api.cloud.rockitplay.com/create-organization-14082424e0.md): This endpoint allows you to create a new organization in ROCKIT Edge, along with a default role 'Administrators' and its primary administrator user account. On success, it will return the initial password of the organization's administrator user. 
- ROCKIT Edge - Admin API > Admin Edge Organizations [Delete Organization](https://edge.api.cloud.rockitplay.com/delete-organization-14082425e0.md): This function deletes all data of an ROCKIT Edge organization.
- ROCKIT Edge - Backend API > Backend Edge Organizations [Create Organization](https://edge.api.cloud.rockitplay.com/create-organization-11591049e0.md): This endpoint enables the creation of a new organization in the ROCKIT Backend Edge, including a default 'Administrators' role and an associated primary administrator user. Upon successful creation, the response includes the initial password for the administrator user. 
- ROCKIT Edge - Backend API > Backend Edge Organizations [Delete Organization](https://edge.api.cloud.rockitplay.com/delete-organization-11591050e0.md): This function deletes all data of an ROCKIT Edge organization.
- ROCKIT Edge - Backend API > Authentication [user login](https://edge.api.cloud.rockitplay.com/user-login-11611254e0.md): This endpoint allows a user to obtain a session token. The session token is valid for 24h. It is used to create short-time auth tokens which will grant access to the protected endpoints of the ROCKIT Edge API.
- ROCKIT Edge - Backend API > Authentication [authentication](https://edge.api.cloud.rockitplay.com/authentication-11630082e0.md): This endpoint allows users with a valid backend user session token (`POST /be/v1/login`) to obtain a backend authentication token.
- ROCKIT Edge - Backend API > Account Management [get user details](https://edge.api.cloud.rockitplay.com/get-user-details-15070687e0.md): This endpoint allows you to list the details of an user of your organiztion on the ROCKIT Edge.
- ROCKIT Edge - Backend API > Account Management [list users](https://edge.api.cloud.rockitplay.com/list-users-15070688e0.md): This endpoint allows you to list the details of all users of your organiztion on the ROCKIT Edge.
- ROCKIT Edge - Backend API > Account Management [Modify user](https://edge.api.cloud.rockitplay.com/modify-user-15071473e0.md): This endpoint allows to modify a user in your  ROCKIT Edge Organization. You can modify the following fields:
- ROCKIT Edge - Backend API > Account Management [delete users](https://edge.api.cloud.rockitplay.com/delete-users-11634344e0.md): This endpoint deletes a user.
- ROCKIT Edge - Backend API > Account Management [Create User / Create Machine User](https://edge.api.cloud.rockitplay.com/create-user-create-machine-user-16603181e0.md): This endpoint creates either a machine account to integrate the ROCKIT Edge Backend API into existing automated workflows or a user account.
- ROCKIT Edge - Backend API > Deployments [Creating Deployments](https://edge.api.cloud.rockitplay.com/creating-deployments-11747958e0.md): This endpoint registers a new ROCKIT Edge deployment. A deployment must contain an origin configuration describing where the generated ROCKIT Images and ROCKIT Patches should be published.
- ROCKIT Edge - Backend API > Deployments [Get Deployments](https://edge.api.cloud.rockitplay.com/get-deployments-12670904e0.md): This endpoint retrieves a list of ROCKIT Edge deployments, allowing for filtering and sorting based on various parameters. The response includes deployment details, which can be paginated and filtered to show specific deployments based on their name, error status, or creation/update timestamps.
- ROCKIT Edge - Backend API > Deployments [Get Deployment Details](https://edge.api.cloud.rockitplay.com/get-deployment-details-12672792e0.md): This endpoint retrieves details of a specific ROCKIT Edge deployment by its unique identifier. The response includes the deployment status and a descriptive message.
- ROCKIT Edge - Backend API > Deployments [Modify Deployment](https://edge.api.cloud.rockitplay.com/modify-deployment-11695719e0.md): This endpoint allows for modifying an existing ROCKIT Edge deployment. Provide those parameters which should be changed. Optional resource paramers can be removed by setting them to `null`.
- ROCKIT Edge - Backend API > Deployments [Deleting Deployments](https://edge.api.cloud.rockitplay.com/deleting-deployments-11634351e0.md): This endpoint deletes a deployment from the ROCKIT Edge.  Deletion is only possible, if the deployment is not registered to any app.
- ROCKIT Edge - Backend API > Apps [Creating Apps](https://edge.api.cloud.rockitplay.com/creating-apps-11634354e0.md): This endpoint allows you to register a new app to the ROCKIT Edge.
- ROCKIT Edge - Backend API > Apps [Import native builds](https://edge.api.cloud.rockitplay.com/import-native-builds-11634363e0.md): This endpoint adds a new game build to an existing app. Once imported it will automatically generate
- ROCKIT Edge - Backend API > Apps [App Details](https://edge.api.cloud.rockitplay.com/app-details-11779561e0.md): This endpoint allows you to list the details of an app of your organiztion on the ROCKIT Edge.
- ROCKIT Edge - Backend API > Apps [List Apps](https://edge.api.cloud.rockitplay.com/list-apps-13039645e0.md): This endpoint allows you to list the details of all apps of your organiztion on the ROCKIT Edge.
- ROCKIT Edge - Backend API > Apps [patch app](https://edge.api.cloud.rockitplay.com/patch-app-13880924e0.md): This endpoint is used to update an existing app with specific settings and configurations. The settings can include:
- ROCKIT Edge - Backend API > Apps [Delete Apps](https://edge.api.cloud.rockitplay.com/delete-apps-11634364e0.md): This endpoint deletes an app along with all stored ROCKIT Images and ROCKIT Patches.
- ROCKIT Edge - Backend API > Triggers [Process Traces](https://edge.api.cloud.rockitplay.com/process-traces-12373257e0.md): This endpoint triggers traces processing for a given App. Traces collected from the users will be used to determine whether a new DxF image should be build by checking whether the quality or the preload has improved for your users.
- ROCKIT Edge - Backend API > Triggers [Retry Task](https://edge.api.cloud.rockitplay.com/retry-task-12373263e0.md): 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.
- ROCKIT Edge - Backend API > Tasks [Listing Tasks](https://edge.api.cloud.rockitplay.com/listing-tasks-11779680e0.md): This endpoint allows you to list all ongoing tasks of your organization on the ROCKIT Edge. Tasks can be filtered by various parameters, including app name, task group, status, type, and creation date. The response can also be paginated and sorted.
- ROCKIT Edge - Backend API > Tasks [Task Details](https://edge.api.cloud.rockitplay.com/task-details-13899616e0.md): This endpoint allows you to list details of a specific task, including status and exceptions.
- ROCKIT Edge - Backend API > Tasks [Acknowledge Warning / Expire Task](https://edge.api.cloud.rockitplay.com/acknowledge-warning-expire-task-13268279e0.md): This endpoint allows you to acknowledge warnings or expire upload tasks in ROCKIT Edge.
- ROCKIT Edge - Backend API > Subscriptions [Subscribe](https://edge.api.cloud.rockitplay.com/subscribe-14052754e0.md): This endpoint can be used to subscribe your webservice or slack channel to events emitted from the ROCKIT Edge. This is useful when you want react to state changes on your apps automatically via a Webhook, e.g. when the deployment of a DxF Image finished or an error occurred while deploying the app. Or you want to be in the loop by the ROCKIT-Edge sending you Slack messages.
- ROCKIT Edge - Backend API > Subscriptions [List Subscriptions](https://edge.api.cloud.rockitplay.com/list-subscriptions-14052806e0.md): This endpoint can be used to list all the Organization's subscriptions of events on the ROCKIT Edge. 
- ROCKIT Edge - Backend API > Subscriptions [Unsubscribe](https://edge.api.cloud.rockitplay.com/unsubscribe-14052807e0.md): This endpoint can be used to un-subscribe your webservice or slack channel from events emitted from the ROCKIT Edge. Provide the `name` of your Subscription to unsubscribe from all events from the sender .
- ROCKIT Edge - Backend API > Roles [List Roles](https://edge.api.cloud.rockitplay.com/list-roles-16569595e0.md): This endpoint allows you to list the details of all roles of your organiztion on the ROCKIT Edge.
- ROCKIT Edge - Backend API > Roles [Create Role](https://edge.api.cloud.rockitplay.com/create-role-16569598e0.md): This endpoint creates a role in your  ROCKIT Edge Organization.
- ROCKIT Edge - Backend API > Roles [Patch Role](https://edge.api.cloud.rockitplay.com/patch-role-16569733e0.md): This endpoint creates a role in your  ROCKIT Edge Organization. You can modify the following permissions:
- ROCKIT Edge - Backend API > Roles [Role Details](https://edge.api.cloud.rockitplay.com/role-details-16569594e0.md): This endpoint allows you to list the details of a role of your organiztion on the ROCKIT Edge.
- ROCKIT Edge - Backend API > Roles [Delete Roles](https://edge.api.cloud.rockitplay.com/delete-roles-16569592e0.md): This endpoint deletes a role.