ROCKITPLAY API
  1. Deployments
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
      • authentication
    • Account Management
      • get user details
      • list users
      • Modify user
      • delete users
      • Create User / Create Machine User
    • Deployments
      • Creating Deployments
        POST
      • Get Deployments
        GET
      • Get Deployment Details
        GET
      • Modify Deployment
        PATCH
      • Deleting Deployments
        DELETE
    • 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. Deployments

Deleting Deployments

DELETE
https://Example-Server.com/be/v1/deployments/{DEPLOYMENT_NAME}
Last modified:2025-05-08 12:00:04
This endpoint deletes a deployment from the ROCKIT Edge. Deletion is only possible, if the deployment is not registered to any app.
Note, that endpoint will remove all published files from the origin storage of the specified deployment.

Required Permissions#

deployments.delete
See Roles for more details.

Request

Path Params
DEPLOYMENT_NAME
string 
required
Example:
gcore
Match pattern:
/^[A-Za-z0-9_[\]]{2,50}$/
Header Params
x-rockit-beauth-token
string 
optional
ROCKIT Edge backend authentication token (POST /be/v1/auth) or API key (POST /be/v1/apikeys)
Mutually excluded with x-rockit-api-key.
Example:
{{_edge_org_admin_beauth_token}}
x-rockit-orgname
string 
optional
Unique and immutable organization identifier obtained from the ROCKIT Edge administrator.
Requires x-rockit-username and x-rockit-api-key.
Example:
{{EDGE_ORG_NAME}}
x-rockit-username
string 
optional
Unique and immutable username which is accociated with the apikey.
Requires x-rockit-orgname and x-rockit-api-key.
Example:
adminPrincipal
x-rockit-api-key
string 
optional
Unique and immutable apikey which is accociated with an machine user.
Mutually excluded with x-rockit-beauth-token. Requires x-rockit-username and x-rockit-orgname.
Example:
{{_adminPrincipal_apiKey}}

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 DELETE 'https://Example-Server.com/be/v1/deployments/gcore' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}'

Responses

🟢200Success
application/json
Body
status
string 
required
A string confirming that the deletion operation was successful.
message
string 
required
A confirmation message (e.g., "deployment deleted") indicating that the specified deployment has been removed.
Example
{
  "status": "success",
  "message": "deployment deleted"
}
🟠400Missing-Param
🟠401Unauthorized
🟠409Item Protected
Previous
Modify Deployment
Next
Apps
Built with