# Get Deployments
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/be/v1/deployments:
get:
summary: Get Deployments
deprecated: false
description: >-
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](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more details.
tags:
- ROCKIT Edge - Backend API/Deployments
parameters:
- name: error
in: query
description: Filter by error status.
required: false
example: 'true'
schema:
type: boolean
- name: offset
in: query
description: Pagination offset.
required: false
example: 0
schema:
type: integer
- name: limit
in: query
description: Pagination limit.
required: false
example: 10
schema:
type: integer
- name: order[]
in: query
description: >-
Sorting order. Supported fields for sorting:
name,label,created,updated. +/- for Ascending/Descending (no +/-
results in ascending order)
required: false
example: '-name'
schema:
type: string
- name: Authorization
in: header
description: >-
Use the access token obtained from [`POST
/be/v1/login`](https://edge.api.cloud.rockitplay.com/user-login-org-11611254e0.md)
or [`POST
/be/v1/refresh`](https://edge.api.cloud.rockitplay.com/refresh-11630082e0.md)
as Bearer token.
Mutually excluded with `x-rockit-api-key`.
required: true
example: Bearer {{_edge_org_admin_access_token}}
schema:
type: string
- name: x-rockit-tenant
in: header
description: >
Unique and immutable tenancy identifier obtained from the ROCKIT
Edge administrator.
Requires `x-rockit-username`,
`x-rockit-orgname` and `x-rockit-api-key`.
required: true
example: '{{EDGE_TENANT_NAME}}'
schema:
type: string
- name: x-rockit-orgname
in: header
description: >
Unique and immutable organization identifier obtained from the
ROCKIT Edge administrator.
Requires `x-rockit-tenant`,
`x-rockit-username` and `x-rockit-api-key`.
required: true
example: '{{EDGE_ORG_NAME}}'
schema:
type: string
- name: x-rockit-username
in: header
description: >
Unique and immutable username which is associated with the apikey.
Requires `x-rockit-tenant`, `x-rockit-orgname` and
`x-rockit-api-key`.
required: true
example: adminPrincipal
schema:
type: string
- name: x-rockit-api-key
in: header
description: >-
Unique and immutable apikey which is associated with an machine
user.
Mutually excluded with `Authorization` header. Requires
`x-rockit-tenant`, `x-rockit-username` and `x-rockit-orgname`.
required: true
example: '{{_adminPrincipal_apiKey}}'
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Indicates that the request to retrieve deployments was
successful.
totalCount:
type: integer
description: >-
An integer representing the total number of deployments
matching the query.
deployments:
type: array
items:
type: object
properties:
name:
type: string
description: The unique identifier of the deployment.
label:
type: string
description: A human-friendly label for the deployment.
origin:
type: object
properties:
netstorage:
type: object
properties:
hostname:
type: string
required:
- hostname
x-apidog-orders:
- hostname
x-apidog-ignore-properties: []
required:
- netstorage
x-apidog-orders:
- netstorage
description: An object containing origin configuration details.
x-apidog-ignore-properties: []
dlAuth:
type: object
properties:
akamai:
type: object
properties:
hostname:
type: string
required:
- hostname
x-apidog-orders:
- hostname
x-apidog-ignore-properties: []
required:
- akamai
x-apidog-orders:
- akamai
description: An object with download authentication details.
x-apidog-ignore-properties: []
x-apidog-orders:
- name
- label
- origin
- dlAuth
x-apidog-ignore-properties: []
description: 'An array of deployment objects where each includes:'
required:
- status
- totalCount
- deployments
x-apidog-orders:
- status
- totalCount
- deployments
x-apidog-ignore-properties: []
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
headers: {}
x-apidog-name: '200: success'
'400':
description: ''
content:
application/json:
schema:
title: ''
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more
invalid or missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example,
"name invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected
pattern for the organization name)
x-apidog-orders:
- 01JQNH1MCX8M6D0PMYS5F3FDB9
required:
- status
- error
- message
- detail
x-apidog-refs:
01JQNH1MCX8M6D0PMYS5F3FDB9:
$ref: '#/components/schemas/Invalid%20Param'
x-apidog-ignore-properties:
- status
- error
- message
- detail
headers: {}
x-apidog-name: Invalid Param
'401':
description: ''
content:
application/json:
schema:
title: ''
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was
rejected because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose
the failure.
x-apidog-orders:
- 01JQNH0YE3Z8M96351KBP0Y9K0
required:
- status
- error
- message
x-apidog-refs:
01JQNH0YE3Z8M96351KBP0Y9K0:
$ref: '#/components/schemas/unauthorized'
x-apidog-ignore-properties:
- status
- error
- message
headers: {}
x-apidog-name: Unauthorized
security: []
x-apidog-folder: ROCKIT Edge - Backend API/Deployments
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/732774/apis/api-12670904-run
components:
schemas:
unauthorized:
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was rejected
because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose the
failure.
required:
- status
- error
- message
x-apidog-orders:
- status
- error
- message
x-apidog-ignore-properties: []
x-apidog-folder: ''
Invalid Param:
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more invalid or
missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example, "name
invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected pattern for the
organization name)
required:
- status
- error
- message
- detail
x-apidog-orders:
- status
- error
- message
- detail
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
Bearer token:
type: bearer
scheme: bearer
description: >-
Enter your Access Token. You can obtain this by calling the /be/v1/login
endpoint. Use the Refresh token to get a new Access token when it
expires.
servers:
- url: https://Example-Server.com
description: Default
security: []
```