Get container

curl --request GET \
  --url https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name} \
  --header 'Authorization: <api-key>'

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}")
  .header("Authorization", "<api-key>")
  .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::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "address": "some.example.com",
  "created_at": "2021-01-01T00:00:00Z",
  "deploy_status": {
    "ready": 1,
    "total": 2
  },
  "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,
  "name": "nginx",
  "namespace": "default",
  "pull_secret": "my-secret",
  "scale": {
    "max": 13,
    "min": 12,
    "cooldown_period": 60,
    "triggers": {
      "cpu": {
        "threshold": 50
      },
      "http": {
        "rate": 500,
        "window": 1800
      },
      "memory": {
        "threshold": 50
      }
    }
  },
  "source": "cloud",
  "status": "RUNNING",
  "status_message": "Some container status",
  "timeout": 5,
  "commands": "python3 app.py -m test",
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "my-log-name"
  }
}

GET

cloud

caas

{project_id}

{region_id}

containers

{container_name}

Get container

curl --request GET \
  --url https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name} \
  --header 'Authorization: <api-key>'

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/caas/{project_id}/{region_id}/containers/{container_name}")
  .header("Authorization", "<api-key>")
  .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::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "address": "some.example.com",
  "created_at": "2021-01-01T00:00:00Z",
  "deploy_status": {
    "ready": 1,
    "total": 2
  },
  "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,
  "name": "nginx",
  "namespace": "default",
  "pull_secret": "my-secret",
  "scale": {
    "max": 13,
    "min": 12,
    "cooldown_period": 60,
    "triggers": {
      "cpu": {
        "threshold": 50
      },
      "http": {
        "rate": 500,
        "window": 1800
      },
      "memory": {
        "threshold": 50
      }
    }
  },
  "source": "cloud",
  "status": "RUNNING",
  "status_message": "Some container status",
  "timeout": 5,
  "commands": "python3 app.py -m test",
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "my-log-name"
  }
}

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"

Response

200 - application/json

address

string

required

Container address

Example:

"some.example.com"

created_at

string<date-time>

required

Container creation date

Example:

"2021-01-01T00:00:00Z"

deploy_status

DeployStatusSerializer · object

required

Container deploy status

Show child attributes

description

string

required

Container description

Example:

"My first container"

envs

Envs · object

required

Container environment variables

Show child attributes

Example:

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

flavor

string

required

Container flavor

Example:

"250mCPU-512MiB"

image

string

required

Container image

Example:

"nginx:latest"

is_api_key_auth

boolean

required

Enable/Disable api key authentication

Example:

false

is_disabled

boolean

required

Set to true if container is disabled

Example:

false

listening_port

integer

required

Container listening port

Example:

80

name

string

required

Container name

Example:

"nginx"

namespace

string

required

Container namespace

Example:

"default"

pull_secret

string | null

required

Image pull secret

Example:

"my-secret"

scale

ScaleSerializer · object

required

Container autoscaling

Show child attributes

Example:

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

source

string

required

Source of the container, can be 'cloud' or 'iate'

Example:

"cloud"

status

string

required

Container status

Example:

"RUNNING"

status_message

string | null

required

Container status message

Example:

"Some container status"

timeout

integer

required

Container timeout in seconds

Example:

5

commands

string | null

Container's commands

Example:

"python3 app.py -m test"

logging

LoggingOutSerializer · object | null

Logging configuration

Show child attributes

Example:

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

Create container Delete container

⌘I