# Modify Deployment
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/be/v1/deployments:
patch:
summary: Modify Deployment
deprecated: false
description: >-
This endpoint allows for modifying an existing ROCKIT Edge deployment.
Provide those parameters which should be changed. Optional resource
paramers can be removed by setting them to `null`.
### Required Permissions
`deployments.update`
See [Roles](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more details.
tags:
- ROCKIT Edge - Backend API/Deployments
parameters:
- 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
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
pattern: /^[A-Za-z0-9_[\]]{2,50}$/
label:
type: string
origin:
type: object
properties:
s3:
type: object
properties:
accessKey:
type: string
secretKey:
type: string
x-apidog-orders:
- accessKey
- secretKey
x-apidog-ignore-properties: []
nullable: true
netstorage:
type: object
properties:
uploadAccount:
type: string
apiKey:
type: string
cpCode:
type: number
x-apidog-orders:
- uploadAccount
- apiKey
- cpCode
x-apidog-ignore-properties: []
nullable: true
x-apidog-orders:
- s3
- netstorage
x-apidog-ignore-properties: []
dlAuth:
type: object
properties:
gcore:
type: object
properties:
baseUrl:
type: string
secureToken:
type: string
bucket:
type: string
prefix:
type: string
x-apidog-orders:
- baseUrl
- secureToken
- bucket
- prefix
x-apidog-ignore-properties: []
nullable: true
akamai:
type: object
properties:
hostname:
type: string
authKey:
type: string
prefix:
type: string
x-apidog-orders:
- hostname
- authKey
- prefix
x-apidog-ignore-properties: []
nullable: true
x-apidog-orders:
- gcore
- akamai
x-apidog-ignore-properties: []
dTDeletionSec:
type: number
minimum: 0
acknowledged:
type: boolean
validateOnly:
type: boolean
required:
- name
x-apidog-orders:
- name
- label
- origin
- dlAuth
- dTDeletionSec
- acknowledged
- validateOnly
x-apidog-ignore-properties: []
example:
name: gcore
label: Gcore Object Storage / Gcore CDN
origin:
s3:
hostname: '{{EDGE_ORIGIN_GCORE_HOSTNAME}}'
accessKey: '{{EDGE_ORIGIN_GCORE_ACCESS_KEY}}'
secretKey: '{{EDGE_ORIGIN_GCORE_SECRET_KEY}}'
location: '{{EDGE_ORIGIN_GCORE_LOCATION}}'
bucket: '{{EDGE_ORIGIN_GCORE_BUCKET}}'
prefix: '{{EDGE_ORIGIN_GCORE_PREFIX}}'
dlAuth:
gcore:
baseUrl: '{{EDGE_ORIGIN_GCORE_BASE_URL}}'
secureToken: '{{EDGE_ORIGIN_GCORE_SECURE_TOKEN}}'
bucket: '{{EDGE_ORIGIN_GCORE_BUCKET}}'
prefix: '{{EDGE_ORIGIN_GCORE_PREFIX}}'
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 modified") that
the update to the deployment’s configuration has been
processed without error.
required:
- status
- message
x-apidog-orders:
- status
- message
x-apidog-ignore-properties: []
example:
status: success
message: deployment modified
headers: {}
x-apidog-name: 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:
- 01JQNHBSAAYJFEPKP5Z7RTBMV7
required:
- status
- error
- message
- detail
x-apidog-refs:
01JQNHBSAAYJFEPKP5Z7RTBMV7:
$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:
- 01JQNHB2NG26BRGG0TQ0XZXQQ3
required:
- status
- error
- message
x-apidog-refs:
01JQNHB2NG26BRGG0TQ0XZXQQ3:
$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-11695719-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: []
```