Skip to main content
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": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "deploy_status": {
    "ready": 123,
    "total": 123
  },
  "description": "<string>",
  "envs": {},
  "flavor": "<string>",
  "image": "<string>",
  "is_api_key_auth": true,
  "is_disabled": true,
  "listening_port": 123,
  "name": "<string>",
  "namespace": "<string>",
  "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": "<string>",
  "status": "<string>",
  "status_message": "Some container status",
  "timeout": 123,
  "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

Example:

"my-container"

Response

200 - application/json

OK

​
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

​
description
string
required

Container description

Example:

"My first container"

​
envs
Envs · object
required

Container environment variables

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

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

Logging configuration

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