Get Container Template

Gets a container template within an application.

GET /apps/{appId}/containers/{containerId}

Get Container Template

cURL

curl --request GET \
  --url https://api.bunny.net/mc/apps/{appId}/containers/{containerId} \
  --header 'AccessKey: <api-key>'

import requests

url = "https://api.bunny.net/mc/apps/{appId}/containers/{containerId}"

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

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

print(response.text)

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

fetch('https://api.bunny.net/mc/apps/{appId}/containers/{containerId}', 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.bunny.net/mc/apps/{appId}/containers/{containerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "AccessKey: <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.bunny.net/mc/apps/{appId}/containers/{containerId}"

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

	req.Header.Add("AccessKey", "<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.bunny.net/mc/apps/{appId}/containers/{containerId}")
  .header("AccessKey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/mc/apps/{appId}/containers/{containerId}")

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

request = Net::HTTP::Get.new(url)
request["AccessKey"] = '<api-key>'

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

200

{
  "id": "<string>",
  "name": "<string>",
  "packageId": "<string>",
  "image": "<string>",
  "imageName": "<string>",
  "imageNamespace": "<string>",
  "imageTag": "<string>",
  "imageRegistryId": "<string>",
  "imageDigest": "<string>",
  "entryPoint": {
    "command": "<string>",
    "commandArray": [
      "<string>"
    ],
    "arguments": "<string>",
    "argumentsArray": [
      "<string>"
    ],
    "workingDirectory": "<string>"
  },
  "probes": {
    "startup": {
      "initialDelaySeconds": 10,
      "periodSeconds": 10,
      "timeoutSeconds": 7,
      "failureThreshold": 3,
      "successThreshold": 1,
      "httpGet": {
        "request": {
          "path": "<string>",
          "portNumber": 32768
        },
        "response": {}
      },
      "tcpSocket": {
        "request": {
          "portNumber": 32768
        }
      },
      "grpc": {
        "request": {
          "portNumber": 32768,
          "serviceName": "<string>"
        }
      }
    },
    "readiness": {
      "initialDelaySeconds": 10,
      "periodSeconds": 10,
      "timeoutSeconds": 7,
      "failureThreshold": 3,
      "successThreshold": 1,
      "httpGet": {
        "request": {
          "path": "<string>",
          "portNumber": 32768
        },
        "response": {}
      },
      "tcpSocket": {
        "request": {
          "portNumber": 32768
        }
      },
      "grpc": {
        "request": {
          "portNumber": 32768,
          "serviceName": "<string>"
        }
      }
    },
    "liveness": {
      "initialDelaySeconds": 10,
      "periodSeconds": 10,
      "timeoutSeconds": 7,
      "failureThreshold": 3,
      "successThreshold": 1,
      "httpGet": {
        "request": {
          "path": "<string>",
          "portNumber": 32768
        },
        "response": {}
      },
      "tcpSocket": {
        "request": {
          "portNumber": 32768
        }
      },
      "grpc": {
        "request": {
          "portNumber": 32768,
          "serviceName": "<string>"
        }
      }
    }
  },
  "environmentVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "endpoints": [
    {
      "displayName": "<string>",
      "publicHost": "<string>",
      "isSslEnabled": true,
      "pullZoneId": "<string>",
      "portMappings": [
        {
          "containerPort": 123,
          "exposedPort": 123,
          "protocols": []
        }
      ],
      "stickySessions": {
        "enabled": true,
        "sessionHeaders": [
          "<string>"
        ],
        "cookieName": "<string>"
      },
      "internalIpAddresses": [
        {
          "address": "<string>",
          "region": "<string>"
        }
      ],
      "publicIpAddresses": [
        {
          "address": "<string>",
          "region": "<string>"
        }
      ]
    }
  ],
  "volumeMounts": [
    {
      "name": "<string>",
      "mountPath": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "id": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "message": "<string>",
      "field": "<string>"
    }
  ],
  "id": "<string>"
}

Authorizations

AccessKey · string · header · required

Please enter a valid personal API key.

Path Parameters

appId · string · required

The ID of the application

containerId · string · required

The ID of the container template

Response

200

application/json

Container template retrieved successfully.

Container template model

id · string · required

Minimum string length: 1

name · string · required

Minimum string length: 1

packageId · string · required

Minimum string length: 1

image · string · required

Minimum string length: 1

imageName · string · required

Minimum string length: 1

imageNamespace · string · required

Minimum string length: 1

imageTag · string · required

Minimum string length: 1

imageRegistryId · string · required

Minimum string length: 1

imageDigest · string · required

Minimum string length: 1

imagePullPolicy · enum<string> · required

Available options: always, ifNotPresent

entryPoint · object · required

Show child attributes

probes · object · required

Show child attributes

environmentVariables · object[] · required

Show child attributes

endpoints · object[] · required

Show child attributes

volumeMounts · object[] · required

Show child attributes