Shared
Shared
ModelsExpand Collapse
Action = object { id, completed_at, region, 6 more }
id: optional number
A unique numeric ID that can be used to identify and reference an action.
completed_at: optional string
A time value given in ISO8601 combined date and time format that represents when the action was completed.
region_slug: optional string
A human-readable string that is used as a unique identifier for each region.
resource_id: optional number
A unique identifier for the resource that the action is associated with.
resource_type: optional string
The type of resource that the action is associated with.
started_at: optional string
A time value given in ISO8601 combined date and time format that represents when the action was initiated.
status: optional "in-progress" or "completed" or "errored"
The current status of the action. This can be "in-progress", "completed", or "errored".
type: optional string
This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action.
ActionLink = object { id, href, rel }
The linked actions can be used to check the status of a Droplet's create event.
id: optional number
A unique numeric ID that can be used to identify and reference an action.
href: optional string
A URL that can be used to access the action.
rel: optional string
A string specifying the type of the related action.
APILinks = object { pages }
Links to other pages
pages: optional object { first, last, next, previous }
Information about how to reach other pages
first: optional string
First page
last: optional string
Last page
next: optional string
Next page
previous: optional string
Previous page
APIMeta = object { page, pages, total }
Meta information about the data set
page: optional number
The current page
pages: optional number
Total number of pages
total: optional number
Total amount of items over all pages
BackwardLinks = object { first, prev }
first: optional string
URI of the first page of the results.
prev: optional string
URI of the previous page of the results.
ChatCompletionChunk = object { id, choices, created, 3 more }
Represents a streamed chunk of a chat completion response returned by the model, based on the provided input.
id: string
A unique identifier for the chat completion. Each chunk has the same ID.
choices: array of object { delta, finish_reason, index, logprobs }
A list of chat completion choices. Can contain more than one elements if n is greater than 1. Can also be empty for the
last chunk if you set stream_options: {"include_usage": true}.
delta: object { content, refusal, role, tool_calls }
A chat completion delta generated by streamed model responses.
content: optional string
The contents of the chunk message.
refusal: optional string
The refusal message generated by the model.
role: optional "developer" or "user" or "assistant"
The role of the author of this message.
tool_calls: optional array of object { index, id, function, type }
id: optional string
The ID of the tool call.
function: optional object { arguments, name }
A chunk of a function that the model called.
arguments: optional string
The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
name: optional string
The name of the function to call.
type: optional "function"
The type of the tool. Currently, only function is supported.
finish_reason: "stop" or "length" or "tool_calls"
The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, or
length if the maximum number of tokens specified in the request was reached,
tool_calls if the model called a tool.
index: number
The index of the choice in the list of choices.
logprobs: optional object { content, refusal }
Log probability information for the choice.
A list of message content tokens with log probability information.
A list of message refusal tokens with log probability information.
created: number
The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.
model: string
The model to generate the completion.
object: "chat.completion.chunk"
The object type, which is always chat.completion.chunk.
An optional field that will only be present when you set
stream_options: {"include_usage": true} in your request. When present, it
contains a null value except for the last chunk which contains the
token usage statistics for the entire request.
NOTE: If the stream is interrupted or cancelled, you may not receive the final usage chunk which contains the total token usage for the request.
ChatCompletionTokenLogprob = object { token, bytes, logprob, top_logprobs }
token: string
The token.
bytes: array of number
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.
logprob: number
The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.
top_logprobs: array of object { token, bytes, logprob }
List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested top_logprobs returned.
token: string
The token.
bytes: array of number
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.
logprob: number
The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.
CompletionUsage = object { completion_tokens, prompt_tokens, total_tokens }
Usage statistics for the completion request.
completion_tokens: number
Number of tokens in the generated completion.
prompt_tokens: number
Number of tokens in the prompt.
total_tokens: number
Total number of tokens used in the request (prompt + completion).
DiskInfo = object { size, type }
size: optional object { amount, unit }
amount: optional number
The amount of space allocated to the disk.
unit: optional string
The unit of measure for the disk size.
type: optional "local" or "scratch"
The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
Droplet = object { id, backup_ids, created_at, 20 more }
id: number
A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.
backup_ids: array of number
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
A time value given in ISO8601 combined date and time format that represents when the Droplet was created.
disk: number
The size of the Droplet's disk in gigabytes.
features: array of string
An array of features enabled on this Droplet.
The Droplet's image.
Requires image:read scope.
locked: boolean
A boolean value indicating whether the Droplet has been locked, preventing actions by users.
memory: number
Memory of the Droplet in megabytes.
name: string
The human-readable name set for the Droplet instance.
networks: object { v4, v6 }
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.
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.
size_slug: string
The unique slug identifier for the size of this Droplet.
snapshot_ids: array of number
An array of snapshot IDs of any snapshots created from the Droplet instance.
Requires image:read scope.
status: "new" or "active" or "off" or "archive"
A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
tags: array of string
An array of Tags the Droplet has been tagged with.
Requires tag:read scope.
vcpus: number
The number of virtual CPUs.
volume_ids: array of string
A flat array including the unique identifier for each Block Storage volume attached to the Droplet.
Requires block_storage:read scope.
An array of objects containing information about the disks available to the Droplet.
An object containing information about the GPU capabilities of Droplets created with this size.
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.
vpc_uuid: optional string
A string specifying the UUID of the VPC to which the Droplet is assigned.
Requires vpc:read scope.
DropletNextBackupWindow = object { end, start }
end: optional string
A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window.
start: optional string
A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window.
FirewallRuleTarget = object { addresses, droplet_ids, kubernetes_ids, 2 more }
addresses: optional array of string
An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the firewall will allow traffic.
droplet_ids: optional array of number
An array containing the IDs of the Droplets to which the firewall will allow traffic.
kubernetes_ids: optional array of string
An array containing the IDs of the Kubernetes clusters to which the firewall will allow traffic.
load_balancer_uids: optional array of string
An array containing the IDs of the load balancers to which the firewall will allow traffic.
tags: optional array of string
A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request.
Requires tag:create and tag:read scopes.
ForwardLinks = object { last, next }
last: optional string
URI of the last page of the results.
next: optional string
URI of the next page of the results.
GarbageCollection = object { blobs_deleted, created_at, freed_bytes, 4 more }
blobs_deleted: optional number
The number of blobs deleted as a result of this garbage collection.
created_at: optional string
The time the garbage collection was created.
freed_bytes: optional number
The number of bytes freed as a result of this garbage collection.
registry_name: optional string
The name of the container registry.
status: optional "requested" or "waiting for write JWTs to expire" or "scanning manifests" or 5 more
The current status of this garbage collection.
updated_at: optional string
The time the garbage collection was last updated.
uuid: optional string
A string specifying the UUID of the garbage collection.
GPUInfo = object { count, model, vram }
An object containing information about the GPU capabilities of Droplets created with this size.
count: optional number
The number of GPUs allocated to the Droplet.
model: optional string
The model of the GPU.
vram: optional object { amount, unit }
amount: optional number
The amount of VRAM allocated to the GPU.
unit: optional string
The unit of measure for the VRAM.
Image = object { id, created_at, description, 11 more }
id: optional number
A unique number that can be used to identify and reference a specific image.
created_at: optional string
A time value given in ISO8601 combined date and time format that represents when the image was created.
description: optional string
An optional free-form text field to describe an image.
distribution: optional "Arch Linux" or "CentOS" or "CoreOS" or 10 more
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.
error_message: optional string
A string containing information about errors that may occur when importing a custom image.
min_disk_size: optional number
The minimum disk size in GB required for a Droplet to use this image.
name: optional string
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: optional boolean
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: optional array of "ams1" or "ams2" or "ams3" or 12 more
This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
size_gigabytes: optional number
The size of the image in gigabytes.
slug: optional string
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: optional "NEW" or "available" or "pending" or 2 more
A status string indicating the state of a custom image. This may be NEW,
available, pending, deleted, or retired.
tags: optional array of string
A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.
Requires tag:create scope.
type: optional "base" or "snapshot" or "backup" or 2 more
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).
Kernel = object { id, name, version }
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.
id: optional number
A unique number used to identify and reference a specific kernel.
name: optional string
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: optional string
A standard kernel version string representing the version, patch, and release information.
MetaProperties = object { total }
Information about the response itself.
total: optional number
Number of objects returned by the request.
NetworkV4 = object { gateway, ip_address, netmask, type }
gateway: optional string
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 string
The IP address of the IPv4 network interface.
netmask: optional string
The netmask of the IPv4 network interface.
type: optional "public" or "private"
The type of the IPv4 network interface.
NetworkV6 = object { gateway, ip_address, netmask, type }
gateway: optional string
The gateway of the specified IPv6 network interface.
ip_address: optional string
The IP address of the IPv6 network interface.
netmask: optional number
The netmask of the IPv6 network interface.
type: optional "public"
The type of the IPv6 network interface.
Note: IPv6 private networking is not currently supported.
PageLinks = object { pages }
Region = object { available, features, name, 2 more }
available: boolean
This is a boolean value that represents whether new Droplets can be created in this region.
features: array of string
This attribute is set to an array which contains features available in this region
name: string
The display name of the region. This will be a full name that is used in the control panel and other interfaces.
sizes: array of string
This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view.
slug: string
A human-readable string that is used as a unique identifier for each region.
Size = object { available, description, disk, 9 more }
available: boolean
This is a boolean value that represents whether new Droplets can be created with this size.
description: string
A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized.
disk: number
The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes.
memory: number
The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes.
price_hourly: number
This describes the price of the Droplet size as measured hourly. The value is measured in US dollars.
price_monthly: number
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: array of string
An array containing the region slugs where this size is available for Droplet creates. regions:read is required to view.
slug: string
A human-readable string that is used to uniquely identify each size.
transfer: number
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: number
The number of CPUs allocated to Droplets of this size.
An array of objects containing information about the disks available to Droplets created with this size.
An object containing information about the GPU capabilities of Droplets created with this size.
Snapshots = object { id, created_at, min_disk_size, 6 more }
id: string
The unique identifier for the snapshot.
created_at: string
A time value given in ISO8601 combined date and time format that represents when the snapshot was created.
min_disk_size: number
The minimum size in GB required for a volume or Droplet to use this snapshot.
name: string
A human-readable name for the snapshot.
regions: array of string
An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values.
resource_id: string
The unique identifier for the resource that the snapshot originated from.
resource_type: "droplet" or "volume"
The type of resource that the snapshot originated from.
size_gigabytes: number
The billable size of the snapshot in gigabytes.
tags: array of string
An array of Tags the snapshot has been tagged with.
Requires tag:read scope.
Subscription = object { created_at, tier, updated_at }
created_at: optional string
The time at which the subscription was created.
updated_at: optional string
The time at which the subscription was last updated.
SubscriptionTierBase = object { allow_storage_overage, included_bandwidth_bytes, included_repositories, 5 more }
allow_storage_overage: optional boolean
A boolean indicating whether the subscription tier supports additional storage above what is included in the base plan at an additional cost per GiB used.
included_bandwidth_bytes: optional number
The amount of outbound data transfer included in the subscription tier in bytes.
included_repositories: optional number
The number of repositories included in the subscription tier. 0 indicates that the subscription tier includes unlimited repositories.
included_storage_bytes: optional number
The amount of storage included in the subscription tier in bytes.
monthly_price_in_cents: optional number
The monthly cost of the subscription tier in cents.
name: optional string
The name of the subscription tier.
slug: optional string
The slug identifier of the subscription tier.
storage_overage_price_in_cents: optional number
The price paid in cents per GiB for additional storage beyond what is included in the subscription plan.
VpcPeering = object { id, created_at, name, 2 more }
id: optional string
A unique ID that can be used to identify and reference the VPC peering.
created_at: optional string
A time value given in ISO8601 combined date and time format.
name: optional string
The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
status: optional "PROVISIONING" or "ACTIVE" or "DELETING"
The current status of the VPC peering.
vpc_ids: optional array of string
An array of the two peered VPCs IDs.