List Neighbors
List Neighbors for a Droplet
get/v2/droplets/{droplet_id}/neighbors
To retrieve a list of any "neighbors" (i.e. Droplets that are co-located on
the same physical hardware) for a specific Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/neighbors.
The results will be returned as a JSON object with a key of droplets. This
will be set to an array containing objects representing any other Droplets
that share the same physical hardware. An empty array indicates that the
Droplet is not co-located any other Droplets associated with your account.
Path Parameters
droplet_id: number
Returns
curl https://api.digitalocean.com/v2/droplets/$DROPLET_ID/neighbors \
-H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"
{
"droplets": [
{
"id": 3164444,
"backup_ids": [
53893572
],
"created_at": "2020-07-21T18:37:44Z",
"disk": 25,
"features": [
"backups",
"private_networking",
"ipv6"
],
"image": {
"created_at": "2020-05-04T22:23:02Z",
"description": " ",
"distribution": "Ubuntu",
"error_message": " ",
"min_disk_size": 20,
"name": "Nifty New Snapshot",
"public": true,
"regions": [
"nyc1",
"nyc2"
],
"size_gigabytes": 2.34,
"slug": "nifty1",
"status": "NEW",
"tags": [
"base-image",
"prod"
],
"type": "snapshot"
},
"locked": false,
"memory": 1024,
"name": "example.com",
"networks": {
"v4": [
{
"gateway": "104.236.0.1",
"ip_address": "104.236.32.182",
"netmask": "255.255.192.0",
"type": "public"
}
],
"v6": [
{
"gateway": "2604:a880:0:1010::1",
"ip_address": "2604:a880:0:1010::18a:a001",
"netmask": 64,
"type": "public"
}
]
},
"next_backup_window": {
"end": "2019-12-04T23:00:00Z",
"start": "2019-12-04T00:00:00Z"
},
"region": {
"available": true,
"features": [
"private_networking",
"backups",
"ipv6",
"metadata",
"install_agent",
"storage",
"image_transfer"
],
"name": "New York 3",
"sizes": [
"s-1vcpu-1gb",
"s-1vcpu-2gb",
"s-1vcpu-3gb",
"s-2vcpu-2gb",
"s-3vcpu-1gb",
"s-2vcpu-4gb",
"s-4vcpu-8gb",
"s-6vcpu-16gb",
"s-8vcpu-32gb",
"s-12vcpu-48gb",
"s-16vcpu-64gb",
"s-20vcpu-96gb",
"s-24vcpu-128gb",
"s-32vcpu-192g"
],
"slug": "nyc3"
},
"size": {
"available": true,
"description": "Basic",
"disk": 25,
"memory": 1024,
"price_hourly": 0.00743999984115362,
"price_monthly": 5,
"regions": [
"ams2",
"ams3",
"blr1",
"fra1",
"lon1",
"nyc1",
"nyc2",
"nyc3",
"sfo1",
"sfo2",
"sfo3",
"sgp1",
"tor1"
],
"slug": "s-1vcpu-1gb",
"transfer": 1,
"vcpus": 1,
"disk_info": [
{
"size": {
"amount": 25,
"unit": "gib"
},
"type": "local"
}
],
"gpu_info": {
"count": 1,
"model": "nvidia_h100",
"vram": {
"amount": 25,
"unit": "gib"
}
}
},
"size_slug": "s-1vcpu-1gb",
"snapshot_ids": [
67512819
],
"status": "active",
"tags": [
"web",
"env:prod"
],
"vcpus": 1,
"volume_ids": [
"506f78a4-e098-11e5-ad9f-000f53306ae1"
],
"disk_info": [
{
"size": {
"amount": 25,
"unit": "gib"
},
"type": "local"
}
],
"gpu_info": {
"count": 1,
"model": "nvidia_h100",
"vram": {
"amount": 25,
"unit": "gib"
}
},
"kernel": {
"id": 7515,
"name": "DigitalOcean GrubLoader v0.2 (20160714)",
"version": "2016.07.13-DigitalOcean_loader_Ubuntu"
},
"vpc_uuid": "760e09ef-dc84-11e8-981e-3cfdfeaae000"
}
]
}Returns Examples
{
"droplets": [
{
"id": 3164444,
"backup_ids": [
53893572
],
"created_at": "2020-07-21T18:37:44Z",
"disk": 25,
"features": [
"backups",
"private_networking",
"ipv6"
],
"image": {
"created_at": "2020-05-04T22:23:02Z",
"description": " ",
"distribution": "Ubuntu",
"error_message": " ",
"min_disk_size": 20,
"name": "Nifty New Snapshot",
"public": true,
"regions": [
"nyc1",
"nyc2"
],
"size_gigabytes": 2.34,
"slug": "nifty1",
"status": "NEW",
"tags": [
"base-image",
"prod"
],
"type": "snapshot"
},
"locked": false,
"memory": 1024,
"name": "example.com",
"networks": {
"v4": [
{
"gateway": "104.236.0.1",
"ip_address": "104.236.32.182",
"netmask": "255.255.192.0",
"type": "public"
}
],
"v6": [
{
"gateway": "2604:a880:0:1010::1",
"ip_address": "2604:a880:0:1010::18a:a001",
"netmask": 64,
"type": "public"
}
]
},
"next_backup_window": {
"end": "2019-12-04T23:00:00Z",
"start": "2019-12-04T00:00:00Z"
},
"region": {
"available": true,
"features": [
"private_networking",
"backups",
"ipv6",
"metadata",
"install_agent",
"storage",
"image_transfer"
],
"name": "New York 3",
"sizes": [
"s-1vcpu-1gb",
"s-1vcpu-2gb",
"s-1vcpu-3gb",
"s-2vcpu-2gb",
"s-3vcpu-1gb",
"s-2vcpu-4gb",
"s-4vcpu-8gb",
"s-6vcpu-16gb",
"s-8vcpu-32gb",
"s-12vcpu-48gb",
"s-16vcpu-64gb",
"s-20vcpu-96gb",
"s-24vcpu-128gb",
"s-32vcpu-192g"
],
"slug": "nyc3"
},
"size": {
"available": true,
"description": "Basic",
"disk": 25,
"memory": 1024,
"price_hourly": 0.00743999984115362,
"price_monthly": 5,
"regions": [
"ams2",
"ams3",
"blr1",
"fra1",
"lon1",
"nyc1",
"nyc2",
"nyc3",
"sfo1",
"sfo2",
"sfo3",
"sgp1",
"tor1"
],
"slug": "s-1vcpu-1gb",
"transfer": 1,
"vcpus": 1,
"disk_info": [
{
"size": {
"amount": 25,
"unit": "gib"
},
"type": "local"
}
],
"gpu_info": {
"count": 1,
"model": "nvidia_h100",
"vram": {
"amount": 25,
"unit": "gib"
}
}
},
"size_slug": "s-1vcpu-1gb",
"snapshot_ids": [
67512819
],
"status": "active",
"tags": [
"web",
"env:prod"
],
"vcpus": 1,
"volume_ids": [
"506f78a4-e098-11e5-ad9f-000f53306ae1"
],
"disk_info": [
{
"size": {
"amount": 25,
"unit": "gib"
},
"type": "local"
}
],
"gpu_info": {
"count": 1,
"model": "nvidia_h100",
"vram": {
"amount": 25,
"unit": "gib"
}
},
"kernel": {
"id": 7515,
"name": "DigitalOcean GrubLoader v0.2 (20160714)",
"version": "2016.07.13-DigitalOcean_loader_Ubuntu"
},
"vpc_uuid": "760e09ef-dc84-11e8-981e-3cfdfeaae000"
}
]
}