Update container

curl --request PATCH \
  --url https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commands": "python3 app.py -m test",
  "description": "My first container",
  "envs": {
    "ENVIRONMENT_VARIABLE": "value 2",
    "ENV_VAR": "value 1"
  },
  "flavor": "250mCPU-512MiB",
  "image": "nginx:latest",
  "is_api_key_auth": false,
  "is_disabled": false,
  "listening_port": 80,
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "my-log-name"
  },
  "pull_secret": "my-secret",
  "scale": {
    "max": 2,
    "min": 1
  },
  "timeout": 5
}
'

import requests

url = "https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}"

payload = {
    "commands": "python3 app.py -m test",
    "description": "My first container",
    "envs": {
        "ENVIRONMENT_VARIABLE": "value 2",
        "ENV_VAR": "value 1"
    },
    "flavor": "250mCPU-512MiB",
    "image": "nginx:latest",
    "is_api_key_auth": False,
    "is_disabled": False,
    "listening_port": 80,
    "logging": {
        "destination_region_id": 1,
        "enabled": True,
        "retention_policy": { "period": 45 },
        "topic_name": "my-log-name"
    },
    "pull_secret": "my-secret",
    "scale": {
        "max": 2,
        "min": 1
    },
    "timeout": 5
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    commands: 'python3 app.py -m test',
    description: 'My first container',
    envs: {ENVIRONMENT_VARIABLE: 'value 2', ENV_VAR: 'value 1'},
    flavor: '250mCPU-512MiB',
    image: 'nginx:latest',
    is_api_key_auth: false,
    is_disabled: false,
    listening_port: 80,
    logging: {
      destination_region_id: 1,
      enabled: true,
      retention_policy: {period: 45},
      topic_name: 'my-log-name'
    },
    pull_secret: 'my-secret',
    scale: {max: 2, min: 1},
    timeout: 5
  })
};

fetch('https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}', 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://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'commands' => 'python3 app.py -m test',
    'description' => 'My first container',
    'envs' => [
        'ENVIRONMENT_VARIABLE' => 'value 2',
        'ENV_VAR' => 'value 1'
    ],
    'flavor' => '250mCPU-512MiB',
    'image' => 'nginx:latest',
    'is_api_key_auth' => false,
    'is_disabled' => false,
    'listening_port' => 80,
    'logging' => [
        'destination_region_id' => 1,
        'enabled' => true,
        'retention_policy' => [
                'period' => 45
        ],
        'topic_name' => 'my-log-name'
    ],
    'pull_secret' => 'my-secret',
    'scale' => [
        'max' => 2,
        'min' => 1
    ],
    'timeout' => 5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}"

	payload := strings.NewReader("{\n  \"commands\": \"python3 app.py -m test\",\n  \"description\": \"My first container\",\n  \"envs\": {\n    \"ENVIRONMENT_VARIABLE\": \"value 2\",\n    \"ENV_VAR\": \"value 1\"\n  },\n  \"flavor\": \"250mCPU-512MiB\",\n  \"image\": \"nginx:latest\",\n  \"is_api_key_auth\": false,\n  \"is_disabled\": false,\n  \"listening_port\": 80,\n  \"logging\": {\n    \"destination_region_id\": 1,\n    \"enabled\": true,\n    \"retention_policy\": {\n      \"period\": 45\n    },\n    \"topic_name\": \"my-log-name\"\n  },\n  \"pull_secret\": \"my-secret\",\n  \"scale\": {\n    \"max\": 2,\n    \"min\": 1\n  },\n  \"timeout\": 5\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.patch("https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"commands\": \"python3 app.py -m test\",\n  \"description\": \"My first container\",\n  \"envs\": {\n    \"ENVIRONMENT_VARIABLE\": \"value 2\",\n    \"ENV_VAR\": \"value 1\"\n  },\n  \"flavor\": \"250mCPU-512MiB\",\n  \"image\": \"nginx:latest\",\n  \"is_api_key_auth\": false,\n  \"is_disabled\": false,\n  \"listening_port\": 80,\n  \"logging\": {\n    \"destination_region_id\": 1,\n    \"enabled\": true,\n    \"retention_policy\": {\n      \"period\": 45\n    },\n    \"topic_name\": \"my-log-name\"\n  },\n  \"pull_secret\": \"my-secret\",\n  \"scale\": {\n    \"max\": 2,\n    \"min\": 1\n  },\n  \"timeout\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"commands\": \"python3 app.py -m test\",\n  \"description\": \"My first container\",\n  \"envs\": {\n    \"ENVIRONMENT_VARIABLE\": \"value 2\",\n    \"ENV_VAR\": \"value 1\"\n  },\n  \"flavor\": \"250mCPU-512MiB\",\n  \"image\": \"nginx:latest\",\n  \"is_api_key_auth\": false,\n  \"is_disabled\": false,\n  \"listening_port\": 80,\n  \"logging\": {\n    \"destination_region_id\": 1,\n    \"enabled\": true,\n    \"retention_policy\": {\n      \"period\": 45\n    },\n    \"topic_name\": \"my-log-name\"\n  },\n  \"pull_secret\": \"my-secret\",\n  \"scale\": {\n    \"max\": 2,\n    \"min\": 1\n  },\n  \"timeout\": 5\n}"

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

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}

PATCH

cloud

caas

{project_id}

{region_id}

containers

{container_name}

Update container

curl --request PATCH \
  --url https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commands": "python3 app.py -m test",
  "description": "My first container",
  "envs": {
    "ENVIRONMENT_VARIABLE": "value 2",
    "ENV_VAR": "value 1"
  },
  "flavor": "250mCPU-512MiB",
  "image": "nginx:latest",
  "is_api_key_auth": false,
  "is_disabled": false,
  "listening_port": 80,
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "my-log-name"
  },
  "pull_secret": "my-secret",
  "scale": {
    "max": 2,
    "min": 1
  },
  "timeout": 5
}
'

import requests

url = "https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}"

payload = {
    "commands": "python3 app.py -m test",
    "description": "My first container",
    "envs": {
        "ENVIRONMENT_VARIABLE": "value 2",
        "ENV_VAR": "value 1"
    },
    "flavor": "250mCPU-512MiB",
    "image": "nginx:latest",
    "is_api_key_auth": False,
    "is_disabled": False,
    "listening_port": 80,
    "logging": {
        "destination_region_id": 1,
        "enabled": True,
        "retention_policy": { "period": 45 },
        "topic_name": "my-log-name"
    },
    "pull_secret": "my-secret",
    "scale": {
        "max": 2,
        "min": 1
    },
    "timeout": 5
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    commands: 'python3 app.py -m test',
    description: 'My first container',
    envs: {ENVIRONMENT_VARIABLE: 'value 2', ENV_VAR: 'value 1'},
    flavor: '250mCPU-512MiB',
    image: 'nginx:latest',
    is_api_key_auth: false,
    is_disabled: false,
    listening_port: 80,
    logging: {
      destination_region_id: 1,
      enabled: true,
      retention_policy: {period: 45},
      topic_name: 'my-log-name'
    },
    pull_secret: 'my-secret',
    scale: {max: 2, min: 1},
    timeout: 5
  })
};

fetch('https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}', 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://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'commands' => 'python3 app.py -m test',
    'description' => 'My first container',
    'envs' => [
        'ENVIRONMENT_VARIABLE' => 'value 2',
        'ENV_VAR' => 'value 1'
    ],
    'flavor' => '250mCPU-512MiB',
    'image' => 'nginx:latest',
    'is_api_key_auth' => false,
    'is_disabled' => false,
    'listening_port' => 80,
    'logging' => [
        'destination_region_id' => 1,
        'enabled' => true,
        'retention_policy' => [
                'period' => 45
        ],
        'topic_name' => 'my-log-name'
    ],
    'pull_secret' => 'my-secret',
    'scale' => [
        'max' => 2,
        'min' => 1
    ],
    'timeout' => 5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}"

	payload := strings.NewReader("{\n  \"commands\": \"python3 app.py -m test\",\n  \"description\": \"My first container\",\n  \"envs\": {\n    \"ENVIRONMENT_VARIABLE\": \"value 2\",\n    \"ENV_VAR\": \"value 1\"\n  },\n  \"flavor\": \"250mCPU-512MiB\",\n  \"image\": \"nginx:latest\",\n  \"is_api_key_auth\": false,\n  \"is_disabled\": false,\n  \"listening_port\": 80,\n  \"logging\": {\n    \"destination_region_id\": 1,\n    \"enabled\": true,\n    \"retention_policy\": {\n      \"period\": 45\n    },\n    \"topic_name\": \"my-log-name\"\n  },\n  \"pull_secret\": \"my-secret\",\n  \"scale\": {\n    \"max\": 2,\n    \"min\": 1\n  },\n  \"timeout\": 5\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.patch("https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"commands\": \"python3 app.py -m test\",\n  \"description\": \"My first container\",\n  \"envs\": {\n    \"ENVIRONMENT_VARIABLE\": \"value 2\",\n    \"ENV_VAR\": \"value 1\"\n  },\n  \"flavor\": \"250mCPU-512MiB\",\n  \"image\": \"nginx:latest\",\n  \"is_api_key_auth\": false,\n  \"is_disabled\": false,\n  \"listening_port\": 80,\n  \"logging\": {\n    \"destination_region_id\": 1,\n    \"enabled\": true,\n    \"retention_policy\": {\n      \"period\": 45\n    },\n    \"topic_name\": \"my-log-name\"\n  },\n  \"pull_secret\": \"my-secret\",\n  \"scale\": {\n    \"max\": 2,\n    \"min\": 1\n  },\n  \"timeout\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"commands\": \"python3 app.py -m test\",\n  \"description\": \"My first container\",\n  \"envs\": {\n    \"ENVIRONMENT_VARIABLE\": \"value 2\",\n    \"ENV_VAR\": \"value 1\"\n  },\n  \"flavor\": \"250mCPU-512MiB\",\n  \"image\": \"nginx:latest\",\n  \"is_api_key_auth\": false,\n  \"is_disabled\": false,\n  \"listening_port\": 80,\n  \"logging\": {\n    \"destination_region_id\": 1,\n    \"enabled\": true,\n    \"retention_policy\": {\n      \"period\": 45\n    },\n    \"topic_name\": \"my-log-name\"\n  },\n  \"pull_secret\": \"my-secret\",\n  \"scale\": {\n    \"max\": 2,\n    \"min\": 1\n  },\n  \"timeout\": 5\n}"

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

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}

Authorizations

Authorization

string

header

required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id

integer

required

Project id

Example:

1

region_id

integer

required

Region id

Example:

1

container_name

string

required

Container name

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]+[a-zA-Z0-9]$

Example:

"my-container"

Body

application/json

commands

string | null

Container's commands

Example:

"python3 app.py -m test"

description

string | null

Container description

Maximum string length: 255

Example:

"My first container"

envs

Envs · object | null

Container environment variables

Example:

{
  "ENVIRONMENT_VARIABLE": "value 2",
  "ENV_VAR": "value 1"
}

flavor

string | null

Container flavor

Pattern: ^[0-9]{0,12}mCPU-[0-9]{0,12}M[i]?B$

Example:

"250mCPU-512MiB"

image

string | null

Container image

Maximum string length: 230

Example:

"nginx:latest"

is_api_key_auth

boolean | null

Enable/Disable api key authentication. Enable api key is temporarily disabled. As a result, using CaaS with authorization is currently not supported.

Example:

false

is_disabled

boolean | null

Set to true if container is disabled

Example:

false

listening_port

integer | null

Container listening port

Required range: 1 <= x <= 65535

Example:

80

logging

LoggingSerializer · object | null

Logging configuration

Show child attributes

Example:

{
  "destination_region_id": 1,
  "enabled": true,
  "retention_policy": { "period": 45 },
  "topic_name": "my-log-name"
}

pull_secret

string | null

Image pull secret

Example:

"my-secret"

scale

ScaleSerializer · object | null

Container autoscaling

Show child attributes

Example:

{ "max": 2, "min": 1 }

timeout

integer | null

Container timeout in seconds

Required range: 0 <= x <= 180

Example:

5

Response

200 - application/json

tasks

string[]

required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.

Example:

["d478ae29-dedc-4869-82f0-96104425f565"]

Delete container Get container logs

⌘I