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

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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

Modified at 2025-05-08 12:00:04

Get Deployments

Modify Deployment

Get Deployment Details

Required Permissions#

Request

Request Code Samples

Responses

Required Permissions