For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.droplets.list_neighbors(droplet_id=3164444)

Description

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.

Parameters

droplet_id integer required

A unique identifier for a Droplet instance.

Min: 1

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.droplets.list_neighbors(droplet_id=594828)

Response Example

{
  "droplets": []
}

More Information

See /v2/droplets/{droplet_id}/neighbors in the API reference for additional detail on responses, headers, parameters, and more.