Get Deployments

GET

https://Example-Server.com/be/v1/deployments

Last modified:2025-05-08 12:00:04

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.

Filtering & Sorting

Deployments can be filtered by name (supports partial matches), error status, and paginated using offset and limit.
Sorting is supported based on fields like name, label, created, and updated, with optional ascending/descending order.

Required Permissions

deployments.read

See Roles for more details.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://Example-Server.com/be/v1/deployments?offset=0&limit=10&name=example_deployment&error=true&order[]=-name' \
--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",
    "totalCount": 1,
    "deployments": [
        {
            "name": "testAkamaiDeployment",
            "label": "testAkamaiDeployment",
            "origin": {
                "netstorage": {
                    "hostname": "rockit-edge-test-nsu.akamaihd.net"
                }
            },
            "dlAuth": {
                "akamai": {
                    "hostname": "rockit-edge-test.akamaized.net"
                }
            }
        }
    ]
}

🟠400Invalid Param

🟠401Unauthorized

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

Creating Deployments

Get Deployment Details