droplets_neighbors

Creates, updates, deletes, gets or lists a droplets_neighbors resource.

Overview

Name	droplets_neighbors
Type	Resource
Id	digitalocean.compute.droplets_neighbors

Fields

The following fields are returned by SELECT queries:

droplets_list_neighbors

A JSON object with an droplets key.

Name	Datatype	Description
id	integer	A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.
name	string	The human-readable name set for the Droplet instance. (example: example.com)
backup_ids	array	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. Requires image:read scope.
created_at	string (date-time)	A time value given in ISO8601 combined date and time format that represents when the Droplet was created. (example: 2020-07-21T18:37:44Z)
disk	integer	The size of the Droplet's disk in gigabytes.
disk_info	array	An array of objects containing information about the disks available to the Droplet.
features	array	An array of features enabled on this Droplet.
gpu_info	object	An object containing information about the GPU capabilities of Droplets created with this size.
image	object	The Droplet's image. Requires image:read scope.
kernel	object	Note: All Droplets created after March 2017 use internal kernels by default. These Droplets will have this attribute set to null. The current kernel for Droplets with externally managed kernels. This will initially be set to the kernel of the base image when the Droplet is created.
locked	boolean	A boolean value indicating whether the Droplet has been locked, preventing actions by users.
memory	integer	Memory of the Droplet in megabytes.
networks	object	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.
next_backup_window	object	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	object
size	object
size_slug	string	The unique slug identifier for the size of this Droplet. (example: s-1vcpu-1gb)
snapshot_ids	array	An array of snapshot IDs of any snapshots created from the Droplet instance. Requires image:read scope.
status	string	A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive". (example: active)
tags	array	An array of Tags the Droplet has been tagged with. Requires tag:read scope.
vcpus	integer	The number of virtual CPUs.
volume_ids	array	A flat array including the unique identifier for each Block Storage volume attached to the Droplet. Requires block_storage:read scope.
vpc_uuid	string	A string specifying the UUID of the VPC to which the Droplet is assigned. Requires vpc:read scope. (example: 760e09ef-dc84-11e8-981e-3cfdfeaae000)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
droplets_list_neighbors	select	droplet_id		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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
droplet_id	integer	A unique identifier for a Droplet instance. (example: 3164444)

SELECT examples

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

SELECT
id,
name,
backup_ids,
created_at,
disk,
disk_info,
features,
gpu_info,
image,
kernel,
locked,
memory,
networks,
next_backup_window,
region,
size,
size_slug,
snapshot_ids,
status,
tags,
vcpus,
volume_ids,
vpc_uuid
FROM digitalocean.compute.droplets_neighbors
WHERE droplet_id = '{{ droplet_id }}' -- required;