Create a container service definition

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

import requests

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

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

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

print(response.text)

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

fetch('https://core.cyberun.cloud/api/v1/containers', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'service_slug' => '<string>',
    'display_name' => '<string>',
    'service_desc' => '<string>',
    'service_type' => 'deployed',
    'docker_image' => '<string>',
    'external_url' => '<string>',
    'external_auth_credential_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'exposed_port' => 8080,
    'health_path' => '/health',
    'env_config' => [
        [
                'env_name' => '<string>',
                'env_value' => '<string>'
        ]
    ],
    'volume_config' => [
        [
                'host_path' => '<string>',
                'container_path' => '<string>'
        ]
    ],
    'required_labels' => [
        '<string>'
    ],
    'gpu_count' => 0,
    'replica_count' => 1,
    'usage_prompt' => '<string>',
    'openapi_url' => '<string>'
  ]),
  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"

	payload := strings.NewReader("{\n  \"service_slug\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"service_type\": \"deployed\",\n  \"docker_image\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"exposed_port\": 8080,\n  \"health_path\": \"/health\",\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\": 0,\n  \"replica_count\": 1,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://core.cyberun.cloud/api/v1/containers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"service_slug\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"service_type\": \"deployed\",\n  \"docker_image\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"exposed_port\": 8080,\n  \"health_path\": \"/health\",\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\": 0,\n  \"replica_count\": 1,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"service_slug\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"service_type\": \"deployed\",\n  \"docker_image\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"exposed_port\": 8080,\n  \"health_path\": \"/health\",\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\": 0,\n  \"replica_count\": 1,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\"\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"
}

POST

containers

Create a container service definition

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

import requests

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

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

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

print(response.text)

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

fetch('https://core.cyberun.cloud/api/v1/containers', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'service_slug' => '<string>',
    'display_name' => '<string>',
    'service_desc' => '<string>',
    'service_type' => 'deployed',
    'docker_image' => '<string>',
    'external_url' => '<string>',
    'external_auth_credential_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'exposed_port' => 8080,
    'health_path' => '/health',
    'env_config' => [
        [
                'env_name' => '<string>',
                'env_value' => '<string>'
        ]
    ],
    'volume_config' => [
        [
                'host_path' => '<string>',
                'container_path' => '<string>'
        ]
    ],
    'required_labels' => [
        '<string>'
    ],
    'gpu_count' => 0,
    'replica_count' => 1,
    'usage_prompt' => '<string>',
    'openapi_url' => '<string>'
  ]),
  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"

	payload := strings.NewReader("{\n  \"service_slug\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"service_type\": \"deployed\",\n  \"docker_image\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"exposed_port\": 8080,\n  \"health_path\": \"/health\",\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\": 0,\n  \"replica_count\": 1,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://core.cyberun.cloud/api/v1/containers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"service_slug\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"service_type\": \"deployed\",\n  \"docker_image\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"exposed_port\": 8080,\n  \"health_path\": \"/health\",\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\": 0,\n  \"replica_count\": 1,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"service_slug\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"service_desc\": \"<string>\",\n  \"service_type\": \"deployed\",\n  \"docker_image\": \"<string>\",\n  \"external_url\": \"<string>\",\n  \"external_auth_credential_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"exposed_port\": 8080,\n  \"health_path\": \"/health\",\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\": 0,\n  \"replica_count\": 1,\n  \"usage_prompt\": \"<string>\",\n  \"openapi_url\": \"<string>\"\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"

Body

application/json

Create a container service definition. Two service types are supported:

deployed (default) — the platform pulls docker_image and runs it on the team's agents. docker_image is required.
external — the team's existing HTTP service is fronted by Cyberun. external_url is required and must be https://. The agent makes outbound calls to it via its existing tunnel. See ADR-0007.

service_type is immutable after creation; recreate the service to switch.

service_slug

string

required

URL-safe slug for the service (3-100 chars, lowercase, hyphens)

Pattern: ^[a-z0-9][a-z0-9-]{1,98}[a-z0-9]$

display_name

string

required

Maximum string length: 255

service_desc

string

service_type

enum<string>

default:deployed

How this service is hosted. See ADR-0007 in the engineering docs.

Available options:

deployed,

external

docker_image

string

Docker image reference (e.g. vllm/vllm-openai:latest). Required when service_type=deployed.

external_url

string<uri>

Absolute https:// URL of the externally-hosted service. Required when service_type=external.

Maximum string length: 2048

Pattern: ^https://

external_auth_credential_id

string<uuid>

Optional credential vault reference. When set, the agent attaches the resolved credential as an Authorization header on outbound requests. Only meaningful when service_type=external.

exposed_port

integer

default:8080

Required range: 1 <= x <= 65535

health_path

string

default:/health

env_config

object[]

Show child attributes

volume_config

object[]

Show child attributes

required_labels

string[]

Agent labels required to deploy this service

gpu_count

integer

default:0

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

replica_count

integer

default:1

Required range: 1 <= x <= 10

usage_prompt

string

Optional natural-language description aimed at AI agents discovering this service through MCP. Example: "This is ollama. POST /api/generate with {model, prompt}. Available models: llama3, qwen2." Readable by anyone who can list/read services in the team — do not put secrets here.

openapi_url

string

Optional path served by the container where an OpenAPI document lives (e.g. "/openapi.json" for FastAPI). Lets AI agents fetch a machine-readable schema before invoking.

Maximum string length: 500

Response

Service created

string<uuid>

required

UUID of the created or updated resource.

Example:

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

List container services for a team Get a container service by ID

Overview

Guides

Endpoints

Create a container service definition

Authorizations

Headers

Body

Response