Skip to main content
GET
/
servers
/
software
List available software
curl --request GET \
  --url https://your-domain.com/api/client/v1/servers/software \
  --header 'Authorization: Bearer <token>'
{
  "count": 5,
  "software": [
    {
      "id": 15,
      "name": "Paper",
      "type": "paper",
      "description": "Paper Minecraft server",
      "docker_images": [
        {
          "value": "ghcr.io/parkervcp/yolks:java_21",
          "label": "Java 21"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_17",
          "label": "Java 17"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_16",
          "label": "Java 16"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_8",
          "label": "Java 8"
        }
      ],
      "environment_variables": [
        {
          "key": "MINECRAFT_VERSION",
          "title": "Minecraft version",
          "description": "The desired Minecraft version to install (e.g. 1.20.1)",
          "default": "latest",
          "optional": false
        },
        {
          "key": "BUILD_NUMBER",
          "title": "Paper build number (optional)",
          "description": "The desired Paper build number to install (e.g. 100)",
          "default": "latest",
          "optional": true
        }
      ]
    },
    {
      "id": 16,
      "name": "Forge",
      "type": "forge",
      "description": "Forge Minecraft server",
      "docker_images": [
        {
          "value": "ghcr.io/parkervcp/yolks:java_21",
          "label": "Java 21"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_17",
          "label": "Java 17"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_16",
          "label": "Java 16"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_8",
          "label": "Java 8"
        }
      ],
      "environment_variables": [
        {
          "key": "MC_VERSION",
          "title": "Minecraft version",
          "description": "The desired Minecraft version to install (e.g. 1.20.1)",
          "default": "latest",
          "optional": false
        },
        {
          "key": "BUILD_TYPE",
          "title": "Build type",
          "description": "The desired Forge build type to install",
          "default": "recommended",
          "optional": false
        }
      ]
    },
    {
      "id": 28,
      "name": "NeoForge",
      "type": "neoforge",
      "description": "NeoForge Minecraft server",
      "docker_images": [
        {
          "value": "ghcr.io/parkervcp/yolks:java_21",
          "label": "Java 21"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_17",
          "label": "Java 17"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_16",
          "label": "Java 16"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_8",
          "label": "Java 8"
        }
      ],
      "environment_variables": [
        {
          "key": "MC_VERSION",
          "title": "Minecraft version",
          "description": "The desired Minecraft version to install (e.g. 1.20.1)",
          "default": "latest",
          "optional": false
        },
        {
          "key": "NEOFORGE_VERSION",
          "title": "NeoForge Version",
          "description": "The full exact NeoForge version",
          "default": "",
          "optional": false
        }
      ]
    },
    {
      "id": 24,
      "name": "Vanilla",
      "type": "vanilla",
      "description": "Vanilla Minecraft server",
      "docker_images": [
        {
          "value": "ghcr.io/parkervcp/yolks:java_21",
          "label": "Java 21"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_17",
          "label": "Java 17"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_16",
          "label": "Java 16"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_8",
          "label": "Java 8"
        }
      ],
      "environment_variables": [
        {
          "key": "VANILLA_VERSION",
          "title": "Minecraft version",
          "description": "The desired Minecraft version to install (e.g. 1.20.1)",
          "default": "latest",
          "optional": false
        }
      ]
    },
    {
      "id": 39,
      "name": "Fabric",
      "type": "fabric",
      "description": "Fabric Minecraft server",
      "docker_images": [
        {
          "value": "ghcr.io/parkervcp/yolks:java_21",
          "label": "Java 21"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_17",
          "label": "Java 17"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_16",
          "label": "Java 16"
        },
        {
          "value": "ghcr.io/parkervcp/yolks:java_8",
          "label": "Java 8"
        }
      ],
      "environment_variables": [
        {
          "key": "MC_VERSION",
          "title": "Minecraft version",
          "description": "The desired Minecraft version to install (e.g. 1.20.1)",
          "default": "latest",
          "optional": false
        },
        {
          "key": "FABRIC_VERSION",
          "title": "Fabric version",
          "description": "The desired Fabric version to install",
          "default": "latest",
          "optional": false
        },
        {
          "key": "LOADER_VERSION",
          "title": "Loader version",
          "description": "The desired Fabric Loader version to install",
          "default": "latest",
          "optional": false
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Software catalog

count
integer
software
object[]