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

Get Deployment Details

GET
https://Example-Server.com/be/v1/deployments/{deployment}
Last modified:2025-05-08 12:00:04
This endpoint retrieves details of a specific ROCKIT Edge deployment by its unique identifier. The response includes the deployment status and a descriptive message.

Required Permissions#

deployments.read
See Roles for more details.

Request

Path Params
deployment
string 
required
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 GET 'https://Example-Server.com/be/v1/deployments/' \
--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

🟢200200: success
application/json
Body
status
string 
required
A string indicating the successful retrieval of the specified deployment’s details.
deployment
object 
required
An object containing the deployment’s details including:
name
string 
required
The deployment’s unique identifier.
label
string 
required
The descriptive label of the deployment.
origin
object 
required
An object that details the origin configuration (e.g., netstorage settings such as hostname, upload account, cpCode, and prefix).
dlAuth
object 
required
An object that contains download authentication details (e.g., for Akamai, the hostname and prefix).
Example
{
  "status": "success",
  "deployment": {
    "name": "testAkamaiDeployment",
    "label": "testAkamaiDeployment",
    "origin": {
      "netstorage": {
        "hostname": "rockit-edge-test-nsu.akamaihd.net",
        "uploadAccount": "exampleAccount",
        "cpCode": 555,
        "prefix": "examplePrefix"
      }
    },
    "dlAuth": {
      "akamai": {
        "hostname": "rockit-edge-test.akamaized.net",
        "prefix": "examplePrefix"
      }
    }
  }
}
🟠400Invalid Param
🟠401Unauthorized
Previous
Get Deployments
Next
Modify Deployment
Built with