GET
/
cloud
/
v1
/
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>'
{
  "address": "some.example.com",
  "commands": "python3 app.py -m test",
  "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,
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "my-log-name"
  },
  "name": "nginx",
  "namespace": "default",
  "pull_secret": "my-secret",
  "scale": {
    "max": 2,
    "min": 1
  },
  "source": "cloud",
  "status": "RUNNING",
  "status_message": "Some container status",
  "timeout": 5
}

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

Examples:

1

​
region_id
integer
required

Region id

Examples:

1

​
container_name
string
required

Container name

Examples:

"my-container"

Response

200 - application/json

OK

​
address
string
required

Container address

Examples:

"some.example.com"

​
created_at
string<date-time>
required

Container creation date

Examples:

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

​
deploy_status
object
required

Container deploy status

​
description
string
required

Container description

Examples:

"My first container"

​
envs
object
required

Container environment variables

Examples:
{
  "ENVIRONMENT_VARIABLE": "value 2",
  "ENV_VAR": "value 1"
}
​
flavor
string
required

Container flavor

Examples:

"250mCPU-512MiB"

​
image
string
required

Container image

Examples:

"nginx:latest"

​
is_api_key_auth
boolean
required

Enable/Disable api key authentication

Examples:

false

​
is_disabled
boolean
required

Set to true if container is disabled

Examples:

false

​
listening_port
integer
required

Container listening port

Examples:

80

​
name
string
required

Container name

Examples:

"nginx"

​
namespace
string
required

Container namespace

Examples:

"default"

​
pull_secret
string | null
required

Image pull secret

Examples:

"my-secret"

​
scale
object
required

Container autoscaling

​
source
string
required

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

Examples:

"cloud"

​
status
string
required

Container status

Examples:

"RUNNING"

​
status_message
string | null
required

Container status message

Examples:

"Some container status"

​
timeout
integer
required

Container timeout in seconds

Examples:

5

​
commands
string | null

Container's commands

Examples:

"python3 app.py -m test"

​
logging
object | null

Logging configuration

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