Modify Deployment

PATCH

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

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

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 for more details.

Request

Header Params

x-rockit-beauth-token

string

required

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:

Body Params application/json

name

string

required

Match pattern:

/^[A-Za-z0-9_[\]]{2,50}$/

label

string

required

origin

object

required

object

required

dlAuth

object

required

gcore

object

required

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}}"
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://Example-Server.com/be/v1/deployments' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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

🟢200Success

application/json

Body

status

string

required

A string confirming that the deletion operation was successful.

message

string

required

A confirmation message (e.g., "deployment modified") that the update to the deployment’s configuration has been processed without error.

Example

{
  "status": "success",
  "message": "deployment modified"
}

🟠400Invalid Param

🟠401Unauthorized

Get Deployment Details

Deleting Deployments

Modify Deployment

Required Permissions#

Request

Request samples

Responses

Required Permissions