pydo.droplets.list_neighbors_ids()

Description

To retrieve a list of all Droplets that are co-located on the same physical hardware, send a GET request to /v2/reports/droplet_neighbors_ids.

The results will be returned as a JSON object with a key of neighbor_ids. This will be set to an array of arrays. Each array will contain a set of Droplet IDs for Droplets that share a physical server. An empty array indicates that all Droplets associated with your account are located on separate physical hardware.

Request Sample

import os
from pydo import Client

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

resp = client.droplets.list_neighbors_ids()

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

{
  "neighbor_ids": [
    [
      168671828,
      168663509,
      168671815
    ],
    [
      168671883,
      168671750
    ]
  ]
}

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

{
  "id": "example_error",
  "message": "some error message"
}