Skip to main content
POST
/
registries
/
config-suggestions
Get Container Config Suggestions
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>"
}
'
{
  "endpointSuggestions": [
    {
      "displayName": "<string>",
      "cdn": {
        "isSslEnabled": true,
        "stickySessions": {
          "sessionHeaders": [
            "<string>"
          ],
          "enabled": true,
          "cookieName": "<string>"
        },
        "pullZoneId": 123,
        "portMappings": [
          {
            "containerPort": 32768,
            "exposedPort": 32768,
            "protocols": [
              "Tcp"
            ]
          }
        ]
      },
      "anycast": {
        "type": "IPv4",
        "portMappings": [
          {
            "containerPort": 32768,
            "exposedPort": 32768,
            "protocols": [
              "Tcp"
            ]
          }
        ]
      }
    }
  ],
  "environmentVariablesSuggestions": [
    {
      "name": "<string>",
      "defaultValue": "<string>",
      "description": "<string>",
      "required": true
    }
  ],
  "appName": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "registryUrl": "<string>"
}

Authorizations

AccessKey
string
header
required

Please enter a valid personal API key.

Body

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

Configuration suggestions were successfully retrieved.

endpointSuggestions
object[]
environmentVariablesSuggestions
object[]
appName
string | null
description
string | null
instructions
string | null
registryUrl
string | null