Shared
ModelsExpand Collapse
type Action struct{…}
A unique numeric ID that can be used to identify and reference an action.
A time value given in ISO8601 combined date and time format that represents when the action was completed.
This is a boolean value that represents whether new Droplets can be created in this region.
This attribute is set to an array which contains features available in this region
The display name of the region. This will be a full name that is used in the control panel and other interfaces.
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.
A human-readable string that is used as a unique identifier for each region.
A human-readable string that is used as a unique identifier for each region.
A unique identifier for the resource that the action is associated with.
The type of resource that the action is associated with.
A time value given in ISO8601 combined date and time format that represents when the action was initiated.
Status ActionStatusoptionalThe current status of the action. This can be "in-progress", "completed", or "errored".
The current status of the action. This can be "in-progress", "completed", or "errored".
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.
type ActionLink struct{…}The linked actions can be used to check the status of a Droplet's create event.
The linked actions can be used to check the status of a Droplet's create event.
A unique numeric ID that can be used to identify and reference an action.
A URL that can be used to access the action.
A string specifying the type of the related action.
type APILinks struct{…}Links to other pages
Links to other pages
Pages APILinksPagesoptionalInformation about how to reach other pages
Information about how to reach other pages
First page
Last page
Next page
Previous page
type APIMeta struct{…}Meta information about the data set
Meta information about the data set
The current page
Total number of pages
Total amount of items over all pages
type BackwardLinks struct{…}
URI of the first page of the results.
URI of the previous page of the results.
type ChatCompletionChunk struct{…}Represents a streamed chunk of a chat completion response returned
by the model, based on the provided input.
Represents a streamed chunk of a chat completion response returned by the model, based on the provided input.
A unique identifier for the chat completion. Each chunk has the same ID.
Choices []ChatCompletionChunkChoiceA 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}.
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 ChatCompletionChunkChoicesDeltaA chat completion delta generated by streamed model responses.
A chat completion delta generated by streamed model responses.
The contents of the chunk message.
The reasoning content generated by the model.
The refusal message generated by the model.
Role ChatCompletionChunkChoicesDeltaRoleoptionalThe role of the author of this message.
The role of the author of this message.
ToolCalls []ChatCompletionChunkChoicesDeltaToolCalloptional
The ID of the tool call.
Function ChatCompletionChunkChoicesDeltaToolCallsFunctionoptionalA chunk of a function that the model called.
A chunk of a function that the model called.
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.
The name of the function to call.
Type ChatCompletionChunkChoicesDeltaToolCallsTypeoptionalThe type of the tool. Currently, only function is supported.
The type of the tool. Currently, only function is supported.
FinishReason ChatCompletionChunkChoicesFinishReasonThe 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.
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.
The index of the choice in the list of choices.
Logprobs ChatCompletionChunkChoicesLogprobsoptionalLog probability information for the choice.
Log probability information for the choice.
Content []ChatCompletionTokenLogprobA list of message content tokens with log probability information.
A list of message content tokens with log probability information.
The token.
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.
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.
TopLogprobs []ChatCompletionTokenLogprobTopLogprobList 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.
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.
The token.
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.
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.
Refusal []ChatCompletionTokenLogprobA list of message refusal tokens with log probability information.
A list of message refusal tokens with log probability information.
The token.
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.
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.
TopLogprobs []ChatCompletionTokenLogprobTopLogprobList 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.
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.
The token.
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.
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.
The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.
The model to generate the completion.
Object ChatCompletionChunkObjectThe object type, which is always 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.
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.
Number of prompt tokens written to cache.
CacheCreation CompletionUsageCacheCreationBreakdown of prompt tokens written to cache.
Breakdown of prompt tokens written to cache.
Number of prompt tokens written to 1h cache.
Number of prompt tokens written to 5m cache.
Number of prompt tokens read from cache.
Number of tokens in the generated completion.
Number of tokens in the prompt.
Total number of tokens used in the request (prompt + completion).
type ChatCompletionTokenLogprob struct{…}
The token.
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.
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.
TopLogprobs []ChatCompletionTokenLogprobTopLogprobList 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.
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.
The token.
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.
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.
type CompletionUsage struct{…}Usage statistics for the completion request.
Usage statistics for the completion request.
Number of prompt tokens written to cache.
CacheCreation CompletionUsageCacheCreationBreakdown of prompt tokens written to cache.
Breakdown of prompt tokens written to cache.
Number of prompt tokens written to 1h cache.
Number of prompt tokens written to 5m cache.
Number of prompt tokens read from cache.
Number of tokens in the generated completion.
Number of tokens in the prompt.
Total number of tokens used in the request (prompt + completion).
type CreateResponseResponse struct{…}Represents a text-to-text response returned by the model, based on the provided input. VLLM models only.
Represents a text-to-text response returned by the model, based on the provided input. VLLM models only.
A unique identifier for the response.
The Unix timestamp (in seconds) of when the response was created.
The model used to generate the response.
Object CreateResponseResponseObjectThe object type, which is always response.
The object type, which is always response.
Usage CreateResponseResponseUsageDetailed token usage statistics for the request, including input/output token counts and detailed breakdowns.
Detailed token usage statistics for the request, including input/output token counts and detailed breakdowns.
The number of input tokens.
InputTokensDetails CreateResponseResponseUsageInputTokensDetailsA detailed breakdown of the input tokens.
A detailed breakdown of the input tokens.
The number of tokens that were retrieved from the cache. More on prompt caching.
The number of output tokens.
OutputTokensDetails CreateResponseResponseUsageOutputTokensDetailsA detailed breakdown of the output tokens.
A detailed breakdown of the output tokens.
The number of reasoning tokens.
The number of tool output tokens.
The total number of tokens used.
Whether the request was processed in the background
Choices []CreateResponseResponseChoiceoptionalA list of response choices. Can be more than one if n is greater than 1. Optional - Responses API primarily uses the output array.
A list of response choices. Can be more than one if n is greater than 1. Optional - Responses API primarily uses the output array.
FinishReason CreateResponseResponseChoicesFinishReasonThe reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, or tool_calls if the model called a tool.
The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, or tool_calls if the model called a tool.
The index of the choice in the list of choices.
Message CreateResponseResponseChoicesMessageThe generated message response.
The generated message response.
The generated text content.
Role CreateResponseResponseChoicesMessageRoleoptionalThe role of the message author, which is always assistant.
The role of the message author, which is always assistant.
ToolCalls []CreateResponseResponseChoicesMessageToolCalloptionalThe tool calls generated by the model, such as function calls.
The tool calls generated by the model, such as function calls.
The ID of the tool call.
Function CreateResponseResponseChoicesMessageToolCallsFunctionThe function that the model called.
The function that the model called.
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.
The name of the function to call.
Type CreateResponseResponseChoicesMessageToolCallsTypeThe type of the tool. Currently, only function is supported.
The type of the tool. Currently, only function is supported.
Logprobs CreateResponseResponseChoicesLogprobsoptionalLog probability information for the choice. Only present if logprobs was requested in the request.
Log probability information for the choice. Only present if logprobs was requested in the request.
Content []ChatCompletionTokenLogprobA list of message content tokens with log probability information.
A list of message content tokens with log probability information.
The token.
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.
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.
TopLogprobs []ChatCompletionTokenLogprobTopLogprobList 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.
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.
The token.
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.
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.
Input messages (if applicable)
Maximum output tokens setting
Maximum tool calls setting
Output []CreateResponseResponseOutputoptionalAn array of content items generated by the model. This includes text content, function calls, reasoning items, and other output types. Use this field for Responses API compatibility.
An array of content items generated by the model. This includes text content, function calls, reasoning items, and other output types. Use this field for Responses API compatibility.
type CreateResponseResponseOutputObject struct{…}
JSON string of function arguments
The unique ID of the function tool call
The name of the function to call
Type CreateResponseResponseOutputObjectTypeThe type of output item
The type of output item
The unique ID of the function tool call (same as call_id)
Encrypted content (optional)
Status of the item (optional, can be null)
type CreateResponseResponseOutputObject struct{…}
The text content
Type CreateResponseResponseOutputObjectTypeThe type of output item
The type of output item
type CreateResponseResponseOutputObject struct{…}
The unique ID of the reasoning item
Content []CreateResponseResponseOutputObjectContentArray of reasoning content parts
Array of reasoning content parts
The reasoning text content
Type CreateResponseResponseOutputObjectContentTypeThe type of content
The type of content
Summary of the reasoning (usually empty)
Type CreateResponseResponseOutputObjectTypeThe type of output item
The type of output item
Encrypted content (optional)
Status of the item (optional, can be null)
Output messages (if applicable)
Whether parallel tool calls are enabled
Previous response ID (for multi-turn conversations)
Prompt used for the response
Reasoning content
Service tier used
Status of the response
Temperature setting used for the response
Text content
Tool choice setting used for the response
Tools []CreateResponseResponseTooloptionalTools available for the response
Tools available for the response
Type CreateResponseResponseToolsTypeThe type of the tool. Supported values are function (custom tools), web_search, and web_search_2025_08_26 (built-in web search).
The type of the tool. Supported values are function (custom tools), web_search, and web_search_2025_08_26 (built-in web search).
A description of what the function does, used by the model to choose when and how to call the function.
The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.
Omitting parameters defines a function with an empty parameter list.
Top logprobs setting
Top-p setting used for the response
Truncation setting
User identifier
type CreateResponseStreamResponse struct{…}Represents a streamed chunk of a text-to-text response returned by the model, based on the provided input. VLLM models only.
Represents a streamed chunk of a text-to-text response returned by the model, based on the provided input. VLLM models only.
A unique identifier for the response. Each chunk has the same ID.
Choices []CreateResponseStreamResponseChoiceA list of response choice chunks. Can contain more than one element if n is greater than 1. Can also be empty for the last chunk if you set stream_options: {"include_usage": true}.
A list of response choice chunks. Can contain more than one element if n is greater than 1. Can also be empty for the last chunk if you set stream_options: {"include_usage": true}.
Delta CreateResponseStreamResponseChoicesDeltaA chunk of the response message generated by the model.
A chunk of the response message generated by the model.
The contents of the chunk message. Can be null for chunks with tool calls or other non-text content.
The reasoning content generated by the model. Only present when the model generates reasoning text.
Role CreateResponseStreamResponseChoicesDeltaRoleoptionalThe role of the message author. Only present in the first chunk.
The role of the message author. Only present in the first chunk.
ToolCalls []CreateResponseStreamResponseChoicesDeltaToolCalloptionalThe tool calls generated by the model, such as function calls. Only present when the model decides to call a tool.
The tool calls generated by the model, such as function calls. Only present when the model decides to call a tool.
The ID of the tool call.
Function CreateResponseStreamResponseChoicesDeltaToolCallsFunctionThe function that the model called.
The function that the model called.
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.
The name of the function to call.
Type CreateResponseStreamResponseChoicesDeltaToolCallsTypeThe type of the tool. Currently, only function is supported.
The type of the tool. Currently, only function is supported.
The index of the choice in the list of choices.
FinishReason CreateResponseStreamResponseChoicesFinishReasonoptionalThe reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, or tool_calls if the model called a tool. Only present in the final chunk.
The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, or tool_calls if the model called a tool. Only present in the final chunk.
Logprobs CreateResponseStreamResponseChoicesLogprobsoptionalLog probability information for the choice. Only present if logprobs was requested in the request.
Log probability information for the choice. Only present if logprobs was requested in the request.
Content []ChatCompletionTokenLogprobA list of message content tokens with log probability information.
A list of message content tokens with log probability information.
The token.
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.
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.
TopLogprobs []ChatCompletionTokenLogprobTopLogprobList 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.
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.
The token.
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.
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.
The Unix timestamp (in seconds) of when the response was created. Each chunk has the same timestamp.
The model used to generate the response.
Object CreateResponseStreamResponseObjectThe object type, which is always response.chunk.
The object type, which is always response.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.
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.
Number of prompt tokens written to cache.
CacheCreation CompletionUsageCacheCreationBreakdown of prompt tokens written to cache.
Breakdown of prompt tokens written to cache.
Number of prompt tokens written to 1h cache.
Number of prompt tokens written to 5m cache.
Number of prompt tokens read from cache.
Number of tokens in the generated completion.
Number of tokens in the prompt.
Total number of tokens used in the request (prompt + completion).
type DiskInfo struct{…}
Size DiskInfoSizeoptional
The amount of space allocated to the disk.
The unit of measure for the disk size.
Type DiskInfoTypeoptionalThe type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
type Droplet struct{…}
A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.
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.
A time value given in ISO8601 combined date and time format that represents when the Droplet was created.
The size of the Droplet's disk in gigabytes.
An array of features enabled on this Droplet.
Image ImageThe Droplet's image.
Requires image:read scope.
The Droplet's image.
Requires image:read scope.
A unique number that can be used to identify and reference a specific image.
A time value given in ISO8601 combined date and time format that represents when the image was created.
An optional free-form text field to describe an image.
Distribution ImageDistributionoptionalThe 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.
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.
A string containing information about errors that may occur when importing a custom image.
The minimum disk size in GB required for a Droplet to use this image.
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.
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 []ImageRegionoptionalThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
The size of the image in gigabytes.
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 ImageStatusoptionalA status string indicating the state of a custom image. This may be NEW,
available, pending, deleted, or retired.
A status string indicating the state of a custom image. This may be NEW,
available, pending, deleted, or retired.
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 ImageTypeoptionalDescribes 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).
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).
A boolean value indicating whether the Droplet has been locked, preventing actions by users.
Memory of the Droplet in megabytes.
The human-readable name set for the Droplet instance.
Networks DropletNetworksThe 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 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 gateway of the specified IPv4 network interface.
For private interfaces, a gateway is not provided. This is denoted by
returning nil as its value.
The IP address of the IPv4 network interface.
The netmask of the IPv4 network interface.
Type NetworkV4TypeoptionalThe type of the IPv4 network interface.
The type of the IPv4 network interface.
The gateway of the specified IPv6 network interface.
The IP address of the IPv6 network interface.
The netmask of the IPv6 network interface.
Type NetworkV6TypeoptionalThe type of the IPv6 network interface.
Note: IPv6 private networking is not currently supported.
The type of the IPv6 network interface.
Note: IPv6 private networking is not currently supported.
NextBackupWindow DropletNextBackupWindowThe 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.
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.
A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window.
A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window.
Region Region
This is a boolean value that represents whether new Droplets can be created in this region.
This attribute is set to an array which contains features available in this region
The display name of the region. This will be a full name that is used in the control panel and other interfaces.
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.
A human-readable string that is used as a unique identifier for each region.
Size Size
This is a boolean value that represents whether new Droplets can be created with this size.
A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized.
The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes.
The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes.
This describes the price of the Droplet size as measured hourly. The value is measured in US dollars.
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.
An array containing the region slugs where this size is available for Droplet creates.
A human-readable string that is used to uniquely identify each size.
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.
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 array of objects containing information about the disks available to Droplets created with this size.
Size DiskInfoSizeoptional
The amount of space allocated to the disk.
The unit of measure for the disk size.
Type DiskInfoTypeoptionalThe type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
An object containing information about the GPU capabilities of Droplets created with this size.
An object containing information about the GPU capabilities of Droplets created with this size.
The number of GPUs allocated to the Droplet.
The model of the GPU.
Vram GPUInfoVramoptional
The amount of VRAM allocated to the GPU.
The unit of measure for the VRAM.
The unique slug identifier for the size of this Droplet.
An array of snapshot IDs of any snapshots created from the Droplet instance.
Requires image:read scope.
Status DropletStatusA status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
An array of Tags the Droplet has been tagged with.
Requires tag:read scope.
The number of virtual CPUs.
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 array of objects containing information about the disks available to the Droplet.
Size DiskInfoSizeoptional
The amount of space allocated to the disk.
The unit of measure for the disk size.
Type DiskInfoTypeoptionalThe type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
An object containing information about the GPU capabilities of Droplets created with this size.
An object containing information about the GPU capabilities of Droplets created with this size.
The number of GPUs allocated to the Droplet.
The model of the GPU.
Vram GPUInfoVramoptional
The amount of VRAM allocated to the GPU.
The unit of measure for the VRAM.
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.
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.
A unique number used to identify and reference a specific kernel.
The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question.
A standard kernel version string representing the version, patch, and release information.
A string specifying the UUID of the VPC to which the Droplet is assigned.
Requires vpc:read scope.
type DropletNextBackupWindow struct{…}
A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window.
A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window.
type FirewallRuleTarget struct{…}
An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the firewall will allow traffic.
An array containing the IDs of the Droplets to which the firewall will allow traffic.
An array containing the IDs of the Kubernetes clusters to which the firewall will allow traffic.
An array containing the IDs of the load balancers to which the firewall will allow traffic.
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.
type ForwardLinks struct{…}
URI of the last page of the results.
URI of the next page of the results.
type GarbageCollection struct{…}
The number of blobs deleted as a result of this garbage collection.
The time the garbage collection was created.
The number of bytes freed as a result of this garbage collection.
The name of the container registry.
Status GarbageCollectionStatusoptionalThe current status of this garbage collection.
The current status of this garbage collection.
The time the garbage collection was last updated.
A string specifying the UUID of the garbage collection.
type GPUInfo struct{…}An object containing information about the GPU capabilities of Droplets created with this size.
An object containing information about the GPU capabilities of Droplets created with this size.
The number of GPUs allocated to the Droplet.
The model of the GPU.
Vram GPUInfoVramoptional
The amount of VRAM allocated to the GPU.
The unit of measure for the VRAM.
type Image struct{…}
A unique number that can be used to identify and reference a specific image.
A time value given in ISO8601 combined date and time format that represents when the image was created.
An optional free-form text field to describe an image.
Distribution ImageDistributionoptionalThe 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.
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.
A string containing information about errors that may occur when importing a custom image.
The minimum disk size in GB required for a Droplet to use this image.
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.
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 []ImageRegionoptionalThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
The size of the image in gigabytes.
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 ImageStatusoptionalA status string indicating the state of a custom image. This may be NEW,
available, pending, deleted, or retired.
A status string indicating the state of a custom image. This may be NEW,
available, pending, deleted, or retired.
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 ImageTypeoptionalDescribes 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).
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).
type ImageGenCompletedEvent struct{…}Emitted when image generation has completed and the final image is available.
Emitted when image generation has completed and the final image is available.
Base64-encoded image data, suitable for rendering as an image.
Background ImageGenCompletedEventBackgroundThe background setting for the generated image.
The background setting for the generated image.
The Unix timestamp when the event was created.
OutputFormat ImageGenCompletedEventOutputFormatThe output format for the generated image.
The output format for the generated image.
Quality ImageGenCompletedEventQualityThe quality setting for the generated image.
The quality setting for the generated image.
Size ImageGenCompletedEventSizeThe size of the generated image.
The size of the generated image.
Type ImageGenCompletedEventTypeThe type of the event. Always image_generation.completed.
The type of the event. Always image_generation.completed.
Usage ImageGenCompletedEventUsageFor gpt-image-1 only, the token usage information for the image generation.
For gpt-image-1 only, the token usage information for the image generation.
The number of tokens (images and text) in the input prompt.
InputTokensDetails ImageGenCompletedEventUsageInputTokensDetailsThe input tokens detailed information for the image generation.
The input tokens detailed information for the image generation.
The number of image tokens in the input prompt.
The number of text tokens in the input prompt.
The number of image tokens in the output image.
The total number of tokens (images and text) used for the image generation.
type ImageGenPartialImageEvent struct{…}Emitted when a partial image is available during image generation streaming.
Emitted when a partial image is available during image generation streaming.
Base64-encoded partial image data, suitable for rendering as an image.
Background ImageGenPartialImageEventBackgroundThe background setting for the requested image.
The background setting for the requested image.
The Unix timestamp when the event was created.
OutputFormat ImageGenPartialImageEventOutputFormatThe output format for the requested image.
The output format for the requested image.
0-based index for the partial image (streaming).
Quality ImageGenPartialImageEventQualityThe quality setting for the requested image.
The quality setting for the requested image.
Size ImageGenPartialImageEventSizeThe size of the requested image.
The size of the requested image.
Type ImageGenPartialImageEventTypeThe type of the event. Always image_generation.partial_image.
The type of the event. Always image_generation.partial_image.
type ImageGenStreamEvent interface{…}Emitted when a partial image is available during image generation streaming.
Emitted when a partial image is available during image generation streaming.
type ImageGenPartialImageEvent struct{…}Emitted when a partial image is available during image generation streaming.
Emitted when a partial image is available during image generation streaming.
Base64-encoded partial image data, suitable for rendering as an image.
Background ImageGenPartialImageEventBackgroundThe background setting for the requested image.
The background setting for the requested image.
The Unix timestamp when the event was created.
OutputFormat ImageGenPartialImageEventOutputFormatThe output format for the requested image.
The output format for the requested image.
0-based index for the partial image (streaming).
Quality ImageGenPartialImageEventQualityThe quality setting for the requested image.
The quality setting for the requested image.
Size ImageGenPartialImageEventSizeThe size of the requested image.
The size of the requested image.
Type ImageGenPartialImageEventTypeThe type of the event. Always image_generation.partial_image.
The type of the event. Always image_generation.partial_image.
type ImageGenCompletedEvent struct{…}Emitted when image generation has completed and the final image is available.
Emitted when image generation has completed and the final image is available.
Base64-encoded image data, suitable for rendering as an image.
Background ImageGenCompletedEventBackgroundThe background setting for the generated image.
The background setting for the generated image.
The Unix timestamp when the event was created.
OutputFormat ImageGenCompletedEventOutputFormatThe output format for the generated image.
The output format for the generated image.
Quality ImageGenCompletedEventQualityThe quality setting for the generated image.
The quality setting for the generated image.
Size ImageGenCompletedEventSizeThe size of the generated image.
The size of the generated image.
Type ImageGenCompletedEventTypeThe type of the event. Always image_generation.completed.
The type of the event. Always image_generation.completed.
Usage ImageGenCompletedEventUsageFor gpt-image-1 only, the token usage information for the image generation.
For gpt-image-1 only, the token usage information for the image generation.
The number of tokens (images and text) in the input prompt.
InputTokensDetails ImageGenCompletedEventUsageInputTokensDetailsThe input tokens detailed information for the image generation.
The input tokens detailed information for the image generation.
The number of image tokens in the input prompt.
The number of text tokens in the input prompt.
The number of image tokens in the output image.
The total number of tokens (images and text) used for the image generation.
type Kernel struct{…}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.
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.
A unique number used to identify and reference a specific kernel.
The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question.
A standard kernel version string representing the version, patch, and release information.
type MetaProperties struct{…}Information about the response itself.
Information about the response itself.
Number of objects returned by the request.
type NetworkV4 struct{…}
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.
The IP address of the IPv4 network interface.
The netmask of the IPv4 network interface.
Type NetworkV4TypeoptionalThe type of the IPv4 network interface.
The type of the IPv4 network interface.
type NetworkV6 struct{…}
The gateway of the specified IPv6 network interface.
The IP address of the IPv6 network interface.
The netmask of the IPv6 network interface.
Type NetworkV6TypeoptionalThe type of the IPv6 network interface.
Note: IPv6 private networking is not currently supported.
The type of the IPv6 network interface.
Note: IPv6 private networking is not currently supported.
type PageLinks struct{…}
Pages PageLinksPagesoptional
type ForwardLinks struct{…}
URI of the last page of the results.
URI of the next page of the results.
type BackwardLinks struct{…}
URI of the first page of the results.
URI of the previous page of the results.
type Region struct{…}
This is a boolean value that represents whether new Droplets can be created in this region.
This attribute is set to an array which contains features available in this region
The display name of the region. This will be a full name that is used in the control panel and other interfaces.
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.
A human-readable string that is used as a unique identifier for each region.
type Size struct{…}
This is a boolean value that represents whether new Droplets can be created with this size.
A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized.
The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes.
The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes.
This describes the price of the Droplet size as measured hourly. The value is measured in US dollars.
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.
An array containing the region slugs where this size is available for Droplet creates.
A human-readable string that is used to uniquely identify each size.
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.
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 array of objects containing information about the disks available to Droplets created with this size.
Size DiskInfoSizeoptional
The amount of space allocated to the disk.
The unit of measure for the disk size.
Type DiskInfoTypeoptionalThe type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
An object containing information about the GPU capabilities of Droplets created with this size.
An object containing information about the GPU capabilities of Droplets created with this size.
The number of GPUs allocated to the Droplet.
The model of the GPU.
Vram GPUInfoVramoptional
The amount of VRAM allocated to the GPU.
The unit of measure for the VRAM.
type Snapshots struct{…}
The unique identifier for the snapshot.
A time value given in ISO8601 combined date and time format that represents when the snapshot was created.
The minimum size in GB required for a volume or Droplet to use this snapshot.
A human-readable name for the snapshot.
An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values.
The unique identifier for the resource that the snapshot originated from.
ResourceType SnapshotsResourceTypeThe type of resource that the snapshot originated from.
The type of resource that the snapshot originated from.
The billable size of the snapshot in gigabytes.
An array of Tags the snapshot has been tagged with.
Requires tag:read scope.
type Subscription struct{…}
The time at which the subscription was created.
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.
The amount of outbound data transfer included in the subscription tier in bytes.
The number of repositories included in the subscription tier. 0 indicates that the subscription tier includes unlimited repositories.
The amount of storage included in the subscription tier in bytes.
The monthly cost of the subscription tier in cents.
The name of the subscription tier.
The slug identifier of the subscription tier.
The price paid in cents per GiB for additional storage beyond what is included in the subscription plan.
The time at which the subscription was last updated.
type SubscriptionTierBase struct{…}
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.
The amount of outbound data transfer included in the subscription tier in bytes.
The number of repositories included in the subscription tier. 0 indicates that the subscription tier includes unlimited repositories.
The amount of storage included in the subscription tier in bytes.
The monthly cost of the subscription tier in cents.
The name of the subscription tier.
The slug identifier of the subscription tier.
The price paid in cents per GiB for additional storage beyond what is included in the subscription plan.
type VpcPeering struct{…}
A unique ID that can be used to identify and reference the VPC peering.
A time value given in ISO8601 combined date and time format.
The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
Status VpcPeeringStatusoptionalThe current status of the VPC peering.
The current status of the VPC peering.
An array of the two peered VPCs IDs.