---
updatedAt: 2025-10-16T18:02:23.000Z
agentTools:
projectIndex: https://developers.bitlaunch.io/llms.txt
---
# Get Host Create Options
|
Host ID
|
Host
|
|
0
|
DigitalOcean
|
|
1
|
Vultr
|
|
2
|
Linode
|
|
4
|
BitLaunch
|
## Response
This will return a [Server Creation Options Object](https://developers.bitlaunch.io/reference/the-creation-options-object).
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "bitlaunch-api",
"version": "1.0"
},
"servers": [
{
"url": "https://app.bitlaunch.io/api/"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"x-bearer-format": "bearer"
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/hosts-create-options/{host_id}": {
"get": {
"summary": "Get Host Create Options",
"description": "",
"operationId": "view-host-create-options",
"parameters": [
{
"name": "host_id",
"in": "path",
"description": "The unique host ID",
"schema": {
"type": "string",
"default": "0"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"hostID\": 4,\n \"image\": [\n {\n \"id\": 1,\n \"name\": \"Ubuntu\",\n \"type\": \"image\",\n \"minDiskSize\": 20,\n \"unavailableRegions\": [],\n \"version\": {\n \"id\": \"10000\",\n \"description\": \"Ubuntu 18.04 LTS\",\n \"passwordUnsupported\": false\n },\n \"versions\": [\n {\n \"id\": \"10000\",\n \"description\": \"Ubuntu 18.04 LTS\",\n \"passwordUnsupported\": false\n },\n {\n \"id\": \"10001\",\n \"description\": \"Ubuntu 19.04\",\n \"passwordUnsupported\": false\n }\n ],\n \"extraCostPerMonth\": 0,\n \"windows\": false\n },\n {\n \"id\": 2,\n \"name\": \"CentOS\",\n \"type\": \"image\",\n \"minDiskSize\": 20,\n \"unavailableRegions\": [],\n \"version\": {\n \"id\": \"11000\",\n \"description\": \"CentOS 7.6\",\n \"passwordUnsupported\": false\n },\n \"versions\": [],\n \"extraCostPerMonth\": 0,\n \"windows\": false\n },\n {\n \"id\": 3,\n \"name\": \"Debian\",\n \"type\": \"image\",\n \"minDiskSize\": 20,\n \"unavailableRegions\": [],\n \"version\": {\n \"id\": \"12001\",\n \"description\": \"Debian 10\",\n \"passwordUnsupported\": false\n },\n \"versions\": [],\n \"extraCostPerMonth\": 0,\n \"windows\": false\n },\n {\n \"id\": 4,\n \"name\": \"Windows\",\n \"type\": \"image\",\n \"minDiskSize\": 50,\n \"unavailableRegions\": [],\n \"version\": {\n \"id\": \"13000\",\n \"description\": \"Windows 10 Pro\",\n \"passwordUnsupported\": false\n },\n \"versions\": [],\n \"extraCostPerMonth\": 0,\n \"windows\": true\n },\n {\n \"id\": 5,\n \"name\": \"OpenVPN\",\n \"type\": \"app\",\n \"minDiskSize\": 20,\n \"unavailableRegions\": [],\n \"version\": {\n \"id\": \"20000\",\n \"description\": \"OpenVPN\",\n \"passwordUnsupported\": false\n },\n \"versions\": [],\n \"extraCostPerMonth\": 0,\n \"windows\": false\n },\n {\n \"id\": 6,\n \"name\": \"WireGuard VPN\",\n \"type\": \"app\",\n \"minDiskSize\": 20,\n \"unavailableRegions\": [],\n \"version\": {\n \"id\": \"21000\",\n \"description\": \"WireGuard VPN\",\n \"passwordUnsupported\": false\n },\n \"versions\": [],\n \"extraCostPerMonth\": 0,\n \"windows\": false\n },\n {\n \"id\": 7,\n \"name\": \"Shadowsocks\",\n \"type\": \"app\",\n \"minDiskSize\": 20,\n \"unavailableRegions\": [],\n \"version\": {\n \"id\": \"22000\",\n \"description\": \"Shadowsocks\",\n \"passwordUnsupported\": false\n },\n \"versions\": [\n {\n \"id\": \"22000\",\n \"description\": \"Shadowsocks\",\n \"passwordUnsupported\": false\n },\n {\n \"id\": \"22001\",\n \"description\": \"ShadowsocksR\",\n \"passwordUnsupported\": false\n }\n ],\n \"extraCostPerMonth\": 0,\n \"windows\": false\n },\n {\n \"id\": 8,\n \"name\": \"WordPress\",\n \"type\": \"app\",\n \"minDiskSize\": 20,\n \"unavailableRegions\": [],\n \"version\": {\n \"id\": \"23000\",\n \"description\": \"Wordpress\",\n \"passwordUnsupported\": false\n },\n \"versions\": [],\n \"extraCostPerMonth\": 0,\n \"windows\": false\n },\n {\n \"id\": 9,\n \"name\": \"LEMP\",\n \"type\": \"app\",\n \"minDiskSize\": 20,\n \"unavailableRegions\": [],\n \"version\": {\n \"id\": \"24000\",\n \"description\": \"LEMP Stack\",\n \"passwordUnsupported\": false\n },\n \"versions\": [],\n \"extraCostPerMonth\": 0,\n \"windows\": false\n }\n ],\n \"region\": [\n {\n \"id\": 0,\n \"name\": \"Amsterdam\",\n \"iso\": \"nl\",\n \"subregion\": {\n \"id\": \"ams1\",\n \"description\": \"1\",\n \"slug\": \"ams1\",\n \"unavailableSizes\": [\n \"nibble-2048\",\n \"nibble-4096\",\n \"nibble-8192\",\n \"nibble-16384\"\n ]\n },\n \"subregions\": []\n },\n {\n \"id\": 1,\n \"name\": \"London\",\n \"iso\": \"gb\",\n \"subregion\": {\n \"id\": \"lon1\",\n \"description\": \"1\",\n \"slug\": \"lon1\",\n \"unavailableSizes\": []\n },\n \"subregions\": []\n },\n {\n \"id\": 2,\n \"name\": \"Los Angeles\",\n \"iso\": \"us\",\n \"subregion\": {\n \"id\": \"lax1\",\n \"description\": \"1\",\n \"slug\": \"lax1\",\n \"unavailableSizes\": []\n },\n \"subregions\": []\n }\n ],\n \"size\": [\n {\n \"id\": \"nibble-1024\",\n \"slug\": \"Nibble-1024\",\n \"bandwidthGB\": 1000,\n \"cpuCount\": 1,\n \"diskGB\": 25,\n \"disks\": [\n {\n \"type\": \"SSD\",\n \"count\": 1,\n \"size\": \"25\",\n \"unit\": \"GB\"\n }\n ],\n \"memoryMB\": 1024,\n \"costPerHr\": 14,\n \"costPerMonth\": 10,\n \"planType\": \"standard\"\n },\n {\n \"id\": \"nibble-2048\",\n \"slug\": \"Nibble-2048\",\n \"bandwidthGB\": 2000,\n \"cpuCount\": 2,\n \"diskGB\": 50,\n \"disks\": [\n {\n \"type\": \"SSD\",\n \"count\": 1,\n \"size\": \"50\",\n \"unit\": \"GB\"\n }\n ],\n \"memoryMB\": 2048,\n \"costPerHr\": 27,\n \"costPerMonth\": 20,\n \"planType\": \"standard\"\n },\n {\n \"id\": \"nibble-4096\",\n \"slug\": \"Nibble-4096\",\n \"bandwidthGB\": 3000,\n \"cpuCount\": 2,\n \"diskGB\": 100,\n \"disks\": [\n {\n \"type\": \"SSD\",\n \"count\": 1,\n \"size\": \"100\",\n \"unit\": \"GB\"\n }\n ],\n \"memoryMB\": 4096,\n \"costPerHr\": 54,\n \"costPerMonth\": 40,\n \"planType\": \"standard\"\n },\n {\n \"id\": \"nibble-8192\",\n \"slug\": \"Nibble-8192\",\n \"bandwidthGB\": 4000,\n \"cpuCount\": 4,\n \"diskGB\": 150,\n \"disks\": [\n {\n \"type\": \"SSD\",\n \"count\": 1,\n \"size\": \"150\",\n \"unit\": \"GB\"\n }\n ],\n \"memoryMB\": 8192,\n \"costPerHr\": 108,\n \"costPerMonth\": 80,\n \"planType\": \"standard\"\n },\n {\n \"id\": \"nibble-16384\",\n \"slug\": \"Nibble-16384\",\n \"bandwidthGB\": 5000,\n \"cpuCount\": 6,\n \"diskGB\": 300,\n \"disks\": [\n {\n \"type\": \"SSD\",\n \"count\": 1,\n \"size\": \"300\",\n \"unit\": \"GB\"\n }\n ],\n \"memoryMB\": 16384,\n \"costPerHr\": 216,\n \"costPerMonth\": 160,\n \"planType\": \"standard\"\n }\n ],\n \"available\": true,\n \"bandwidthCost\": 10,\n \"planTypes\": [\n {\n \"type\": \"standard\",\n \"description\": \"Fast SSD KVM virtual machines with a mix of compute resources and dedicated memory for a variety of applications.\",\n \"name\": \"Standard\"\n }\n ],\n \"hostOptions\": {\n \"rebuild\": true,\n \"resize\": true,\n \"backups\": false,\n \"userScript\": false\n }\n}\n"
}
},
"schema": {
"type": "object",
"properties": {
"hostID": {
"type": "integer",
"example": 4,
"default": 0
},
"image": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1,
"default": 0
},
"name": {
"type": "string",
"example": "Ubuntu"
},
"type": {
"type": "string",
"example": "image"
},
"minDiskSize": {
"type": "integer",
"example": 20,
"default": 0
},
"unavailableRegions": {
"type": "array"
},
"version": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "10000"
},
"description": {
"type": "string",
"example": "Ubuntu 18.04 LTS"
},
"passwordUnsupported": {
"type": "boolean",
"example": false,
"default": true
}
}
},
"versions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "10000"
},
"description": {
"type": "string",
"example": "Ubuntu 18.04 LTS"
},
"passwordUnsupported": {
"type": "boolean",
"example": false,
"default": true
}
}
}
},
"extraCostPerMonth": {
"type": "integer",
"example": 0,
"default": 0
},
"windows": {
"type": "boolean",
"example": false,
"default": true
}
}
}
},
"region": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 0,
"default": 0
},
"name": {
"type": "string",
"example": "Amsterdam"
},
"iso": {
"type": "string",
"example": "nl"
},
"subregion": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ams1"
},
"description": {
"type": "string",
"example": "1"
},
"slug": {
"type": "string",
"example": "ams1"
},
"unavailableSizes": {
"type": "array",
"items": {
"type": "string",
"example": "nibble-2048"
}
}
}
},
"subregions": {
"type": "array"
}
}
}
},
"size": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "nibble-1024"
},
"slug": {
"type": "string",
"example": "Nibble-1024"
},
"bandwidthGB": {
"type": "integer",
"example": 1000,
"default": 0
},
"cpuCount": {
"type": "integer",
"example": 1,
"default": 0
},
"diskGB": {
"type": "integer",
"example": 25,
"default": 0
},
"disks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "SSD"
},
"count": {
"type": "integer",
"example": 1,
"default": 0
},
"size": {
"type": "string",
"example": "25"
},
"unit": {
"type": "string",
"example": "GB"
}
}
}
},
"memoryMB": {
"type": "integer",
"example": 1024,
"default": 0
},
"costPerHr": {
"type": "integer",
"example": 14,
"default": 0
},
"costPerMonth": {
"type": "integer",
"example": 10,
"default": 0
},
"planType": {
"type": "string",
"example": "standard"
}
}
}
},
"available": {
"type": "boolean",
"example": true,
"default": true
},
"bandwidthCost": {
"type": "integer",
"example": 10,
"default": 0
},
"planTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "standard"
},
"description": {
"type": "string",
"example": "Fast SSD KVM virtual machines with a mix of compute resources and dedicated memory for a variety of applications."
},
"name": {
"type": "string",
"example": "Standard"
}
}
}
},
"hostOptions": {
"type": "object",
"properties": {
"rebuild": {
"type": "boolean",
"example": true,
"default": true
},
"resize": {
"type": "boolean",
"example": true,
"default": true
},
"backups": {
"type": "boolean",
"example": false,
"default": true
},
"userScript": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "curl",
"code": "curl 'https://app.bitlaunch.io/api/hosts-create-options/4' -H 'Authorization: Bearer API_KEY'"
},
{
"language": "shell",
"code": "blcli create-options ",
"name": "CLI"
},
{
"language": "go",
"code": "c := gobitlaunch.NewClient(token)\n\nopts, err := c.CreateOptions.Show(4)\nif err != nil {\n // handle error\n}\n\n// use opts"
},
{
"language": "python",
"code": "c = pybitlaunch.Client(token)\n\nopts, err = c.CreateOptions.Show(4)\nif err is not None:\n # handle error\nelse:\n # use opts"
}
],
"samples-languages": [
"curl",
"shell",
"go",
"python"
]
}
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": false,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```