# Deleting Deployments
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/be/v1/deployments/{DEPLOYMENT_NAME}:
delete:
summary: Deleting Deployments
deprecated: false
description: >-
This endpoint deletes a deployment from the ROCKIT Edge. Deletion is
only possible, if the deployment is not registered to any app.
Note, that endpoint will remove all published files from the origin
storage of the specified deployment.
### Required Permissions
`deployments.delete`
See [Roles](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more details.
tags:
- ROCKIT Edge - Backend API/Deployments
parameters:
- name: DEPLOYMENT_NAME
in: path
description: ''
required: true
example: gcore
schema:
type: string
pattern: /^[A-Za-z0-9_[\]]{2,50}$/
- 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: >-
A string confirming that the deletion operation was
successful.
message:
type: string
description: >-
A confirmation message (e.g., "deployment deleted")
indicating that the specified deployment has been removed.
required:
- status
- message
x-apidog-orders:
- status
- message
x-apidog-ignore-properties: []
examples:
'1':
summary: '200: success'
value:
status: success
message: deployment deleted
'2':
summary: '400: missing-param'
value:
status: failed
error: missing-param
message: x-rockit-beauth-token missing
detail: header parameter x-rockit-beauth-token is required
'3':
summary: '409: item-protected'
value:
status: failed
error: item-protected
message: cannot delete deployment
detail: last valid deployment must not be deleted
headers: {}
x-apidog-name: Success
'400':
description: ''
content:
application/json:
schema:
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:
- 01JQNH3W9YVFVMV9HPNZV2YGRX
required:
- status
- error
- message
- detail
x-apidog-refs:
01JQNH3W9YVFVMV9HPNZV2YGRX:
$ref: '#/components/schemas/Invalid%20Param'
x-apidog-ignore-properties:
- status
- error
- message
- detail
headers: {}
x-apidog-name: Missing-Param
'401':
description: ''
content:
application/json:
schema:
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:
- 01JQNH7DQB17G69HZAPB0QXKWT
required:
- status
- error
- message
x-apidog-refs:
01JQNH7DQB17G69HZAPB0QXKWT:
$ref: '#/components/schemas/unauthorized'
x-apidog-ignore-properties:
- status
- error
- message
headers: {}
x-apidog-name: Unauthorized
'409':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Indicates that the request failed because an organization
with the same identifier already exists or is protected.
error:
type: string
description: Contains an error identifier. (e.g., "item exists")
message:
type: string
description: >-
States that the organization cannot be created due to a
conflict.
detail:
type: string
description: Provides additional context.
x-apidog-orders:
- 01JQNH73HJZ63NVA39SZ54DK1X
required:
- status
- error
- message
- detail
x-apidog-refs:
01JQNH73HJZ63NVA39SZ54DK1X:
$ref: '#/components/schemas/Item-exists'
x-apidog-ignore-properties:
- status
- error
- message
- detail
headers: {}
x-apidog-name: Item Protected
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-11634351-run
components:
schemas:
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: ''
Item-exists:
type: object
properties:
status:
type: string
description: >-
Indicates that the request failed because an organization with the
same identifier already exists or is protected.
error:
type: string
description: Contains an error identifier. (e.g., "item exists")
message:
type: string
description: States that the organization cannot be created due to a conflict.
detail:
type: string
description: Provides additional context.
required:
- status
- error
- message
- detail
x-apidog-orders:
- status
- error
- message
- detail
x-apidog-ignore-properties: []
x-apidog-folder: ''
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: ''
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: []
```