Get Container Config Suggestions

Gets recommended configuration for a container image including endpoint configurations and environment variables.

POST /registries/config-suggestions

Get Container Config Suggestions

cURL

curl --request POST \
  --url https://api.bunny.net/mc/registries/config-suggestions \
  --header 'AccessKey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "registryId": "<string>",
  "imageName": "<string>",
  "imageNamespace": "<string>",
  "tag": "<string>"
}
'

import requests

url = "https://api.bunny.net/mc/registries/config-suggestions"

payload = {
    "registryId": "<string>",
    "imageName": "<string>",
    "imageNamespace": "<string>",
    "tag": "<string>"
}
headers = {
    "AccessKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {AccessKey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    registryId: '<string>',
    imageName: '<string>',
    imageNamespace: '<string>',
    tag: '<string>'
  })
};

fetch('https://api.bunny.net/mc/registries/config-suggestions', 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/registries/config-suggestions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'registryId' => '<string>',
    'imageName' => '<string>',
    'imageNamespace' => '<string>',
    'tag' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "AccessKey: <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.bunny.net/mc/registries/config-suggestions"

	payload := strings.NewReader("{\n  \"registryId\": \"<string>\",\n  \"imageName\": \"<string>\",\n  \"imageNamespace\": \"<string>\",\n  \"tag\": \"<string>\"\n}")

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

	req.Header.Add("AccessKey", "<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.post("https://api.bunny.net/mc/registries/config-suggestions")
  .header("AccessKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"registryId\": \"<string>\",\n  \"imageName\": \"<string>\",\n  \"imageNamespace\": \"<string>\",\n  \"tag\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/mc/registries/config-suggestions")

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

request = Net::HTTP::Post.new(url)
request["AccessKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"registryId\": \"<string>\",\n  \"imageName\": \"<string>\",\n  \"imageNamespace\": \"<string>\",\n  \"tag\": \"<string>\"\n}"

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

200

{
  "endpointSuggestions": [
    {
      "displayName": "<string>",
      "cdn": {
        "isSslEnabled": true,
        "stickySessions": {
          "sessionHeaders": [
            "<string>"
          ],
          "enabled": true,
          "cookieName": "<string>"
        },
        "pullZoneId": 123,
        "portMappings": [
          {
            "containerPort": 32768,
            "exposedPort": 32768,
            "protocols": []
          }
        ]
      },
      "anycast": {
        "type": "iPv4",
        "portMappings": [
          {
            "containerPort": 32768,
            "exposedPort": 32768,
            "protocols": []
          }
        ]
      }
    }
  ],
  "environmentVariablesSuggestions": [
    {
      "name": "<string>",
      "defaultValue": "<string>",
      "description": "<string>",
      "required": true
    }
  ],
  "volumeSuggestions": [
    {
      "containerPath": "<string>",
      "suggestedVolumeName": "<string>"
    }
  ],
  "appName": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "registryUrl": "<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.

Body

application/jsontext/jsonapplication/*+json

registryId · string · required

The registry identifier. Can be "dockerhub", "github", or a private registry ID.

Minimum string length: 1

imageName · string · required

Required string length: 1 - 100

imageNamespace · string · required

Required string length: 1 - 100

tag · string · required

Required string length: 1 - 100

Response

200

application/json

Configuration suggestions were successfully retrieved.

endpointSuggestions · object[]

Show child attributes

environmentVariablesSuggestions · object[]

Show child attributes

volumeSuggestions · object[]

Show child attributes

appName · string | null

description · string | null

instructions · string | null

registryUrl · string | null