To show information about an individual Droplet, send a GET request to
/v2/droplets/$DROPLET_ID.
643 matches
60 actions
DigitalOcean
60 actions
- Create a New DomainPOSTv1.0.0
- Create a New Domain RecordPOSTv1.0.0
- Get Customer BalanceGETv1.0.0
- Get NamespaceGETv1.0.0
- Get TriggerGETv1.0.0
- Get User InformationGETv1.0.0
- List All ActionsGETv1.0.0
- List All Actions for a Floating IPGETv1.0.0
- List All Actions for an ImageGETv1.0.0
- List all app alertsGETv1.0.0
- List All CDN EndpointsGETv1.0.0
- List All CertificatesGETv1.0.0
- List All Database ClustersGETv1.0.0
- List all Database UsersGETv1.0.0
- List All DatabasesGETv1.0.0
- List All Domain RecordsGETv1.0.0
- List All DomainsGETv1.0.0
- List All Droplet NeighborsGETv1.0.0
- List All FirewallsGETv1.0.0
- List All Floating IPsGETv1.0.0
- List All Read-only ReplicasGETv1.0.0
- List App RegionsGETv1.0.0
- List App TiersGETv1.0.0
- List Associated Resources for a DropletGETv1.0.0
- List Backups for a Database ClusterGETv1.0.0
- List Billing HistoryGETv1.0.0
- List Connection Pools (PostgreSQL)GETv1.0.0
- List Database OptionsGETv1.0.0
- List Default Project ResourcesGETv1.0.0
- List Firewall Rules (Trusted Sources) for a Database ClusterGETv1.0.0
- List Instance SizesGETv1.0.0
- List NamespacesGETv1.0.0
- List Neighbors for a DropletGETv1.0.0
- List TriggersGETv1.0.0
- Retrieve a Droplet ActionGETv1.0.0
- Retrieve an App DeploymentGETv1.0.0
- Retrieve an App TierGETv1.0.0
- Retrieve an Existing ActionGETv1.0.0
- Retrieve an Existing ActionGETv1.0.0
- Retrieve an Existing AppGETv1.0.0
- Retrieve an Existing CDN EndpointGETv1.0.0
- Retrieve an Existing CertificateGETv1.0.0
- Retrieve an Existing DatabaseGETv1.0.0
- Retrieve an Existing Database ClusterGETv1.0.0
- Retrieve an Existing Database Cluster ConfigurationGETv1.0.0
- Retrieve an Existing Database UserGETv1.0.0
- Retrieve an Existing DomainGETv1.0.0
- Retrieve an Existing Domain RecordGETv1.0.0
- Retrieve an Existing DropletGETv1.0.0
- Retrieve an Existing FirewallGETv1.0.0
- Retrieve an Existing Floating IPGETv1.0.0
- Retrieve an Existing Floating IP ActionGETv1.0.0
- Retrieve an Existing Read-only ReplicaGETv1.0.0
- Retrieve an Instance SizeGETv1.0.0
- Retrieve App Daily Bandwidth MetricsGETv1.0.0
- Retrieve Existing Connection Pool (PostgreSQL)GETv1.0.0
- Retrieve the Eviction Policy for a Redis ClusterGETv1.0.0
- Retrieve the Public CertificateGETv1.0.0
- Retrieve the SQL Modes for a MySQL ClusterGETv1.0.0
- Retrieve the Status of an Online MigrationGETv1.0.0
Infrastructure/DigitalOcean
Retrieve an Existing Droplet
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
{
"type": "object",
"properties": {
"droplet_id": {
"type": "integer"
}
},
"required": [
"droplet_id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 419
- 420
- 421
- 422
- 423
- 424
- 425
{
"properties": {
"droplet": {
"type": "object",
"required": [
"backup_ids",
"created_at",
"disk",
"features",
"id",
"image",
"locked",
"memory",
"name",
"networks",
"next_backup_window",
"region",
"size",
"size_slug",
"snapshot_ids",
"status",
"tags",
"vcpus",
"volume_ids"
],
"properties": {
"backup_ids": {
"type": "array",
"description": "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.",
"items": {
"type": "integer"
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "A time value given in ISO8601 combined date and time format that represents when the Droplet was created."
},
"disk": {
"type": "integer",
"description": "The size of the Droplet's disk in gigabytes."
},
"features": {
"type": "array",
"description": "An array of features enabled on this Droplet.",
"items": {
"type": "string"
}
},
"id": {
"type": "integer",
"description": "A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation."
},
"image": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"description": "A time value given in ISO8601 combined date and time format that represents when the image was created."
},
"description": {
"type": "string",
"description": "An optional free-form text field to describe an image."
},
"distribution": {
"type": "string",
"description": "The name of a custom image's distribution. Currently, the valid values are `Arch Linux`, `CentOS`, `CoreOS`, `Debian`, `Fedora`, `Fedora Atomic`, `FreeBSD`, `Gentoo`, `openSUSE`, `RancherOS`, `Rocky Linux`, `Ubuntu`, and `Unknown`. Any other value will be accepted but ignored, and `Unknown` will be used in its place.",
"enum": [
"Arch Linux",
"CentOS",
"CoreOS",
"Debian",
"Fedora",
"Fedora Atomic",
"FreeBSD",
"Gentoo",
"openSUSE",
"RancherOS",
"Rocky Linux",
"Ubuntu",
"Unknown"
]
},
"error_message": {
"type": "string",
"description": "A string containing information about errors that may occur when importing\n a custom image."
},
"id": {
"type": "integer",
"description": "A unique number that can be used to identify and reference a specific image."
},
"min_disk_size": {
"type": "integer",
"description": "The minimum disk size in GB required for a Droplet to use this image."
},
"name": {
"type": "string",
"description": "The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question."
},
"public": {
"type": "boolean",
"description": "This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account."
},
"regions": {
"type": "array",
"description": "This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.",
"items": {
"type": "string",
"description": "The slug identifier for the region where the resource will initially be available.",
"enum": [
"ams1",
"ams2",
"ams3",
"blr1",
"fra1",
"lon1",
"nyc1",
"nyc2",
"nyc3",
"sfo1",
"sfo2",
"sfo3",
"sgp1",
"tor1"
]
}
},
"size_gigabytes": {
"type": "number",
"format": "float",
"description": "The size of the image in gigabytes."
},
"slug": {
"type": "string",
"description": "A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id."
},
"status": {
"type": "string",
"description": "A status string indicating the state of a custom image. This may be `NEW`,\n `available`, `pending`, `deleted`, or `retired`.",
"enum": [
"NEW",
"available",
"pending",
"deleted",
"retired"
]
},
"tags": {
"type": "array",
"description": "A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Describes the kind of image. It may be one of `base`, `snapshot`, `backup`, `custom`, or `admin`. Respectively, this specifies whether an image is a DigitalOcean base OS image, user-generated Droplet snapshot, automatically created Droplet backup, user-provided virtual machine image, or an image used for DigitalOcean managed resources (e.g. DOKS worker nodes).",
"enum": [
"base",
"snapshot",
"backup",
"custom",
"admin"
]
}
}
},
"kernel": {
"type": "object",
"description": "**Note**: All Droplets created after March 2017 use internal kernels by default.\nThese Droplets will have this attribute set to `null`.\n\nThe current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)\nfor Droplets with externally managed kernels. This will initially be set to\nthe kernel of the base image when the Droplet is created.\n",
"properties": {
"id": {
"type": "integer",
"description": "A unique number used to identify and reference a specific kernel."
},
"name": {
"type": "string",
"description": "The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question."
},
"version": {
"type": "string",
"description": "A standard kernel version string representing the version, patch, and release information."
}
}
},
"locked": {
"type": "boolean",
"description": "A boolean value indicating whether the Droplet has been locked, preventing actions by users."
},
"memory": {
"type": "integer",
"description": "Memory of the Droplet in megabytes."
},
"name": {
"type": "string",
"description": "The human-readable name set for the Droplet instance."
},
"networks": {
"type": "object",
"description": "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.",
"properties": {
"v4": {
"type": "array",
"items": {
"type": "object",
"properties": {
"gateway": {
"type": "string",
"description": "The gateway of the specified IPv4 network interface.\n\nFor private interfaces, a gateway is not provided. This is denoted by\nreturning `nil` as its value.\n"
},
"ip_address": {
"type": "string",
"format": "ipv4",
"description": "The IP address of the IPv4 network interface."
},
"netmask": {
"type": "string",
"format": "ipv4",
"description": "The netmask of the IPv4 network interface."
},
"type": {
"type": "string",
"description": "The type of the IPv4 network interface.",
"enum": [
"public",
"private"
]
}
}
}
},
"v6": {
"type": "array",
"items": {
"type": "object",
"properties": {
"gateway": {
"type": "string",
"format": "ipv6",
"description": "The gateway of the specified IPv6 network interface."
},
"ip_address": {
"type": "string",
"format": "ipv6",
"description": "The IP address of the IPv6 network interface."
},
"netmask": {
"type": "integer",
"description": "The netmask of the IPv6 network interface."
},
"type": {
"type": "string",
"description": "The type of the IPv6 network interface.\n\n**Note**: IPv6 private networking is not currently supported.\n",
"enum": [
"public"
]
}
}
}
}
}
},
"next_backup_window": {
"type": "object",
"description": "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.",
"properties": {
"end": {
"type": "string",
"format": "date-time",
"description": "A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window."
},
"start": {
"type": "string",
"format": "date-time",
"description": "A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window."
}
}
},
"region": {
"type": "object",
"required": [
"available",
"features",
"name",
"sizes",
"slug"
],
"properties": {
"available": {
"type": "boolean",
"description": "This is a boolean value that represents whether new Droplets can be created in this region."
},
"features": {
"description": "This attribute is set to an array which contains features available in this region",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"description": "The display name of the region. This will be a full name that is used in the control panel and other interfaces."
},
"sizes": {
"description": "This attribute is set to an array which contains the identifying slugs for the sizes available in this region.",
"items": {
"type": "string"
}
},
"slug": {
"type": "string",
"description": "A human-readable string that is used as a unique identifier for each region."
}
}
},
"size": {
"type": "object",
"required": [
"available",
"description",
"disk",
"memory",
"price_hourly",
"price_monthly",
"regions",
"slug",
"transfer",
"vcpus"
],
"properties": {
"available": {
"type": "boolean",
"description": "This is a boolean value that represents whether new Droplets can be created with this size."
},
"description": {
"type": "string",
"description": "A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized."
},
"disk": {
"type": "integer",
"description": "The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes."
},
"memory": {
"type": "integer",
"description": "The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes."
},
"price_hourly": {
"type": "number",
"format": "float",
"description": "This describes the price of the Droplet size as measured hourly. The value is measured in US dollars."
},
"price_monthly": {
"type": "number",
"format": "float",
"description": "This attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars."
},
"regions": {
"type": "array",
"description": "An array containing the region slugs where this size is available for Droplet creates.",
"items": {
"type": "string"
}
},
"slug": {
"type": "string",
"description": "A human-readable string that is used to uniquely identify each size."
},
"transfer": {
"type": "number",
"format": "float",
"description": "The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes."
},
"vcpus": {
"type": "integer",
"description": "The integer of number CPUs allocated to Droplets of this size."
}
}
},
"size_slug": {
"type": "string",
"description": "The unique slug identifier for the size of this Droplet."
},
"snapshot_ids": {
"type": "array",
"description": "An array of snapshot IDs of any snapshots created from the Droplet instance.",
"items": {
"type": "integer"
}
},
"status": {
"type": "string",
"description": "A status string indicating the state of the Droplet instance. This may be \"new\", \"active\", \"off\", or \"archive\".",
"enum": [
"new",
"active",
"off",
"archive"
]
},
"tags": {
"type": "array",
"description": "An array of Tags the Droplet has been tagged with.",
"items": {
"type": "string"
}
},
"vcpus": {
"type": "integer",
"description": "The number of virtual CPUs."
},
"volume_ids": {
"type": "array",
"description": "A flat array including the unique identifier for each Block Storage volume attached to the Droplet.",
"items": {
"type": "string"
}
},
"vpc_uuid": {
"type": "string",
"description": "A string specifying the UUID of the VPC to which the Droplet is assigned."
}
}
}
}
}