Update a container service definition

curl --request PUT \
  --url https://core.cyberun.cloud/api/v1/containers/{serviceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "service_desc": "<string>",
  "docker_image": "<string>",
  "exposed_port": 32768,
  "health_path": "<string>",
  "env_config": [
    {
      "env_name": "<string>",
      "env_value": "<string>"
    }
  ],
  "volume_config": [
    {
      "host_path": "<string>",
      "container_path": "<string>"
    }
  ],
  "required_labels": [
    "<string>"
  ],
  "gpu_count": 123,
  "replica_count": 5,
  "usage_prompt": "<string>",
  "openapi_url": "<string>",
  "external_url": "<string>",
  "external_auth_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://core.cyberun.cloud/api/v1/containers/{serviceId}"

payload = {
    "display_name": "<string>",
    "service_desc": "<string>",
    "docker_image": "<string>",
    "exposed_port": 32768,
    "health_path": "<string>",
    "env_config": [
        {
            "env_name": "<string>",
            "env_value": "<string>"
        }
    ],
    "volume_config": [
        {
            "host_path": "<string>",
            "container_path": "<string>"
        }
    ],
    "required_labels": ["<string>"],
    "gpu_count": 123,
    "replica_count": 5,
    "usage_prompt": "<string>",
    "openapi_url": "<string>",
    "external_url": "<string>",
    "external_auth_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    service_desc: '<string>',
    docker_image: '<string>',
    exposed_port: 32768,
    health_path: '<string>',
    env_config: [{env_name: '<string>', env_value: '<string>'}],
    volume_config: [{host_path: '<string>', container_path: '<string>'}],
    required_labels: ['<string>'],
    gpu_count: 123,
    replica_count: 5,
    usage_prompt: '<string>',
    openapi_url: '<string>',
    external_url: '<string>',
    external_auth_credential_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://core.cyberun.cloud/api/v1/containers/{serviceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://core.cyberun.cloud/api/v1/containers/{serviceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'display_name' => '<string>',
    'service_desc' => '<string>',
    'docker_image' => '<string>',
    'exposed_port' => 32768,
    'health_path' => '<string>',
    'env_config' => [
        [
                'env_name' => '<string>',
                'env_value' => '<string>'
        ]
    ],
    'volume_config' => [
        [
                'host_path' => '<string>',
                'container_path' => '<string>'
        ]
    ],
    'required_labels' => [
        '<string>'
    ],
    'gpu_count' => 123,
    'replica_count' => 5,
    'usage_prompt' => '<string>',
    'openapi_url' => '<string>',
    'external_url' => '<string>',
    'external_auth_credential_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://core.cyberun.cloud/api/v1/containers/{serviceId}"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"docker_image\": \"<string>\",\n  \"exposed_port\": 32768,\n  \"health_path\": \"<string>\",\n  \"env_config\": [\n    {\n      \"env_name\": \"<string>\",\n      \"env_value\": \"<string>\"\n    }\n  ],\n  \"volume_config\": [\n    {\n      \"host_path\": \"<string>\",\n      \"container_path\": \"<string>\"\n    }\n  ],\n  \"required_labels\": [\n    \"<string>\"\n  ],\n  \"gpu_count\": 123,\n  \"replica_count\": 5,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://core.cyberun.cloud/api/v1/containers/{serviceId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"docker_image\": \"<string>\",\n  \"exposed_port\": 32768,\n  \"health_path\": \"<string>\",\n  \"env_config\": [\n    {\n      \"env_name\": \"<string>\",\n      \"env_value\": \"<string>\"\n    }\n  ],\n  \"volume_config\": [\n    {\n      \"host_path\": \"<string>\",\n      \"container_path\": \"<string>\"\n    }\n  ],\n  \"required_labels\": [\n    \"<string>\"\n  ],\n  \"gpu_count\": 123,\n  \"replica_count\": 5,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://core.cyberun.cloud/api/v1/containers/{serviceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"docker_image\": \"<string>\",\n  \"exposed_port\": 32768,\n  \"health_path\": \"<string>\",\n  \"env_config\": [\n    {\n      \"env_name\": \"<string>\",\n      \"env_value\": \"<string>\"\n    }\n  ],\n  \"volume_config\": [\n    {\n      \"host_path\": \"<string>\",\n      \"container_path\": \"<string>\"\n    }\n  ],\n  \"required_labels\": [\n    \"<string>\"\n  ],\n  \"gpu_count\": 123,\n  \"replica_count\": 5,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "019abc12-3456-7890-abcd-ef1234567890"
}

{
  "error_message": "resource not found"
}

{
  "error_message": "resource not found"
}

{
  "error_message": "resource not found"
}

{
  "error_message": "resource not found"
}

PUT

containers

{serviceId}

Update a container service definition

curl --request PUT \
  --url https://core.cyberun.cloud/api/v1/containers/{serviceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "service_desc": "<string>",
  "docker_image": "<string>",
  "exposed_port": 32768,
  "health_path": "<string>",
  "env_config": [
    {
      "env_name": "<string>",
      "env_value": "<string>"
    }
  ],
  "volume_config": [
    {
      "host_path": "<string>",
      "container_path": "<string>"
    }
  ],
  "required_labels": [
    "<string>"
  ],
  "gpu_count": 123,
  "replica_count": 5,
  "usage_prompt": "<string>",
  "openapi_url": "<string>",
  "external_url": "<string>",
  "external_auth_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://core.cyberun.cloud/api/v1/containers/{serviceId}"

payload = {
    "display_name": "<string>",
    "service_desc": "<string>",
    "docker_image": "<string>",
    "exposed_port": 32768,
    "health_path": "<string>",
    "env_config": [
        {
            "env_name": "<string>",
            "env_value": "<string>"
        }
    ],
    "volume_config": [
        {
            "host_path": "<string>",
            "container_path": "<string>"
        }
    ],
    "required_labels": ["<string>"],
    "gpu_count": 123,
    "replica_count": 5,
    "usage_prompt": "<string>",
    "openapi_url": "<string>",
    "external_url": "<string>",
    "external_auth_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    service_desc: '<string>',
    docker_image: '<string>',
    exposed_port: 32768,
    health_path: '<string>',
    env_config: [{env_name: '<string>', env_value: '<string>'}],
    volume_config: [{host_path: '<string>', container_path: '<string>'}],
    required_labels: ['<string>'],
    gpu_count: 123,
    replica_count: 5,
    usage_prompt: '<string>',
    openapi_url: '<string>',
    external_url: '<string>',
    external_auth_credential_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://core.cyberun.cloud/api/v1/containers/{serviceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://core.cyberun.cloud/api/v1/containers/{serviceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'display_name' => '<string>',
    'service_desc' => '<string>',
    'docker_image' => '<string>',
    'exposed_port' => 32768,
    'health_path' => '<string>',
    'env_config' => [
        [
                'env_name' => '<string>',
                'env_value' => '<string>'
        ]
    ],
    'volume_config' => [
        [
                'host_path' => '<string>',
                'container_path' => '<string>'
        ]
    ],
    'required_labels' => [
        '<string>'
    ],
    'gpu_count' => 123,
    'replica_count' => 5,
    'usage_prompt' => '<string>',
    'openapi_url' => '<string>',
    'external_url' => '<string>',
    'external_auth_credential_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://core.cyberun.cloud/api/v1/containers/{serviceId}"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"docker_image\": \"<string>\",\n  \"exposed_port\": 32768,\n  \"health_path\": \"<string>\",\n  \"env_config\": [\n    {\n      \"env_name\": \"<string>\",\n      \"env_value\": \"<string>\"\n    }\n  ],\n  \"volume_config\": [\n    {\n      \"host_path\": \"<string>\",\n      \"container_path\": \"<string>\"\n    }\n  ],\n  \"required_labels\": [\n    \"<string>\"\n  ],\n  \"gpu_count\": 123,\n  \"replica_count\": 5,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://core.cyberun.cloud/api/v1/containers/{serviceId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"docker_image\": \"<string>\",\n  \"exposed_port\": 32768,\n  \"health_path\": \"<string>\",\n  \"env_config\": [\n    {\n      \"env_name\": \"<string>\",\n      \"env_value\": \"<string>\"\n    }\n  ],\n  \"volume_config\": [\n    {\n      \"host_path\": \"<string>\",\n      \"container_path\": \"<string>\"\n    }\n  ],\n  \"required_labels\": [\n    \"<string>\"\n  ],\n  \"gpu_count\": 123,\n  \"replica_count\": 5,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://core.cyberun.cloud/api/v1/containers/{serviceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"docker_image\": \"<string>\",\n  \"exposed_port\": 32768,\n  \"health_path\": \"<string>\",\n  \"env_config\": [\n    {\n      \"env_name\": \"<string>\",\n      \"env_value\": \"<string>\"\n    }\n  ],\n  \"volume_config\": [\n    {\n      \"host_path\": \"<string>\",\n      \"container_path\": \"<string>\"\n    }\n  ],\n  \"required_labels\": [\n    \"<string>\"\n  ],\n  \"gpu_count\": 123,\n  \"replica_count\": 5,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "019abc12-3456-7890-abcd-ef1234567890"
}

{
  "error_message": "resource not found"
}

{
  "error_message": "resource not found"
}

{
  "error_message": "resource not found"
}

{
  "error_message": "resource not found"
}

Authorizations

Authorization

string

header

required

User session JWT (Bearer ). Must be paired with the X-Team-ID request header on team-scoped endpoints so the server knows which team's resources to operate on.

Headers

X-Team-ID

string<uuid>

UUID of the team to scope the request to. Used by dual-auth endpoints (runtime + scoped management):

JWT callers MUST send it — a user may belong to multiple teams and the runtime cannot otherwise know which one to operate on. Missing header → 400.
Credential callers (sk-, dk-) can omit it because the team is derived from the credential row itself. Any value sent is ignored.

Example:

"019abc12-4567-7890-abcd-ef1234567891"

Path Parameters

serviceId

string<uuid>

required

Body

application/json

display_name

string

Maximum string length: 255

service_desc

string

docker_image

string

exposed_port

integer

Required range: 1 <= x <= 65535

health_path

string

env_config

object[]

Show child attributes

volume_config

object[]

Show child attributes

required_labels

string[]

gpu_count

integer

GPU count: -1=all GPUs, 0=none, N=specific count

replica_count

integer

Required range: 1 <= x <= 10

usage_prompt

string

Optional AI-facing description. See ContainerServiceCreateRequest.

openapi_url

string

Optional path served by the container with an OpenAPI document. See ContainerServiceCreateRequest.

Maximum string length: 500

external_url

string<uri>

Only valid on rows whose service_type is already external. The service_type cannot be changed after creation.

Maximum string length: 2048

Pattern: ^https://

external_auth_credential_id

string<uuid> | null

Only valid on external services. Send a UUID to attach a new credential reference; omit (or send null — the server treats them the same in v1) to leave the existing reference unchanged.

Clearing a previously-set reference via API is not supported in v1: the server cannot distinguish omitted from explicit-null in the request body, so it conservatively defaults to "leave alone". To remove an attached credential, delete and recreate the service. A tristate request shape (omitted / null / value) is filed for a future revision if real demand appears.

Response

Service updated

string<uuid>

required

UUID of the created or updated resource.

Example:

"019abc12-3456-7890-abcd-ef1234567890"

Get a container service by ID Delete a container service

Overview

Guides

Endpoints

Update a container service definition

Authorizations

Headers

Path Parameters

Body

Response