Get Deployments

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

offset

integer

optional

Pagination offset.

Example:

limit

integer

optional

Pagination limit.

Example:

name

string

optional

Filter by deployment name (supports partial matches, case sensitive).

Example:

example_deployment

error

boolean

optional

Filter by error status.

Example:

true

order[]

string

optional

Sorting order. Supported fields for sorting: name,label,created,updated. +/- for Ascending/Descending (no +/- results in ascending order)

Example:

-name

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:

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:

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:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200: success

application/json

Body

status

string

required

Indicates that the request to retrieve deployments was successful.

totalCount

integer

required

An integer representing the total number of deployments matching the query.

deployments

array [object {4}]

required

An array of deployment objects where each includes:

name

string

optional

The unique identifier of the deployment.

label

string

optional

A human-friendly label for the deployment.

origin

object

optional

An object containing origin configuration details.

dlAuth

object

optional

An object with download authentication details.

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

Filtering & Sorting#

Required Permissions#

Request

Request samples

Responses

Filtering & Sorting

Required Permissions