Modify Deployment

PATCH

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

Last modified:2025-11-09 20:35:36

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

Body Params application/json

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 Code 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: {{_edge_org_admin_beauth_token}}' \
--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

Example

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

🟠401Unauthorized

🟠400Invalid Param

Modified at 2025-11-09 20:35:36

Get Deployment Details

Deleting Deployments

Modify Deployment

Required Permissions#

Request

Request Code Samples

Responses

Required Permissions