## List Neighbors

`gpu_droplets.list_neighbors(intdroplet_id)  -> GPUDropletListNeighborsResponse`

**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.

### Parameters

- **droplet\_id:** `int`

### Returns

- `class GPUDropletListNeighborsResponse`

  - **droplets:** `Optional[List[Droplet]]`

    - **id:** `int`

      A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.

    - **backup\_ids:** `List[int]`

      An array of backup IDs of any backups that have been taken of the Droplet instance.  Droplet backups are enabled at the time of the instance creation.<br>Requires `image:read` scope.

    - **created\_at:** `datetime`

      A time value given in ISO8601 combined date and time format that represents when the Droplet was created.

    - **disk:** `int`

      The size of the Droplet's disk in gigabytes.

    - **features:** `List[str]`

      An array of features enabled on this Droplet.

    - **image:** `Image`

      The Droplet's image.<br>Requires `image:read` scope.

    - **locked:** `bool`

      A boolean value indicating whether the Droplet has been locked, preventing actions by users.

    - **memory:** `int`

      Memory of the Droplet in megabytes.

    - **name:** `str`

      The human-readable name set for the Droplet instance.

    - **networks:** `Networks`

      The details of the network that are configured for the Droplet instance.  This is an object that contains keys for IPv4 and IPv6.  The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet.  These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.

      - **v4:** `Optional[List[NetworkV4]]`

        - **gateway:** `Optional[str]`

          The gateway of the specified IPv4 network interface.

          For private interfaces, a gateway is not provided. This is denoted by
          returning `nil` as its value.

        - **ip\_address:** `Optional[str]`

          The IP address of the IPv4 network interface.

        - **netmask:** `Optional[str]`

          The netmask of the IPv4 network interface.

        - **type:** `Optional[Literal["public", "private"]]`

          The type of the IPv4 network interface.

          - `"public"`

          - `"private"`

      - **v6:** `Optional[List[NetworkV6]]`

        - **gateway:** `Optional[str]`

          The gateway of the specified IPv6 network interface.

        - **ip\_address:** `Optional[str]`

          The IP address of the IPv6 network interface.

        - **netmask:** `Optional[int]`

          The netmask of the IPv6 network interface.

        - **type:** `Optional[Literal["public"]]`

          The type of the IPv6 network interface.

          **Note**: IPv6 private  networking is not currently supported.

          - `"public"`

    - **next\_backup\_window:** `Optional[DropletNextBackupWindow]`

      The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.

    - **region:** `Region`

    - **size:** `Size`

    - **size\_slug:** `str`

      The unique slug identifier for the size of this Droplet.

    - **snapshot\_ids:** `List[int]`

      An array of snapshot IDs of any snapshots created from the Droplet instance.<br>Requires `image:read` scope.

    - **status:** `Literal["new", "active", "off", "archive"]`

      A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".

      - `"new"`

      - `"active"`

      - `"off"`

      - `"archive"`

    - **tags:** `List[str]`

      An array of Tags the Droplet has been tagged with.<br>Requires `tag:read` scope.

    - **vcpus:** `int`

      The number of virtual CPUs.

    - **volume\_ids:** `List[str]`

      A flat array including the unique identifier for each Block Storage volume attached to the Droplet.<br>Requires `block_storage:read` scope.

    - **disk\_info:** `Optional[List[DiskInfo]]`

      An array of objects containing information about the disks available to the Droplet.

      - **size:** `Optional[Size]`

        - **amount:** `Optional[int]`

          The amount of space allocated to the disk.

        - **unit:** `Optional[str]`

          The unit of measure for the disk size.

      - **type:** `Optional[Literal["local", "scratch"]]`

        The type of disk. All Droplets contain a `local` disk. Additionally, GPU Droplets can also have a `scratch` disk for non-persistent data.

        - `"local"`

        - `"scratch"`

    - **gpu\_info:** `Optional[GPUInfo]`

      An object containing information about the GPU capabilities of Droplets created with this size.

    - **kernel:** `Optional[Kernel]`

      **Note**: All Droplets created after March 2017 use internal kernels by default.
      These Droplets will have this attribute set to `null`.

      The current [kernel](https://docs.digitalocean.com/products/droplets/how-to/kernel/)
      for Droplets with externally managed kernels. This will initially be set to
      the kernel of the base image when the Droplet is created.

    - **vpc\_uuid:** `Optional[str]`

      A string specifying the UUID of the VPC to which the Droplet is assigned.<br>Requires `vpc:read` scope.

### Example

```python
from do_gradientai import GradientAI

client = GradientAI()
response = client.gpu_droplets.list_neighbors(
    1,
)
print(response.droplets)
```