Expand description
§rsdo - DigitalOcean Rust Client
A Rust client library for the DigitalOcean API, generated from the official OpenAPI specification.
§Quick Start
use rsdo::Client;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
// Create a client with your DigitalOcean personal access token
let client = Client::from_token("your-digitalocean-token");
// List your droplets (with required parameters)
let droplets = client.droplets_list(None, None, None, None, None).await?;
println!("Found {} droplets", droplets.into_inner().droplets.len());
Ok(())
}§Authentication
This client uses DigitalOcean’s Personal Access Token (PAT) for authentication. You can create a token in the DigitalOcean Control Panel.
§Features
- Async/await support with reqwest and tokio
- Strongly typed API responses
- Generated from the official DigitalOcean OpenAPI specification
- Automatic serialization/deserialization with serde
- Comprehensive error handling
Modules§
- defaults
- Generation of default values for serde.
- error
- Error types.
- prelude
- Items consumers will typically use such as the Client.
- types
- Types used as operation parameters and responses.
Structs§
- ACriterion
ForRouting Http Traffic ToAComponent ACriterionForRoutingHttpTrafficToAComponent- AList
OfApps Item - An application’s configuration and status.
- AList
OfApps Item Pending Deployment AListOfAppsItemPendingDeployment- AList
OfApps Item Pending Deployment Progress AListOfAppsItemPendingDeploymentProgress- AList
OfApps Item Pinned Deployment AListOfAppsItemPinnedDeployment- AList
OfApps Item Pinned Deployment Progress AListOfAppsItemPinnedDeploymentProgress- AList
OfApps Item Vpc AListOfAppsItemVpc- AList
OfEvents Item AListOfEventsItem- AList
OfEvents Item Autoscaling - Autoscaling event details. Only present for autoscaling events.
- AList
OfEvents Item Autoscaling Components Value AListOfEventsItemAutoscalingComponentsValue- AList
OfJob Invocations Item AListOfJobInvocationsItem- AStep
That IsRun AsPart OfThe Deployments Lifecycle AStepThatIsRunAsPartOfTheDeploymentsLifecycle- AStep
That IsRun AsPart OfThe Deployments Lifecycle Reason AStepThatIsRunAsPartOfTheDeploymentsLifecycleReason- Account
GetResponse AccountGetResponse- Account
GetResponse Account AccountGetResponseAccount- Account
GetResponse Account Team - When authorized in a team context, includes information about the current team.
- Actions
GetResponse ActionsGetResponse- Actions
GetResponse Action ActionsGetResponseAction- Actions
GetResponse Action Region ActionsGetResponseActionRegion- Actions
List Response ActionsListResponse- Actions
List Response Actions Item ActionsListResponseActionsItem- Actions
List Response Actions Item Region ActionsListResponseActionsItemRegion- Actions
List Response Links ActionsListResponseLinks- Actions
List Response Links Pages ActionsListResponseLinksPages- Actions
List Response Links Pages Subtype0 ActionsListResponseLinksPagesSubtype0- Actions
List Response Links Pages Subtype1 ActionsListResponseLinksPagesSubtype1- Actions
List Response Meta ActionsListResponseMeta- Addons
Create Body AddonsCreateBody- Addons
Create Response AddonsCreateResponse- Addons
Create Response Resource AddonsCreateResponseResource- Addons
GetApp Metadata Response AddonsGetAppMetadataResponse- Addons
GetApp Metadata Response Metadata Item AddonsGetAppMetadataResponseMetadataItem- Addons
GetApp Response AddonsGetAppResponse- Addons
GetApp Response Apps Item AddonsGetAppResponseAppsItem- Addons
GetResponse AddonsGetResponse- Addons
GetResponse Resource AddonsGetResponseResource- Addons
List Response AddonsListResponse- Addons
List Response Resources Item AddonsListResponseResourcesItem- Addons
Patch Body AddonsPatchBody- Addons
Patch Plan Body AddonsPatchPlanBody- Addons
Patch Plan Response AddonsPatchPlanResponse- Addons
Patch Plan Response Resource AddonsPatchPlanResponseResource- Addons
Patch Response AddonsPatchResponse- Addons
Patch Response Resource AddonsPatchResponseResource- Agent
Inference Create Chat Completion Body AgentInferenceCreateChatCompletionBody- Agent
Inference Create Chat Completion Body Messages Item - A message in the chat conversation.
- Agent
Inference Create Chat Completion Body Messages Item Tool Calls Item AgentInferenceCreateChatCompletionBodyMessagesItemToolCallsItem- Agent
Inference Create Chat Completion Body Messages Item Tool Calls Item Function AgentInferenceCreateChatCompletionBodyMessagesItemToolCallsItemFunction- Agent
Inference Create Chat Completion Body Stream Options - Options for streaming response. Only set this when you set stream to true.
- Agent
Inference Create Chat Completion Body Tool Choice Variant1 Function AgentInferenceCreateChatCompletionBodyToolChoiceVariant1Function- Agent
Inference Create Chat Completion Body Tools Item AgentInferenceCreateChatCompletionBodyToolsItem- Agent
Inference Create Chat Completion Body Tools Item Function AgentInferenceCreateChatCompletionBodyToolsItemFunction- Agent
Inference Create Chat Completion Response - Represents a chat completion response returned by model, based on the provided input.
- Agent
Inference Create Chat Completion Response Choices Item AgentInferenceCreateChatCompletionResponseChoicesItem- Agent
Inference Create Chat Completion Response Choices Item Logprobs - Log probability information for the choice.
- Agent
Inference Create Chat Completion Response Choices Item Logprobs Content Item AgentInferenceCreateChatCompletionResponseChoicesItemLogprobsContentItem- Agent
Inference Create Chat Completion Response Choices Item Logprobs Content Item TopLogprobs Item AgentInferenceCreateChatCompletionResponseChoicesItemLogprobsContentItemTopLogprobsItem- Agent
Inference Create Chat Completion Response Choices Item Logprobs Refusal Item AgentInferenceCreateChatCompletionResponseChoicesItemLogprobsRefusalItem- Agent
Inference Create Chat Completion Response Choices Item Logprobs Refusal Item TopLogprobs Item AgentInferenceCreateChatCompletionResponseChoicesItemLogprobsRefusalItemTopLogprobsItem- Agent
Inference Create Chat Completion Response Choices Item Message - A chat completion message generated by the model.
- Agent
Inference Create Chat Completion Response Choices Item Message Tool Calls Item AgentInferenceCreateChatCompletionResponseChoicesItemMessageToolCallsItem- Agent
Inference Create Chat Completion Response Choices Item Message Tool Calls Item Function AgentInferenceCreateChatCompletionResponseChoicesItemMessageToolCallsItemFunction- Agent
Inference Create Chat Completion Response Usage - Usage statistics for the completion request.
- Agent
Inference Create Chat Completion Response Usage Cache Creation - Breakdown of prompt tokens written to cache.
- AnApp
Deployment AnAppDeployment- AnApp
Deployment Progress AnAppDeploymentProgress- AppSpec
- The desired configuration of an application.
- AppSpec
Databases Item AppSpecDatabasesItem- AppSpec
Databases Item Name - The database’s name. The name must be unique across all components within the same app and cannot use capital letters.
- AppSpec
Domains Item AppSpecDomainsItem- AppSpec
Domains Item Domain - The hostname for the domain
- AppSpec
Egress - Specification for app egress configurations.
- AppSpec
Functions Item AppSpecFunctionsItem- AppSpec
Functions Item Alerts Item AppSpecFunctionsItemAlertsItem- AppSpec
Functions Item Bitbucket AppSpecFunctionsItemBitbucket- AppSpec
Functions Item Cors AppSpecFunctionsItemCors- AppSpec
Functions Item Cors Allow Origins Item AppSpecFunctionsItemCorsAllowOriginsItem- AppSpec
Functions Item Cors Allow Origins Item Exact - Exact string match. Only 1 of
exact,prefix, orregexmust be set. An empty string is a valid value and will be serialized explicitly rather than being omitted from the payload. - AppSpec
Functions Item Cors Allow Origins Item Prefix - Prefix-based match. Only 1 of
exact,prefix, orregexmust be set. - AppSpec
Functions Item Cors Allow Origins Item Regex - RE2 style regex-based match. Only 1 of
exact,prefix, orregexmust be set. For more information about RE2 syntax, see: https://github.com/google/re2/wiki/Syntax - AppSpec
Functions Item Envs Item AppSpecFunctionsItemEnvsItem- AppSpec
Functions Item Envs Item Key - The variable name
- AppSpec
Functions Item Git AppSpecFunctionsItemGit- AppSpec
Functions Item Github AppSpecFunctionsItemGithub- AppSpec
Functions Item Gitlab AppSpecFunctionsItemGitlab- AppSpec
Functions Item Name - The name. Must be unique across all components within the same app.
- AppSpec
Ingress - Specification for app ingress configurations.
- AppSpec
Ingress Rules Item AppSpecIngressRulesItem- AppSpec
Ingress Rules Item Component - The component to route to. Only one of
componentorredirectmay be set. - AppSpec
Ingress Rules Item Cors AppSpecIngressRulesItemCors- AppSpec
Ingress Rules Item Cors Allow Origins Item AppSpecIngressRulesItemCorsAllowOriginsItem- AppSpec
Ingress Rules Item Cors Allow Origins Item Exact - Exact string match. Only 1 of
exact,prefix, orregexmust be set. An empty string is a valid value and will be serialized explicitly rather than being omitted from the payload. - AppSpec
Ingress Rules Item Cors Allow Origins Item Prefix - Prefix-based match. Only 1 of
exact,prefix, orregexmust be set. - AppSpec
Ingress Rules Item Cors Allow Origins Item Regex - RE2 style regex-based match. Only 1 of
exact,prefix, orregexmust be set. For more information about RE2 syntax, see: https://github.com/google/re2/wiki/Syntax - AppSpec
Ingress Rules Item Match - The match configuration for the rule.
- AppSpec
Ingress Rules Item Match Authority - The authority to match on.
- AppSpec
Ingress Rules Item Match Authority Exact - Exact string match. An empty string is a valid value and will be serialized explicitly rather than being omitted from the payload.
- AppSpec
Ingress Rules Item Match Path - The path to match on.
- AppSpec
Ingress Rules Item Match Path Prefix - Prefix-based match. For example,
/apiwill match/api,/api/, and any nested paths such as/api/v1/endpoint. - AppSpec
Ingress Rules Item Redirect - The redirect configuration for the rule. Only one of
componentorredirectmay be set. - AppSpec
Jobs Item AppSpecJobsItem- AppSpec
Jobs Item Bitbucket AppSpecJobsItemBitbucket- AppSpec
Jobs Item Envs Item AppSpecJobsItemEnvsItem- AppSpec
Jobs Item Envs Item Key - The variable name
- AppSpec
Jobs Item Git AppSpecJobsItemGit- AppSpec
Jobs Item Github AppSpecJobsItemGithub- AppSpec
Jobs Item Gitlab AppSpecJobsItemGitlab- AppSpec
Jobs Item Image AppSpecJobsItemImage- AppSpec
Jobs Item Image Deploy OnPush AppSpecJobsItemImageDeployOnPush- AppSpec
Jobs Item Name - The name. Must be unique across all components within the same app.
- AppSpec
Jobs Item Termination AppSpecJobsItemTermination- AppSpec
Maintenance - Specification to configure maintenance settings for the app, such as maintenance mode and archiving the app.
- AppSpec
Name - The name of the app. Must be unique across all apps in the same account.
- AppSpec
Services Item AppSpecServicesItem- AppSpec
Services Item Autoscaling AppSpecServicesItemAutoscaling- AppSpec
Services Item Autoscaling Metrics AppSpecServicesItemAutoscalingMetrics- AppSpec
Services Item Autoscaling Metrics Cpu - Settings for scaling the component based on CPU utilization.
- AppSpec
Services Item Autoscaling Metrics Request Duration - Settings for scaling the component based on request duration.
- AppSpec
Services Item Autoscaling Metrics Requests PerSecond - Settings for scaling the component based on requests per second.
- AppSpec
Services Item Bitbucket AppSpecServicesItemBitbucket- AppSpec
Services Item Cors AppSpecServicesItemCors- AppSpec
Services Item Cors Allow Origins Item AppSpecServicesItemCorsAllowOriginsItem- AppSpec
Services Item Cors Allow Origins Item Exact - Exact string match. Only 1 of
exact,prefix, orregexmust be set. An empty string is a valid value and will be serialized explicitly rather than being omitted from the payload. - AppSpec
Services Item Cors Allow Origins Item Prefix - Prefix-based match. Only 1 of
exact,prefix, orregexmust be set. - AppSpec
Services Item Cors Allow Origins Item Regex - RE2 style regex-based match. Only 1 of
exact,prefix, orregexmust be set. For more information about RE2 syntax, see: https://github.com/google/re2/wiki/Syntax - AppSpec
Services Item Envs Item AppSpecServicesItemEnvsItem- AppSpec
Services Item Envs Item Key - The variable name
- AppSpec
Services Item Git AppSpecServicesItemGit- AppSpec
Services Item Github AppSpecServicesItemGithub- AppSpec
Services Item Gitlab AppSpecServicesItemGitlab- AppSpec
Services Item Health Check AppSpecServicesItemHealthCheck- AppSpec
Services Item Image AppSpecServicesItemImage- AppSpec
Services Item Image Deploy OnPush AppSpecServicesItemImageDeployOnPush- AppSpec
Services Item Liveness Health Check AppSpecServicesItemLivenessHealthCheck- AppSpec
Services Item Name - The name. Must be unique across all components within the same app.
- AppSpec
Services Item Termination AppSpecServicesItemTermination- AppSpec
Static Sites Item AppSpecStaticSitesItem- AppSpec
Static Sites Item Bitbucket AppSpecStaticSitesItemBitbucket- AppSpec
Static Sites Item Cors AppSpecStaticSitesItemCors- AppSpec
Static Sites Item Cors Allow Origins Item AppSpecStaticSitesItemCorsAllowOriginsItem- AppSpec
Static Sites Item Cors Allow Origins Item Exact - Exact string match. Only 1 of
exact,prefix, orregexmust be set. An empty string is a valid value and will be serialized explicitly rather than being omitted from the payload. - AppSpec
Static Sites Item Cors Allow Origins Item Prefix - Prefix-based match. Only 1 of
exact,prefix, orregexmust be set. - AppSpec
Static Sites Item Cors Allow Origins Item Regex - RE2 style regex-based match. Only 1 of
exact,prefix, orregexmust be set. For more information about RE2 syntax, see: https://github.com/google/re2/wiki/Syntax - AppSpec
Static Sites Item Envs Item AppSpecStaticSitesItemEnvsItem- AppSpec
Static Sites Item Envs Item Key - The variable name
- AppSpec
Static Sites Item Git AppSpecStaticSitesItemGit- AppSpec
Static Sites Item Github AppSpecStaticSitesItemGithub- AppSpec
Static Sites Item Gitlab AppSpecStaticSitesItemGitlab- AppSpec
Static Sites Item Image AppSpecStaticSitesItemImage- AppSpec
Static Sites Item Image Deploy OnPush AppSpecStaticSitesItemImageDeployOnPush- AppSpec
Static Sites Item Name - The name. Must be unique across all components within the same app.
- AppSpec
Vpc AppSpecVpc- AppSpec
Workers Item AppSpecWorkersItem- AppSpec
Workers Item Autoscaling - Configuration for automatically scaling this component based on metrics.
- AppSpec
Workers Item Autoscaling Metrics - The metrics that the component is scaled on.
- AppSpec
Workers Item Autoscaling Metrics Cpu - Settings for scaling the component based on CPU utilization.
- AppSpec
Workers Item Bitbucket AppSpecWorkersItemBitbucket- AppSpec
Workers Item Envs Item AppSpecWorkersItemEnvsItem- AppSpec
Workers Item Envs Item Key - The variable name
- AppSpec
Workers Item Git AppSpecWorkersItemGit- AppSpec
Workers Item Github AppSpecWorkersItemGithub- AppSpec
Workers Item Gitlab AppSpecWorkersItemGitlab- AppSpec
Workers Item Image AppSpecWorkersItemImage- AppSpec
Workers Item Image Deploy OnPush AppSpecWorkersItemImageDeployOnPush- AppSpec
Workers Item Liveness Health Check AppSpecWorkersItemLivenessHealthCheck- AppSpec
Workers Item Name - The name. Must be unique across all components within the same app.
- AppSpec
Workers Item Termination AppSpecWorkersItemTermination- Apps
Assign Alert Destinations Body AppsAssignAlertDestinationsBody- Apps
Assign Alert Destinations Body Slack Webhooks Item AppsAssignAlertDestinationsBodySlackWebhooksItem- Apps
Assign Alert Destinations Response AppsAssignAlertDestinationsResponse- Apps
Assign Alert Destinations Response Alert AppsAssignAlertDestinationsResponseAlert- Apps
Assign Alert Destinations Response Alert Progress AppsAssignAlertDestinationsResponseAlertProgress- Apps
Assign Alert Destinations Response Alert Spec AppsAssignAlertDestinationsResponseAlertSpec- Apps
Cancel Deployment Response AppsCancelDeploymentResponse- Apps
Cancel Event Response AppsCancelEventResponse- Apps
Cancel Event Response Event AppsCancelEventResponseEvent- Apps
Cancel Event Response Event Autoscaling - Autoscaling event details. Only present for autoscaling events.
- Apps
Cancel Event Response Event Autoscaling Components Value AppsCancelEventResponseEventAutoscalingComponentsValue- Apps
Cancel JobInvocation Response AppsCancelJobInvocationResponse- Apps
Create Body AppsCreateBody- Apps
Create Deployment Body AppsCreateDeploymentBody- Apps
Create Deployment Response AppsCreateDeploymentResponse- Apps
Create Response AppsCreateResponse- Apps
Create Response App - An application’s configuration and status.
- Apps
Create Response AppPending Deployment AppsCreateResponseAppPendingDeployment- Apps
Create Response AppPending Deployment Progress AppsCreateResponseAppPendingDeploymentProgress- Apps
Create Response AppPinned Deployment AppsCreateResponseAppPinnedDeployment- Apps
Create Response AppPinned Deployment Progress AppsCreateResponseAppPinnedDeploymentProgress- Apps
Create Response AppVpc AppsCreateResponseAppVpc- Apps
Create Rollback Body AppsCreateRollbackBody- Apps
Create Rollback Response AppsCreateRollbackResponse- Apps
Delete Response AppsDeleteResponse- Apps
GetDeployment Response AppsGetDeploymentResponse- Apps
GetEvent Logs Response AppsGetEventLogsResponse- Apps
GetEvent Response AppsGetEventResponse- Apps
GetEvent Response Event AppsGetEventResponseEvent- Apps
GetEvent Response Event Autoscaling - Autoscaling event details. Only present for autoscaling events.
- Apps
GetEvent Response Event Autoscaling Components Value AppsGetEventResponseEventAutoscalingComponentsValue- Apps
GetExec Active Deployment Response AppsGetExecActiveDeploymentResponse- Apps
GetExec Response AppsGetExecResponse- Apps
GetHealth Response AppsGetHealthResponse- Apps
GetHealth Response AppHealth AppsGetHealthResponseAppHealth- Apps
GetHealth Response AppHealth Components Item AppsGetHealthResponseAppHealthComponentsItem- Apps
GetHealth Response AppHealth Functions Components Item AppsGetHealthResponseAppHealthFunctionsComponentsItem- Apps
GetHealth Response AppHealth Functions Components Item Functions Component Health Metrics Item AppsGetHealthResponseAppHealthFunctionsComponentsItemFunctionsComponentHealthMetricsItem- Apps
GetInstance Size Response AppsGetInstanceSizeResponse- Apps
GetInstance Size Response Instance Size AppsGetInstanceSizeResponseInstanceSize- Apps
GetInstances Response AppsGetInstancesResponse- Apps
GetInstances Response Instances Item AppsGetInstancesResponseInstancesItem- Apps
GetJob Invocation Logs Response AppsGetJobInvocationLogsResponse- Apps
GetJob Invocation Response AppsGetJobInvocationResponse- Apps
GetLogs Active Deployment Aggregate Response AppsGetLogsActiveDeploymentAggregateResponse- Apps
GetLogs Active Deployment Response AppsGetLogsActiveDeploymentResponse- Apps
GetLogs Aggregate Response AppsGetLogsAggregateResponse- Apps
GetLogs Response AppsGetLogsResponse- Apps
GetMetrics Bandwidth Daily Response AppsGetMetricsBandwidthDailyResponse- Apps
GetMetrics Bandwidth Daily Response AppBandwidth Usage Item - Bandwidth usage for an app.
- Apps
GetResponse AppsGetResponse- Apps
GetResponse App - An application’s configuration and status.
- Apps
GetResponse AppPending Deployment AppsGetResponseAppPendingDeployment- Apps
GetResponse AppPending Deployment Progress AppsGetResponseAppPendingDeploymentProgress- Apps
GetResponse AppPinned Deployment AppsGetResponseAppPinnedDeployment- Apps
GetResponse AppPinned Deployment Progress AppsGetResponseAppPinnedDeploymentProgress- Apps
GetResponse AppVpc AppsGetResponseAppVpc- Apps
List Alerts Response AppsListAlertsResponse- Apps
List Alerts Response Alerts Item AppsListAlertsResponseAlertsItem- Apps
List Alerts Response Alerts Item Progress AppsListAlertsResponseAlertsItemProgress- Apps
List Alerts Response Alerts Item Spec AppsListAlertsResponseAlertsItemSpec- Apps
List Deployments Response AppsListDeploymentsResponse- Apps
List Deployments Response Links AppsListDeploymentsResponseLinks- Apps
List Deployments Response Links Pages AppsListDeploymentsResponseLinksPages- Apps
List Deployments Response Links Pages Subtype0 AppsListDeploymentsResponseLinksPagesSubtype0- Apps
List Deployments Response Links Pages Subtype1 AppsListDeploymentsResponseLinksPagesSubtype1- Apps
List Deployments Response Meta AppsListDeploymentsResponseMeta- Apps
List Events Response AppsListEventsResponse- Apps
List Events Response Links AppsListEventsResponseLinks- Apps
List Events Response Links Pages AppsListEventsResponseLinksPages- Apps
List Events Response Links Pages Subtype0 AppsListEventsResponseLinksPagesSubtype0- Apps
List Events Response Links Pages Subtype1 AppsListEventsResponseLinksPagesSubtype1- Apps
List Instance Sizes Response AppsListInstanceSizesResponse- Apps
List Instance Sizes Response Instance Sizes Item AppsListInstanceSizesResponseInstanceSizesItem- Apps
List JobInvocations Response AppsListJobInvocationsResponse- Apps
List JobInvocations Response Links AppsListJobInvocationsResponseLinks- Apps
List JobInvocations Response Links Pages AppsListJobInvocationsResponseLinksPages- Apps
List JobInvocations Response Links Pages Subtype0 AppsListJobInvocationsResponseLinksPagesSubtype0- Apps
List JobInvocations Response Links Pages Subtype1 AppsListJobInvocationsResponseLinksPagesSubtype1- Apps
List Metrics Bandwidth Daily Body AppsListMetricsBandwidthDailyBody- Apps
List Metrics Bandwidth Daily Response AppsListMetricsBandwidthDailyResponse- Apps
List Metrics Bandwidth Daily Response AppBandwidth Usage Item - Bandwidth usage for an app.
- Apps
List Regions Response AppsListRegionsResponse- Apps
List Response AppsListResponse- Apps
List Response Links AppsListResponseLinks- Apps
List Response Links Pages AppsListResponseLinksPages- Apps
List Response Links Pages Subtype0 AppsListResponseLinksPagesSubtype0- Apps
List Response Links Pages Subtype1 AppsListResponseLinksPagesSubtype1- Apps
List Response Meta AppsListResponseMeta- Apps
Restart Body AppsRestartBody- Apps
Restart Response AppsRestartResponse- Apps
Revert Rollback Response AppsRevertRollbackResponse- Apps
Update Body AppsUpdateBody- Apps
Update Response AppsUpdateResponse- Apps
Update Response App - An application’s configuration and status.
- Apps
Update Response AppPending Deployment AppsUpdateResponseAppPendingDeployment- Apps
Update Response AppPending Deployment Progress AppsUpdateResponseAppPendingDeploymentProgress- Apps
Update Response AppPinned Deployment AppsUpdateResponseAppPinnedDeployment- Apps
Update Response AppPinned Deployment Progress AppsUpdateResponseAppPinnedDeploymentProgress- Apps
Update Response AppVpc AppsUpdateResponseAppVpc- Apps
Validate AppSpec Body AppsValidateAppSpecBody- Apps
Validate AppSpec Response AppsValidateAppSpecResponse- Apps
Validate Rollback Body AppsValidateRollbackBody- Apps
Validate Rollback Response AppsValidateRollbackResponse- Apps
Validate Rollback Response Error AppsValidateRollbackResponseError- Apps
Validate Rollback Response Warnings Item AppsValidateRollbackResponseWarningsItem- Assign
Droplets ById Domains Item - An object specifying domain configurations for a Global load balancer.
- Assign
Droplets ById Firewall - An object specifying allow and deny rules to control traffic to the load balancer.
- Assign
Droplets ById Forwarding Rules Item - An object specifying a forwarding rule for a load balancer.
- Assign
Droplets ById GlbSettings - An object specifying forwarding configurations for a Global load balancer.
- Assign
Droplets ById GlbSettings Cdn - An object specifying CDN configurations for a Global load balancer.
- Assign
Droplets ById Health Check - An object specifying health check settings for the load balancer.
- Assign
Droplets ById Ip - An attribute containing the public-facing IP address of the load balancer.
- Assign
Droplets ById Sticky Sessions - An object specifying sticky sessions settings for the load balancer.
- Assign
Droplets ByTag Domains Item - An object specifying domain configurations for a Global load balancer.
- Assign
Droplets ByTag Firewall - An object specifying allow and deny rules to control traffic to the load balancer.
- Assign
Droplets ByTag Forwarding Rules Item - An object specifying a forwarding rule for a load balancer.
- Assign
Droplets ByTag GlbSettings - An object specifying forwarding configurations for a Global load balancer.
- Assign
Droplets ByTag GlbSettings Cdn - An object specifying CDN configurations for a Global load balancer.
- Assign
Droplets ByTag Health Check - An object specifying health check settings for the load balancer.
- Assign
Droplets ByTag Ip - An attribute containing the public-facing IP address of the load balancer.
- Assign
Droplets ByTag Sticky Sessions - An object specifying sticky sessions settings for the load balancer.
- Autoscalepools
Create Body AutoscalepoolsCreateBody- Autoscalepools
Create Body Droplet Template AutoscalepoolsCreateBodyDropletTemplate- Autoscalepools
Create Response AutoscalepoolsCreateResponse- Autoscalepools
Create Response Autoscale Pool AutoscalepoolsCreateResponseAutoscalePool- Autoscalepools
Create Response Autoscale Pool Current Utilization AutoscalepoolsCreateResponseAutoscalePoolCurrentUtilization- Autoscalepools
Create Response Autoscale Pool Droplet Template AutoscalepoolsCreateResponseAutoscalePoolDropletTemplate- Autoscalepools
GetResponse AutoscalepoolsGetResponse- Autoscalepools
GetResponse Autoscale Pool AutoscalepoolsGetResponseAutoscalePool- Autoscalepools
GetResponse Autoscale Pool Current Utilization AutoscalepoolsGetResponseAutoscalePoolCurrentUtilization- Autoscalepools
GetResponse Autoscale Pool Droplet Template AutoscalepoolsGetResponseAutoscalePoolDropletTemplate- Autoscalepools
List History Response AutoscalepoolsListHistoryResponse- Autoscalepools
List History Response History Item AutoscalepoolsListHistoryResponseHistoryItem- Autoscalepools
List History Response Links AutoscalepoolsListHistoryResponseLinks- Autoscalepools
List History Response Links Pages AutoscalepoolsListHistoryResponseLinksPages- Autoscalepools
List History Response Links Pages Subtype0 AutoscalepoolsListHistoryResponseLinksPagesSubtype0- Autoscalepools
List History Response Links Pages Subtype1 AutoscalepoolsListHistoryResponseLinksPagesSubtype1- Autoscalepools
List History Response Meta AutoscalepoolsListHistoryResponseMeta- Autoscalepools
List Members Response AutoscalepoolsListMembersResponse- Autoscalepools
List Members Response Droplets Item AutoscalepoolsListMembersResponseDropletsItem- Autoscalepools
List Members Response Droplets Item Current Utilization AutoscalepoolsListMembersResponseDropletsItemCurrentUtilization- Autoscalepools
List Members Response Links AutoscalepoolsListMembersResponseLinks- Autoscalepools
List Members Response Links Pages AutoscalepoolsListMembersResponseLinksPages- Autoscalepools
List Members Response Links Pages Subtype0 AutoscalepoolsListMembersResponseLinksPagesSubtype0- Autoscalepools
List Members Response Links Pages Subtype1 AutoscalepoolsListMembersResponseLinksPagesSubtype1- Autoscalepools
List Members Response Meta AutoscalepoolsListMembersResponseMeta- Autoscalepools
List Response AutoscalepoolsListResponse- Autoscalepools
List Response Autoscale Pools Item AutoscalepoolsListResponseAutoscalePoolsItem- Autoscalepools
List Response Autoscale Pools Item Current Utilization AutoscalepoolsListResponseAutoscalePoolsItemCurrentUtilization- Autoscalepools
List Response Autoscale Pools Item Droplet Template AutoscalepoolsListResponseAutoscalePoolsItemDropletTemplate- Autoscalepools
List Response Links AutoscalepoolsListResponseLinks- Autoscalepools
List Response Links Pages AutoscalepoolsListResponseLinksPages- Autoscalepools
List Response Links Pages Subtype0 AutoscalepoolsListResponseLinksPagesSubtype0- Autoscalepools
List Response Links Pages Subtype1 AutoscalepoolsListResponseLinksPagesSubtype1- Autoscalepools
List Response Meta AutoscalepoolsListResponseMeta- Autoscalepools
Update Body AutoscalepoolsUpdateBody- Autoscalepools
Update Body Droplet Template AutoscalepoolsUpdateBodyDropletTemplate- Autoscalepools
Update Response AutoscalepoolsUpdateResponse- Autoscalepools
Update Response Autoscale Pool AutoscalepoolsUpdateResponseAutoscalePool- Autoscalepools
Update Response Autoscale Pool Current Utilization AutoscalepoolsUpdateResponseAutoscalePoolCurrentUtilization- Autoscalepools
Update Response Autoscale Pool Droplet Template AutoscalepoolsUpdateResponseAutoscalePoolDropletTemplate- Balance
GetResponse BalanceGetResponse- Batch
File Create Request - Request body for creating a batch input file intent.
- Batch
File Create Request File Name - The file you plan to upload. Must end with
.jsonl(case-insensitive) and contain one request per line in the schema expected by the targetprovider. - Batch
List Response - Cursor-paginated list of batch inference jobs.
- Batch
List Response Data Item - A Batch Inference job.
- Batch
List Response Data Item Errors Item BatchListResponseDataItemErrorsItem- Batch
List Response Data Item Request Counts - Aggregate request counts.
- Batch
Results Response - Presigned download URLs for a batch job. URLs are short-lived — download the artifacts soon after fetching them.
- BgpBgp
- BGP configurations
- Billing
History List Response BillingHistoryListResponse- Billing
History List Response Billing History Item BillingHistoryListResponseBillingHistoryItem- Billing
History List Response Links BillingHistoryListResponseLinks- Billing
History List Response Links Pages BillingHistoryListResponseLinksPages- Billing
History List Response Links Pages Subtype0 BillingHistoryListResponseLinksPagesSubtype0- Billing
History List Response Links Pages Subtype1 BillingHistoryListResponseLinksPagesSubtype1- Billing
History List Response Meta - Information about the response itself.
- Billing
Insights List Response BillingInsightsListResponse- Billing
Insights List Response Data Points Item BillingInsightsListResponseDataPointsItem- Byoip
Prefixes Create Body ByoipPrefixesCreateBody- Byoip
Prefixes Create Response ByoipPrefixesCreateResponse- Byoip
Prefixes GetResponse ByoipPrefixesGetResponse- Byoip
Prefixes GetResponse Byoip Prefix ByoipPrefixesGetResponseByoipPrefix- Byoip
Prefixes GetResponse Byoip Prefix Validations Item ByoipPrefixesGetResponseByoipPrefixValidationsItem- Byoip
Prefixes List Resources Response ByoipPrefixesListResourcesResponse- Byoip
Prefixes List Resources Response IpsItem ByoipPrefixesListResourcesResponseIpsItem- Byoip
Prefixes List Resources Response Links ByoipPrefixesListResourcesResponseLinks- Byoip
Prefixes List Resources Response Links Pages ByoipPrefixesListResourcesResponseLinksPages- Byoip
Prefixes List Resources Response Links Pages Subtype0 ByoipPrefixesListResourcesResponseLinksPagesSubtype0- Byoip
Prefixes List Resources Response Links Pages Subtype1 ByoipPrefixesListResourcesResponseLinksPagesSubtype1- Byoip
Prefixes List Resources Response Meta ByoipPrefixesListResourcesResponseMeta- Byoip
Prefixes List Response ByoipPrefixesListResponse- Byoip
Prefixes List Response Byoip Prefixes Item ByoipPrefixesListResponseByoipPrefixesItem- Byoip
Prefixes List Response Byoip Prefixes Item Validations Item ByoipPrefixesListResponseByoipPrefixesItemValidationsItem- Byoip
Prefixes List Response Links ByoipPrefixesListResponseLinks- Byoip
Prefixes List Response Links Pages ByoipPrefixesListResponseLinksPages- Byoip
Prefixes List Response Links Pages Subtype0 ByoipPrefixesListResponseLinksPagesSubtype0- Byoip
Prefixes List Response Links Pages Subtype1 ByoipPrefixesListResponseLinksPagesSubtype1- Byoip
Prefixes List Response Meta ByoipPrefixesListResponseMeta- Byoip
Prefixes Patch Body ByoipPrefixesPatchBody- Byoip
Prefixes Patch Response ByoipPrefixesPatchResponse- Byoip
Prefixes Patch Response Byoip Prefix ByoipPrefixesPatchResponseByoipPrefix- Byoip
Prefixes Patch Response Byoip Prefix Validations Item ByoipPrefixesPatchResponseByoipPrefixValidationsItem- Byte
Stream - Untyped byte stream used for both success and error responses.
- CdnCreate
Endpoint Body CdnCreateEndpointBody- CdnCreate
Endpoint Body Ttl - The amount of time the content is cached by the CDN’s edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded.
- CdnCreate
Endpoint Response CdnCreateEndpointResponse- CdnCreate
Endpoint Response Endpoint CdnCreateEndpointResponseEndpoint- CdnCreate
Endpoint Response Endpoint Ttl - The amount of time the content is cached by the CDN’s edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded.
- CdnGet
Endpoint Response CdnGetEndpointResponse- CdnGet
Endpoint Response Endpoint CdnGetEndpointResponseEndpoint- CdnGet
Endpoint Response Endpoint Ttl - The amount of time the content is cached by the CDN’s edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded.
- CdnList
Endpoints Response CdnListEndpointsResponse- CdnList
Endpoints Response Endpoints Item CdnListEndpointsResponseEndpointsItem- CdnList
Endpoints Response Endpoints Item Ttl - The amount of time the content is cached by the CDN’s edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded.
- CdnList
Endpoints Response Links CdnListEndpointsResponseLinks- CdnList
Endpoints Response Links Pages CdnListEndpointsResponseLinksPages- CdnList
Endpoints Response Links Pages Subtype0 CdnListEndpointsResponseLinksPagesSubtype0- CdnList
Endpoints Response Links Pages Subtype1 CdnListEndpointsResponseLinksPagesSubtype1- CdnList
Endpoints Response Meta CdnListEndpointsResponseMeta- CdnPurge
Cache Body CdnPurgeCacheBody- CdnUpdate
Endpoints Body CdnUpdateEndpointsBody- CdnUpdate
Endpoints Body Ttl - The amount of time the content is cached by the CDN’s edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded.
- CdnUpdate
Endpoints Response CdnUpdateEndpointsResponse- CdnUpdate
Endpoints Response Endpoint CdnUpdateEndpointsResponseEndpoint- CdnUpdate
Endpoints Response Endpoint Ttl - The amount of time the content is cached by the CDN’s edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded.
- Certificates
Create Response CertificatesCreateResponse- Certificates
Create Response Certificate CertificatesCreateResponseCertificate- Certificates
GetResponse CertificatesGetResponse- Certificates
GetResponse Certificate CertificatesGetResponseCertificate- Certificates
List Response CertificatesListResponse- Certificates
List Response Certificates Item CertificatesListResponseCertificatesItem- Certificates
List Response Links CertificatesListResponseLinks- Certificates
List Response Links Pages CertificatesListResponseLinksPages- Certificates
List Response Links Pages Subtype0 CertificatesListResponseLinksPagesSubtype0- Certificates
List Response Links Pages Subtype1 CertificatesListResponseLinksPagesSubtype1- Certificates
List Response Meta CertificatesListResponseMeta- Client
- Client for DigitalOcean API
- Configurations
ForExternal Logging ConfigurationsForExternalLogging- Configurations
ForExternal Logging Datadog - DataDog configuration.
- Configurations
ForExternal Logging Logtail - Logtail configuration.
- Configurations
ForExternal Logging Name ConfigurationsForExternalLoggingName- Configurations
ForExternal Logging Open Search - OpenSearch configuration.
- Configurations
ForExternal Logging Open Search Basic Auth - Configure Username and/or Password for Basic authentication.
- Configurations
ForExternal Logging Papertrail - Papertrail configuration.
- Contains
AllDomains ForThe AppItem ContainsAllDomainsForTheAppItem- Contains
AllDomains ForThe AppItem Progress ContainsAllDomainsForTheAppItemProgress- Contains
AllDomains ForThe AppItem Spec ContainsAllDomainsForTheAppItemSpec- Contains
AllDomains ForThe AppItem Spec Domain - The hostname for the domain
- Databases
AddBody DatabasesAddBody- Databases
AddConnection Pool Body DatabasesAddConnectionPoolBody- Databases
AddConnection Pool Body Connection DatabasesAddConnectionPoolBodyConnection- Databases
AddConnection Pool Body Private Connection DatabasesAddConnectionPoolBodyPrivateConnection- Databases
AddConnection Pool Body Standby Connection DatabasesAddConnectionPoolBodyStandbyConnection- Databases
AddConnection Pool Body Standby Private Connection DatabasesAddConnectionPoolBodyStandbyPrivateConnection- Databases
AddConnection Pool Response DatabasesAddConnectionPoolResponse- Databases
AddConnection Pool Response Pool DatabasesAddConnectionPoolResponsePool- Databases
AddConnection Pool Response Pool Connection DatabasesAddConnectionPoolResponsePoolConnection- Databases
AddConnection Pool Response Pool Private Connection DatabasesAddConnectionPoolResponsePoolPrivateConnection- Databases
AddConnection Pool Response Pool Standby Connection DatabasesAddConnectionPoolResponsePoolStandbyConnection- Databases
AddConnection Pool Response Pool Standby Private Connection DatabasesAddConnectionPoolResponsePoolStandbyPrivateConnection- Databases
AddResponse DatabasesAddResponse- Databases
AddResponse Db DatabasesAddResponseDb- Databases
AddUser Body DatabasesAddUserBody- Databases
AddUser Body Mysql Settings DatabasesAddUserBodyMysqlSettings- Databases
AddUser Body Settings DatabasesAddUserBodySettings- Databases
AddUser Body Settings AclItem DatabasesAddUserBodySettingsAclItem- Databases
AddUser Body Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
AddUser Body Settings Opensearch AclItem DatabasesAddUserBodySettingsOpensearchAclItem- Databases
AddUser Response DatabasesAddUserResponse- Databases
AddUser Response User DatabasesAddUserResponseUser- Databases
AddUser Response User Mysql Settings DatabasesAddUserResponseUserMysqlSettings- Databases
AddUser Response User Settings DatabasesAddUserResponseUserSettings- Databases
AddUser Response User Settings AclItem DatabasesAddUserResponseUserSettingsAclItem- Databases
AddUser Response User Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
AddUser Response User Settings Opensearch AclItem DatabasesAddUserResponseUserSettingsOpensearchAclItem- Databases
Create Cluster Body DatabasesCreateClusterBody- Databases
Create Cluster Body Autoscale - Contains all autoscaling configuration for a database cluster
- Databases
Create Cluster Body Autoscale Storage DatabasesCreateClusterBodyAutoscaleStorage- Databases
Create Cluster Body Backup Restore DatabasesCreateClusterBodyBackupRestore- Databases
Create Cluster Body Connection DatabasesCreateClusterBodyConnection- Databases
Create Cluster Body DoSettings DatabasesCreateClusterBodyDoSettings- Databases
Create Cluster Body DoSettings Service Cnames Item DatabasesCreateClusterBodyDoSettingsServiceCnamesItem- Databases
Create Cluster Body Maintenance Window DatabasesCreateClusterBodyMaintenanceWindow- Databases
Create Cluster Body Metrics Endpoints Item DatabasesCreateClusterBodyMetricsEndpointsItem- Databases
Create Cluster Body Private Connection DatabasesCreateClusterBodyPrivateConnection- Databases
Create Cluster Body Private Network Uuid - A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account’s default VPC for the region.
Requiresvpc:readscope. - Databases
Create Cluster Body Rules Item DatabasesCreateClusterBodyRulesItem- Databases
Create Cluster Body Rules Item Cluster Uuid - A unique ID for the database cluster to which the rule is applied.
- Databases
Create Cluster Body Rules Item Uuid - A unique ID for the firewall rule itself.
- Databases
Create Cluster Body Schema Registry Connection - The connection details for Schema Registry.
- Databases
Create Cluster Body Standby Connection DatabasesCreateClusterBodyStandbyConnection- Databases
Create Cluster Body Standby Private Connection DatabasesCreateClusterBodyStandbyPrivateConnection- Databases
Create Cluster Body UiConnection - The connection details for OpenSearch dashboard.
- Databases
Create Cluster Body Users Item DatabasesCreateClusterBodyUsersItem- Databases
Create Cluster Body Users Item Mysql Settings DatabasesCreateClusterBodyUsersItemMysqlSettings- Databases
Create Cluster Body Users Item Settings DatabasesCreateClusterBodyUsersItemSettings- Databases
Create Cluster Body Users Item Settings AclItem DatabasesCreateClusterBodyUsersItemSettingsAclItem- Databases
Create Cluster Body Users Item Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
Create Cluster Body Users Item Settings Opensearch AclItem DatabasesCreateClusterBodyUsersItemSettingsOpensearchAclItem- Databases
Create Cluster Response DatabasesCreateClusterResponse- Databases
Create Cluster Response Database DatabasesCreateClusterResponseDatabase- Databases
Create Cluster Response Database Connection DatabasesCreateClusterResponseDatabaseConnection- Databases
Create Cluster Response Database DoSettings DatabasesCreateClusterResponseDatabaseDoSettings- Databases
Create Cluster Response Database DoSettings Service Cnames Item DatabasesCreateClusterResponseDatabaseDoSettingsServiceCnamesItem- Databases
Create Cluster Response Database Maintenance Window DatabasesCreateClusterResponseDatabaseMaintenanceWindow- Databases
Create Cluster Response Database Metrics Endpoints Item DatabasesCreateClusterResponseDatabaseMetricsEndpointsItem- Databases
Create Cluster Response Database Private Connection DatabasesCreateClusterResponseDatabasePrivateConnection- Databases
Create Cluster Response Database Private Network Uuid - A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account’s default VPC for the region.
Requiresvpc:readscope. - Databases
Create Cluster Response Database Rules Item DatabasesCreateClusterResponseDatabaseRulesItem- Databases
Create Cluster Response Database Rules Item Cluster Uuid - A unique ID for the database cluster to which the rule is applied.
- Databases
Create Cluster Response Database Rules Item Uuid - A unique ID for the firewall rule itself.
- Databases
Create Cluster Response Database Schema Registry Connection - The connection details for Schema Registry.
- Databases
Create Cluster Response Database Standby Connection DatabasesCreateClusterResponseDatabaseStandbyConnection- Databases
Create Cluster Response Database Standby Private Connection DatabasesCreateClusterResponseDatabaseStandbyPrivateConnection- Databases
Create Cluster Response Database UiConnection - The connection details for OpenSearch dashboard.
- Databases
Create Cluster Response Database Users Item DatabasesCreateClusterResponseDatabaseUsersItem- Databases
Create Cluster Response Database Users Item Mysql Settings DatabasesCreateClusterResponseDatabaseUsersItemMysqlSettings- Databases
Create Cluster Response Database Users Item Settings DatabasesCreateClusterResponseDatabaseUsersItemSettings- Databases
Create Cluster Response Database Users Item Settings AclItem DatabasesCreateClusterResponseDatabaseUsersItemSettingsAclItem- Databases
Create Cluster Response Database Users Item Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
Create Cluster Response Database Users Item Settings Opensearch AclItem DatabasesCreateClusterResponseDatabaseUsersItemSettingsOpensearchAclItem- Databases
Create Kafka Schema Body DatabasesCreateKafkaSchemaBody- Databases
Create Kafka Schema Response DatabasesCreateKafkaSchemaResponse- Databases
Create Kafka Topic Body DatabasesCreateKafkaTopicBody- Databases
Create Kafka Topic Body Config DatabasesCreateKafkaTopicBodyConfig- Databases
Create Kafka Topic Response DatabasesCreateKafkaTopicResponse- Databases
Create Kafka Topic Response Topic DatabasesCreateKafkaTopicResponseTopic- Databases
Create Kafka Topic Response Topic Config DatabasesCreateKafkaTopicResponseTopicConfig- Databases
Create Kafka Topic Response Topic Partitions Item DatabasesCreateKafkaTopicResponseTopicPartitionsItem- Databases
Create Kafka Topic Response Topic Partitions Item Consumer Groups Item DatabasesCreateKafkaTopicResponseTopicPartitionsItemConsumerGroupsItem- Databases
Create Logsink Body DatabasesCreateLogsinkBody- Databases
Create Logsink Body Config DatabasesCreateLogsinkBodyConfig- Databases
Create Logsink Body Config Subtype0 DatabasesCreateLogsinkBodyConfigSubtype0- Databases
Create Logsink Body Config Subtype1 DatabasesCreateLogsinkBodyConfigSubtype1- Databases
Create Logsink Body Config Subtype2 DatabasesCreateLogsinkBodyConfigSubtype2- Databases
Create Logsink Body Config Subtype3 - Configuration for Datadog integration applicable only to MongoDB clusters.
- Databases
Create Logsink Response DatabasesCreateLogsinkResponse- Databases
Create Logsink Response Sink DatabasesCreateLogsinkResponseSink- Databases
Create Logsink Response Sink Config DatabasesCreateLogsinkResponseSinkConfig- Databases
Create Logsink Response Sink Config Subtype0 DatabasesCreateLogsinkResponseSinkConfigSubtype0- Databases
Create Logsink Response Sink Config Subtype1 DatabasesCreateLogsinkResponseSinkConfigSubtype1- Databases
Create Logsink Response Sink Config Subtype2 DatabasesCreateLogsinkResponseSinkConfigSubtype2- Databases
Create Logsink Response Sink Config Subtype3 - Configuration for Datadog integration applicable only to MongoDB clusters.
- Databases
Create Replica Body DatabasesCreateReplicaBody- Databases
Create Replica Body Connection DatabasesCreateReplicaBodyConnection- Databases
Create Replica Body DoSettings DatabasesCreateReplicaBodyDoSettings- Databases
Create Replica Body DoSettings Service Cnames Item DatabasesCreateReplicaBodyDoSettingsServiceCnamesItem- Databases
Create Replica Body Private Connection DatabasesCreateReplicaBodyPrivateConnection- Databases
Create Replica Response DatabasesCreateReplicaResponse- Databases
Create Replica Response Replica DatabasesCreateReplicaResponseReplica- Databases
Create Replica Response Replica Connection DatabasesCreateReplicaResponseReplicaConnection- Databases
Create Replica Response Replica DoSettings DatabasesCreateReplicaResponseReplicaDoSettings- Databases
Create Replica Response Replica DoSettings Service Cnames Item DatabasesCreateReplicaResponseReplicaDoSettingsServiceCnamesItem- Databases
Create Replica Response Replica Private Connection DatabasesCreateReplicaResponseReplicaPrivateConnection- Databases
GetAutoscale Response DatabasesGetAutoscaleResponse- Databases
GetAutoscale Response Autoscale - Contains all autoscaling configuration for a database cluster
- Databases
GetAutoscale Response Autoscale Storage DatabasesGetAutoscaleResponseAutoscaleStorage- Databases
GetCa Response DatabasesGetCaResponse- Databases
GetCa Response Ca DatabasesGetCaResponseCa- Databases
GetCluster Metrics Credentials Response DatabasesGetClusterMetricsCredentialsResponse- Databases
GetCluster Metrics Credentials Response Credentials DatabasesGetClusterMetricsCredentialsResponseCredentials- Databases
GetCluster Metrics Credentials Response Credentials Credentials DatabasesGetClusterMetricsCredentialsResponseCredentialsCredentials- Databases
GetCluster Response DatabasesGetClusterResponse- Databases
GetCluster Response Database DatabasesGetClusterResponseDatabase- Databases
GetCluster Response Database Connection DatabasesGetClusterResponseDatabaseConnection- Databases
GetCluster Response Database DoSettings DatabasesGetClusterResponseDatabaseDoSettings- Databases
GetCluster Response Database DoSettings Service Cnames Item DatabasesGetClusterResponseDatabaseDoSettingsServiceCnamesItem- Databases
GetCluster Response Database Maintenance Window DatabasesGetClusterResponseDatabaseMaintenanceWindow- Databases
GetCluster Response Database Metrics Endpoints Item DatabasesGetClusterResponseDatabaseMetricsEndpointsItem- Databases
GetCluster Response Database Private Connection DatabasesGetClusterResponseDatabasePrivateConnection- Databases
GetCluster Response Database Private Network Uuid - A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account’s default VPC for the region.
Requiresvpc:readscope. - Databases
GetCluster Response Database Rules Item DatabasesGetClusterResponseDatabaseRulesItem- Databases
GetCluster Response Database Rules Item Cluster Uuid - A unique ID for the database cluster to which the rule is applied.
- Databases
GetCluster Response Database Rules Item Uuid - A unique ID for the firewall rule itself.
- Databases
GetCluster Response Database Schema Registry Connection - The connection details for Schema Registry.
- Databases
GetCluster Response Database Standby Connection DatabasesGetClusterResponseDatabaseStandbyConnection- Databases
GetCluster Response Database Standby Private Connection DatabasesGetClusterResponseDatabaseStandbyPrivateConnection- Databases
GetCluster Response Database UiConnection - The connection details for OpenSearch dashboard.
- Databases
GetCluster Response Database Users Item DatabasesGetClusterResponseDatabaseUsersItem- Databases
GetCluster Response Database Users Item Mysql Settings DatabasesGetClusterResponseDatabaseUsersItemMysqlSettings- Databases
GetCluster Response Database Users Item Settings DatabasesGetClusterResponseDatabaseUsersItemSettings- Databases
GetCluster Response Database Users Item Settings AclItem DatabasesGetClusterResponseDatabaseUsersItemSettingsAclItem- Databases
GetCluster Response Database Users Item Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
GetCluster Response Database Users Item Settings Opensearch AclItem DatabasesGetClusterResponseDatabaseUsersItemSettingsOpensearchAclItem- Databases
GetConfig Response DatabasesGetConfigResponse- Databases
GetConfig Response Config DatabasesGetConfigResponseConfig- Databases
GetConfig Response Config Subtype0 DatabasesGetConfigResponseConfigSubtype0- Databases
GetConfig Response Config Subtype0 Default Time Zone - Default server time zone, in the form of an offset from UTC (from -12:00 to +12:00), a time zone name (EST), or ‘SYSTEM’ to use the MySQL server default.
- Databases
GetConfig Response Config Subtype0 Innodb Flush Neighbors - Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent.
- Databases
GetConfig Response Config Subtype0 Innodb FtServer Stopword Table - The InnoDB FULLTEXT index stopword list for all InnoDB tables.
- Databases
GetConfig Response Config Subtype0 Innodb FtUser Stopword Table - The InnoDB FULLTEXT index stopword list for user-created FULLTEXT indexes. Must be in the form
db_name/table_name. Set tonullto clear a previously configured value. - Databases
GetConfig Response Config Subtype0 Mysql Incremental Backup - MySQL Incremental Backup configuration settings
- Databases
GetConfig Response Config Subtype0 Optimizer Switch - Controls query optimizer behavior as a comma-separated list of
option=valuepairs, ordefaultto restore server defaults. Each value must beon,off, ordefault. - Databases
GetConfig Response Config Subtype0 SqlMode - Global SQL mode. If empty, uses MySQL server defaults. Must only include uppercase alphabetic characters, underscores, and commas.
- Databases
GetConfig Response Config Subtype1 DatabasesGetConfigResponseConfigSubtype1- Databases
GetConfig Response Config Subtype2 DatabasesGetConfigResponseConfigSubtype2- Databases
GetConfig Response Config Subtype3 DatabasesGetConfigResponseConfigSubtype3- Databases
GetConfig Response Config Subtype4 DatabasesGetConfigResponseConfigSubtype4- Databases
GetConfig Response Config Subtype5 DatabasesGetConfigResponseConfigSubtype5- Databases
GetConfig Response Config Subtype6 DatabasesGetConfigResponseConfigSubtype6- Databases
GetConfig Response Config Subtype1 PgPartman BgwRole - Controls which role to use for pg_partman’s scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- Databases
GetConfig Response Config Subtype1 Pgbouncer - PGBouncer connection pooling settings
- Databases
GetConfig Response Config Subtype1 Timescaledb - TimescaleDB extension configuration values
- Databases
GetConfig Response Config Subtype1 Timezone - PostgreSQL service timezone
- Databases
GetConfig Response Config Subtype2 Redis Notify Keyspace Events - Set notify-keyspace-events option. Requires at least
KorEand accepts any combination of the following options. Setting the parameter to""disables notifications. - Databases
GetConfig Response Config Subtype3 Valkey Notify Keyspace Events - Set notify-keyspace-events option. Requires at least
KorEand accepts any combination of the following options. Setting the parameter to""disables notifications. - Databases
GetConnection Pool Response DatabasesGetConnectionPoolResponse- Databases
GetConnection Pool Response Pool DatabasesGetConnectionPoolResponsePool- Databases
GetConnection Pool Response Pool Connection DatabasesGetConnectionPoolResponsePoolConnection- Databases
GetConnection Pool Response Pool Private Connection DatabasesGetConnectionPoolResponsePoolPrivateConnection- Databases
GetConnection Pool Response Pool Standby Connection DatabasesGetConnectionPoolResponsePoolStandbyConnection- Databases
GetConnection Pool Response Pool Standby Private Connection DatabasesGetConnectionPoolResponsePoolStandbyPrivateConnection- Databases
GetDo Settings Response DatabasesGetDoSettingsResponse- Databases
GetDo Settings Response DoSettings - DigitalOcean-specific settings for the database cluster.
- Databases
GetDo Settings Response DoSettings Service Cnames Item DatabasesGetDoSettingsResponseDoSettingsServiceCnamesItem- Databases
GetEviction Policy Response DatabasesGetEvictionPolicyResponse- Databases
GetKafka Schema Config Response DatabasesGetKafkaSchemaConfigResponse- Databases
GetKafka Schema Response DatabasesGetKafkaSchemaResponse- Databases
GetKafka Schema Subject Config Response DatabasesGetKafkaSchemaSubjectConfigResponse- Databases
GetKafka Schema Version Response DatabasesGetKafkaSchemaVersionResponse- Databases
GetKafka Topic Response DatabasesGetKafkaTopicResponse- Databases
GetKafka Topic Response Topic DatabasesGetKafkaTopicResponseTopic- Databases
GetKafka Topic Response Topic Config DatabasesGetKafkaTopicResponseTopicConfig- Databases
GetKafka Topic Response Topic Partitions Item DatabasesGetKafkaTopicResponseTopicPartitionsItem- Databases
GetKafka Topic Response Topic Partitions Item Consumer Groups Item DatabasesGetKafkaTopicResponseTopicPartitionsItemConsumerGroupsItem- Databases
GetLogsink Response DatabasesGetLogsinkResponse- Databases
GetLogsink Response Config DatabasesGetLogsinkResponseConfig- Databases
GetLogsink Response Config Subtype0 DatabasesGetLogsinkResponseConfigSubtype0- Databases
GetLogsink Response Config Subtype1 DatabasesGetLogsinkResponseConfigSubtype1- Databases
GetLogsink Response Config Subtype2 DatabasesGetLogsinkResponseConfigSubtype2- Databases
GetLogsink Response Config Subtype3 - Configuration for Datadog integration applicable only to MongoDB clusters.
- Databases
GetMigration Status Response DatabasesGetMigrationStatusResponse- Databases
GetReplica Response DatabasesGetReplicaResponse- Databases
GetReplica Response Replica DatabasesGetReplicaResponseReplica- Databases
GetReplica Response Replica Connection DatabasesGetReplicaResponseReplicaConnection- Databases
GetReplica Response Replica DoSettings DatabasesGetReplicaResponseReplicaDoSettings- Databases
GetReplica Response Replica DoSettings Service Cnames Item DatabasesGetReplicaResponseReplicaDoSettingsServiceCnamesItem- Databases
GetReplica Response Replica Private Connection DatabasesGetReplicaResponseReplicaPrivateConnection- Databases
GetResponse DatabasesGetResponse- Databases
GetResponse Db DatabasesGetResponseDb- Databases
GetSql Mode Response DatabasesGetSqlModeResponse- Databases
GetUser Response DatabasesGetUserResponse- Databases
GetUser Response User DatabasesGetUserResponseUser- Databases
GetUser Response User Mysql Settings DatabasesGetUserResponseUserMysqlSettings- Databases
GetUser Response User Settings DatabasesGetUserResponseUserSettings- Databases
GetUser Response User Settings AclItem DatabasesGetUserResponseUserSettingsAclItem- Databases
GetUser Response User Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
GetUser Response User Settings Opensearch AclItem DatabasesGetUserResponseUserSettingsOpensearchAclItem- Databases
List Backups Response DatabasesListBackupsResponse- Databases
List Backups Response Backups Item DatabasesListBackupsResponseBackupsItem- Databases
List Backups Response Scheduled Backup Time DatabasesListBackupsResponseScheduledBackupTime- Databases
List Clusters Response DatabasesListClustersResponse- Databases
List Clusters Response Databases Item DatabasesListClustersResponseDatabasesItem- Databases
List Clusters Response Databases Item Connection DatabasesListClustersResponseDatabasesItemConnection- Databases
List Clusters Response Databases Item DoSettings DatabasesListClustersResponseDatabasesItemDoSettings- Databases
List Clusters Response Databases Item DoSettings Service Cnames Item DatabasesListClustersResponseDatabasesItemDoSettingsServiceCnamesItem- Databases
List Clusters Response Databases Item Maintenance Window DatabasesListClustersResponseDatabasesItemMaintenanceWindow- Databases
List Clusters Response Databases Item Metrics Endpoints Item DatabasesListClustersResponseDatabasesItemMetricsEndpointsItem- Databases
List Clusters Response Databases Item Private Connection DatabasesListClustersResponseDatabasesItemPrivateConnection- Databases
List Clusters Response Databases Item Private Network Uuid - A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account’s default VPC for the region.
Requiresvpc:readscope. - Databases
List Clusters Response Databases Item Rules Item DatabasesListClustersResponseDatabasesItemRulesItem- Databases
List Clusters Response Databases Item Rules Item Cluster Uuid - A unique ID for the database cluster to which the rule is applied.
- Databases
List Clusters Response Databases Item Rules Item Uuid - A unique ID for the firewall rule itself.
- Databases
List Clusters Response Databases Item Schema Registry Connection - The connection details for Schema Registry.
- Databases
List Clusters Response Databases Item Standby Connection DatabasesListClustersResponseDatabasesItemStandbyConnection- Databases
List Clusters Response Databases Item Standby Private Connection DatabasesListClustersResponseDatabasesItemStandbyPrivateConnection- Databases
List Clusters Response Databases Item UiConnection - The connection details for OpenSearch dashboard.
- Databases
List Clusters Response Databases Item Users Item DatabasesListClustersResponseDatabasesItemUsersItem- Databases
List Clusters Response Databases Item Users Item Mysql Settings DatabasesListClustersResponseDatabasesItemUsersItemMysqlSettings- Databases
List Clusters Response Databases Item Users Item Settings DatabasesListClustersResponseDatabasesItemUsersItemSettings- Databases
List Clusters Response Databases Item Users Item Settings AclItem DatabasesListClustersResponseDatabasesItemUsersItemSettingsAclItem- Databases
List Clusters Response Databases Item Users Item Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
List Clusters Response Databases Item Users Item Settings Opensearch AclItem DatabasesListClustersResponseDatabasesItemUsersItemSettingsOpensearchAclItem- Databases
List Connection Pools Response DatabasesListConnectionPoolsResponse- Databases
List Connection Pools Response Pools Item DatabasesListConnectionPoolsResponsePoolsItem- Databases
List Connection Pools Response Pools Item Connection DatabasesListConnectionPoolsResponsePoolsItemConnection- Databases
List Connection Pools Response Pools Item Private Connection DatabasesListConnectionPoolsResponsePoolsItemPrivateConnection- Databases
List Connection Pools Response Pools Item Standby Connection DatabasesListConnectionPoolsResponsePoolsItemStandbyConnection- Databases
List Connection Pools Response Pools Item Standby Private Connection DatabasesListConnectionPoolsResponsePoolsItemStandbyPrivateConnection- Databases
List Events Logs Response DatabasesListEventsLogsResponse- Databases
List Events Logs Response Events Item DatabasesListEventsLogsResponseEventsItem- Databases
List Firewall Rules Response DatabasesListFirewallRulesResponse- Databases
List Firewall Rules Response Rules Item DatabasesListFirewallRulesResponseRulesItem- Databases
List Firewall Rules Response Rules Item Cluster Uuid - A unique ID for the database cluster to which the rule is applied.
- Databases
List Firewall Rules Response Rules Item Uuid - A unique ID for the firewall rule itself.
- Databases
List Kafka Schemas Response DatabasesListKafkaSchemasResponse- Databases
List Kafka Schemas Response Subjects Item DatabasesListKafkaSchemasResponseSubjectsItem- Databases
List Kafka Topics Response DatabasesListKafkaTopicsResponse- Databases
List Kafka Topics Response Topics Item DatabasesListKafkaTopicsResponseTopicsItem- Databases
List Logsink Response DatabasesListLogsinkResponse- Databases
List Logsink Response Sinks Item DatabasesListLogsinkResponseSinksItem- Databases
List Logsink Response Sinks Item Config DatabasesListLogsinkResponseSinksItemConfig- Databases
List Logsink Response Sinks Item Config Subtype0 DatabasesListLogsinkResponseSinksItemConfigSubtype0- Databases
List Logsink Response Sinks Item Config Subtype1 DatabasesListLogsinkResponseSinksItemConfigSubtype1- Databases
List Logsink Response Sinks Item Config Subtype2 DatabasesListLogsinkResponseSinksItemConfigSubtype2- Databases
List Logsink Response Sinks Item Config Subtype3 - Configuration for Datadog integration applicable only to MongoDB clusters.
- Databases
List Opeasearch Indexes Response DatabasesListOpeasearchIndexesResponse- Databases
List Opeasearch Indexes Response Indexes Item DatabasesListOpeasearchIndexesResponseIndexesItem- Databases
List Options Response DatabasesListOptionsResponse- Databases
List Options Response Options DatabasesListOptionsResponseOptions- Databases
List Options Response Options Advanced Mysql DatabasesListOptionsResponseOptionsAdvancedMysql- Databases
List Options Response Options Advanced Mysql Layouts Item DatabasesListOptionsResponseOptionsAdvancedMysqlLayoutsItem- Databases
List Options Response Options Advanced Pg DatabasesListOptionsResponseOptionsAdvancedPg- Databases
List Options Response Options Advanced PgLayouts Item DatabasesListOptionsResponseOptionsAdvancedPgLayoutsItem- Databases
List Options Response Options Kafka DatabasesListOptionsResponseOptionsKafka- Databases
List Options Response Options Kafka Layouts Item DatabasesListOptionsResponseOptionsKafkaLayoutsItem- Databases
List Options Response Options Mongodb DatabasesListOptionsResponseOptionsMongodb- Databases
List Options Response Options Mongodb Layouts Item DatabasesListOptionsResponseOptionsMongodbLayoutsItem- Databases
List Options Response Options Mysql DatabasesListOptionsResponseOptionsMysql- Databases
List Options Response Options Mysql Layouts Item DatabasesListOptionsResponseOptionsMysqlLayoutsItem- Databases
List Options Response Options Opensearch DatabasesListOptionsResponseOptionsOpensearch- Databases
List Options Response Options Opensearch Layouts Item DatabasesListOptionsResponseOptionsOpensearchLayoutsItem- Databases
List Options Response Options Pg DatabasesListOptionsResponseOptionsPg- Databases
List Options Response Options PgLayouts Item DatabasesListOptionsResponseOptionsPgLayoutsItem- Databases
List Options Response Options Redis DatabasesListOptionsResponseOptionsRedis- Databases
List Options Response Options Redis Layouts Item DatabasesListOptionsResponseOptionsRedisLayoutsItem- Databases
List Options Response Options Valkey DatabasesListOptionsResponseOptionsValkey- Databases
List Options Response Options Valkey Layouts Item DatabasesListOptionsResponseOptionsValkeyLayoutsItem- Databases
List Options Response Version Availability DatabasesListOptionsResponseVersionAvailability- Databases
List Options Response Version Availability Advanced Mysql Item DatabasesListOptionsResponseVersionAvailabilityAdvancedMysqlItem- Databases
List Options Response Version Availability Advanced PgItem DatabasesListOptionsResponseVersionAvailabilityAdvancedPgItem- Databases
List Options Response Version Availability Kafka Item DatabasesListOptionsResponseVersionAvailabilityKafkaItem- Databases
List Options Response Version Availability Mongodb Item DatabasesListOptionsResponseVersionAvailabilityMongodbItem- Databases
List Options Response Version Availability Mysql Item DatabasesListOptionsResponseVersionAvailabilityMysqlItem- Databases
List Options Response Version Availability Opensearch Item DatabasesListOptionsResponseVersionAvailabilityOpensearchItem- Databases
List Options Response Version Availability PgItem DatabasesListOptionsResponseVersionAvailabilityPgItem- Databases
List Options Response Version Availability Redis Item DatabasesListOptionsResponseVersionAvailabilityRedisItem- Databases
List Options Response Version Availability Valkey Item DatabasesListOptionsResponseVersionAvailabilityValkeyItem- Databases
List Replicas Response DatabasesListReplicasResponse- Databases
List Replicas Response Replicas Item DatabasesListReplicasResponseReplicasItem- Databases
List Replicas Response Replicas Item Connection DatabasesListReplicasResponseReplicasItemConnection- Databases
List Replicas Response Replicas Item DoSettings DatabasesListReplicasResponseReplicasItemDoSettings- Databases
List Replicas Response Replicas Item DoSettings Service Cnames Item DatabasesListReplicasResponseReplicasItemDoSettingsServiceCnamesItem- Databases
List Replicas Response Replicas Item Private Connection DatabasesListReplicasResponseReplicasItemPrivateConnection- Databases
List Response DatabasesListResponse- Databases
List Response DbsItem DatabasesListResponseDbsItem- Databases
List Users Response DatabasesListUsersResponse- Databases
List Users Response Users Item DatabasesListUsersResponseUsersItem- Databases
List Users Response Users Item Mysql Settings DatabasesListUsersResponseUsersItemMysqlSettings- Databases
List Users Response Users Item Settings DatabasesListUsersResponseUsersItemSettings- Databases
List Users Response Users Item Settings AclItem DatabasesListUsersResponseUsersItemSettingsAclItem- Databases
List Users Response Users Item Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
List Users Response Users Item Settings Opensearch AclItem DatabasesListUsersResponseUsersItemSettingsOpensearchAclItem- Databases
Patch Config Body DatabasesPatchConfigBody- Databases
Patch Config Body Config DatabasesPatchConfigBodyConfig- Databases
Patch Config Body Config Subtype0 DatabasesPatchConfigBodyConfigSubtype0- Databases
Patch Config Body Config Subtype0 Default Time Zone - Default server time zone, in the form of an offset from UTC (from -12:00 to +12:00), a time zone name (EST), or ‘SYSTEM’ to use the MySQL server default.
- Databases
Patch Config Body Config Subtype0 Innodb Flush Neighbors - Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent.
- Databases
Patch Config Body Config Subtype0 Innodb FtServer Stopword Table - The InnoDB FULLTEXT index stopword list for all InnoDB tables.
- Databases
Patch Config Body Config Subtype0 Innodb FtUser Stopword Table - The InnoDB FULLTEXT index stopword list for user-created FULLTEXT indexes. Must be in the form
db_name/table_name. Set tonullto clear a previously configured value. - Databases
Patch Config Body Config Subtype0 Mysql Incremental Backup - MySQL Incremental Backup configuration settings
- Databases
Patch Config Body Config Subtype0 Optimizer Switch - Controls query optimizer behavior as a comma-separated list of
option=valuepairs, ordefaultto restore server defaults. Each value must beon,off, ordefault. - Databases
Patch Config Body Config Subtype0 SqlMode - Global SQL mode. If empty, uses MySQL server defaults. Must only include uppercase alphabetic characters, underscores, and commas.
- Databases
Patch Config Body Config Subtype1 DatabasesPatchConfigBodyConfigSubtype1- Databases
Patch Config Body Config Subtype2 DatabasesPatchConfigBodyConfigSubtype2- Databases
Patch Config Body Config Subtype3 DatabasesPatchConfigBodyConfigSubtype3- Databases
Patch Config Body Config Subtype4 DatabasesPatchConfigBodyConfigSubtype4- Databases
Patch Config Body Config Subtype5 DatabasesPatchConfigBodyConfigSubtype5- Databases
Patch Config Body Config Subtype6 DatabasesPatchConfigBodyConfigSubtype6- Databases
Patch Config Body Config Subtype1 PgPartman BgwRole - Controls which role to use for pg_partman’s scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.
- Databases
Patch Config Body Config Subtype1 Pgbouncer - PGBouncer connection pooling settings
- Databases
Patch Config Body Config Subtype1 Timescaledb - TimescaleDB extension configuration values
- Databases
Patch Config Body Config Subtype1 Timezone - PostgreSQL service timezone
- Databases
Patch Config Body Config Subtype2 Redis Notify Keyspace Events - Set notify-keyspace-events option. Requires at least
KorEand accepts any combination of the following options. Setting the parameter to""disables notifications. - Databases
Patch Config Body Config Subtype3 Valkey Notify Keyspace Events - Set notify-keyspace-events option. Requires at least
KorEand accepts any combination of the following options. Setting the parameter to""disables notifications. - Databases
Reset Auth Body DatabasesResetAuthBody- Databases
Reset Auth Body Mysql Settings DatabasesResetAuthBodyMysqlSettings- Databases
Reset Auth Response DatabasesResetAuthResponse- Databases
Reset Auth Response User DatabasesResetAuthResponseUser- Databases
Reset Auth Response User Mysql Settings DatabasesResetAuthResponseUserMysqlSettings- Databases
Reset Auth Response User Settings DatabasesResetAuthResponseUserSettings- Databases
Reset Auth Response User Settings AclItem DatabasesResetAuthResponseUserSettingsAclItem- Databases
Reset Auth Response User Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
Reset Auth Response User Settings Opensearch AclItem DatabasesResetAuthResponseUserSettingsOpensearchAclItem- Databases
Update Autoscale Body - Contains all autoscaling configuration for a database cluster
- Databases
Update Autoscale Body Storage DatabasesUpdateAutoscaleBodyStorage- Databases
Update Cluster Metrics Credentials Body DatabasesUpdateClusterMetricsCredentialsBody- Databases
Update Cluster Metrics Credentials Body Credentials DatabasesUpdateClusterMetricsCredentialsBodyCredentials- Databases
Update Cluster Size Body DatabasesUpdateClusterSizeBody- Databases
Update Connection Pool Body DatabasesUpdateConnectionPoolBody- Databases
Update DoSettings Body DatabasesUpdateDoSettingsBody- Databases
Update DoSettings Body DoSettings - DigitalOcean-specific settings for the database cluster.
- Databases
Update DoSettings Body DoSettings Service Cnames Item DatabasesUpdateDoSettingsBodyDoSettingsServiceCnamesItem- Databases
Update Eviction Policy Body DatabasesUpdateEvictionPolicyBody- Databases
Update Firewall Rules Body DatabasesUpdateFirewallRulesBody- Databases
Update Firewall Rules Body Rules Item DatabasesUpdateFirewallRulesBodyRulesItem- Databases
Update Firewall Rules Body Rules Item Cluster Uuid - A unique ID for the database cluster to which the rule is applied.
- Databases
Update Firewall Rules Body Rules Item Uuid - A unique ID for the firewall rule itself.
- Databases
Update Kafka Schema Config Body DatabasesUpdateKafkaSchemaConfigBody- Databases
Update Kafka Schema Config Response DatabasesUpdateKafkaSchemaConfigResponse- Databases
Update Kafka Schema Subject Config Body DatabasesUpdateKafkaSchemaSubjectConfigBody- Databases
Update Kafka Schema Subject Config Response DatabasesUpdateKafkaSchemaSubjectConfigResponse- Databases
Update Kafka Topic Body DatabasesUpdateKafkaTopicBody- Databases
Update Kafka Topic Body Config DatabasesUpdateKafkaTopicBodyConfig- Databases
Update Kafka Topic Response DatabasesUpdateKafkaTopicResponse- Databases
Update Kafka Topic Response Topic DatabasesUpdateKafkaTopicResponseTopic- Databases
Update Kafka Topic Response Topic Config DatabasesUpdateKafkaTopicResponseTopicConfig- Databases
Update Kafka Topic Response Topic Partitions Item DatabasesUpdateKafkaTopicResponseTopicPartitionsItem- Databases
Update Kafka Topic Response Topic Partitions Item Consumer Groups Item DatabasesUpdateKafkaTopicResponseTopicPartitionsItemConsumerGroupsItem- Databases
Update Logsink Body DatabasesUpdateLogsinkBody- Databases
Update Logsink Body Config DatabasesUpdateLogsinkBodyConfig- Databases
Update Logsink Body Config Subtype0 DatabasesUpdateLogsinkBodyConfigSubtype0- Databases
Update Logsink Body Config Subtype1 DatabasesUpdateLogsinkBodyConfigSubtype1- Databases
Update Logsink Body Config Subtype2 DatabasesUpdateLogsinkBodyConfigSubtype2- Databases
Update Logsink Body Config Subtype3 - Configuration for Datadog integration applicable only to MongoDB clusters.
- Databases
Update Maintenance Window Body DatabasesUpdateMaintenanceWindowBody- Databases
Update Major Version Body DatabasesUpdateMajorVersionBody- Databases
Update Online Migration Body DatabasesUpdateOnlineMigrationBody- Databases
Update Online Migration Body Source DatabasesUpdateOnlineMigrationBodySource- Databases
Update Online Migration Response DatabasesUpdateOnlineMigrationResponse- Databases
Update Region Body DatabasesUpdateRegionBody- Databases
Update SqlMode Body DatabasesUpdateSqlModeBody- Databases
Update User Body DatabasesUpdateUserBody- Databases
Update User Body Settings DatabasesUpdateUserBodySettings- Databases
Update User Body Settings AclItem DatabasesUpdateUserBodySettingsAclItem- Databases
Update User Body Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
Update User Body Settings Opensearch AclItem DatabasesUpdateUserBodySettingsOpensearchAclItem- Databases
Update User Response DatabasesUpdateUserResponse- Databases
Update User Response User DatabasesUpdateUserResponseUser- Databases
Update User Response User Mysql Settings DatabasesUpdateUserResponseUserMysqlSettings- Databases
Update User Response User Settings DatabasesUpdateUserResponseUserSettings- Databases
Update User Response User Settings AclItem DatabasesUpdateUserResponseUserSettingsAclItem- Databases
Update User Response User Settings Mongo User Settings - MongoDB-specific settings for the user. This option is not currently supported for other database engines.
- Databases
Update User Response User Settings Opensearch AclItem DatabasesUpdateUserResponseUserSettingsOpensearchAclItem- Dedicated
Inferences Create Body DedicatedInferencesCreateBody- Dedicated
Inferences Create Body Spec - Structured configuration for a Dedicated Inference deployment.
- Dedicated
Inferences Create Body Spec Model Deployments Item - Configuration for a single model deployment.
- Dedicated
Inferences Create Body Spec Name - Name of the Dedicated Inference. Must be unique within the team.
- Dedicated
Inferences Create Body Spec Vpc DedicatedInferencesCreateBodySpecVpc- Dedicated
Inferences Create Response DedicatedInferencesCreateResponse- Dedicated
Inferences Create Response Dedicated Inference - A Dedicated Inference instance.
- Dedicated
Inferences Create Response Dedicated Inference Endpoints DedicatedInferencesCreateResponseDedicatedInferenceEndpoints- Dedicated
Inferences Create Response Dedicated Inference Pending Deployment Spec - Pending deployment when status is provisioning or updating.
- Dedicated
Inferences Create Response Dedicated Inference Pending Deployment Spec Name - Name of the Dedicated Inference. Must be unique within the team.
- Dedicated
Inferences Create Response Dedicated Inference Pending Deployment Spec Vpc DedicatedInferencesCreateResponseDedicatedInferencePendingDeploymentSpecVpc- Dedicated
Inferences Create Response Dedicated Inference Spec - Structured configuration for a Dedicated Inference deployment.
- Dedicated
Inferences Create Response Dedicated Inference Spec Model Deployments Item - Configuration for a single model deployment.
- Dedicated
Inferences Create Response Dedicated Inference Spec Name - Name of the Dedicated Inference. Must be unique within the team.
- Dedicated
Inferences Create Response Dedicated Inference Spec Vpc DedicatedInferencesCreateResponseDedicatedInferenceSpecVpc- Dedicated
Inferences Create Response Token - Access token for authenticating to Dedicated Inference endpoints.
- Dedicated
Inferences Create Tokens Body DedicatedInferencesCreateTokensBody- Dedicated
Inferences Create Tokens Body Name - Name for the new token.
- Dedicated
Inferences Create Tokens Response DedicatedInferencesCreateTokensResponse- Dedicated
Inferences Create Tokens Response Token - Access token for authenticating to Dedicated Inference endpoints.
- Dedicated
Inferences GetAccelerator Response - A Dedicated Inference accelerator (GPU) in use by an instance.
- Dedicated
Inferences GetCa Response DedicatedInferencesGetCaResponse- Dedicated
Inferences GetGpu Model Config Response - Supported GPU and model configurations for Dedicated Inference.
- Dedicated
Inferences GetGpu Model Config Response GpuModel Configs Item DedicatedInferencesGetGpuModelConfigResponseGpuModelConfigsItem- Dedicated
Inferences GetResponse DedicatedInferencesGetResponse- Dedicated
Inferences GetResponse Dedicated Inference - A Dedicated Inference instance.
- Dedicated
Inferences GetResponse Dedicated Inference Endpoints DedicatedInferencesGetResponseDedicatedInferenceEndpoints- Dedicated
Inferences GetResponse Dedicated Inference Pending Deployment Spec - Pending deployment when status is provisioning or updating.
- Dedicated
Inferences GetResponse Dedicated Inference Pending Deployment Spec Name - Name of the Dedicated Inference. Must be unique within the team.
- Dedicated
Inferences GetResponse Dedicated Inference Pending Deployment Spec Vpc DedicatedInferencesGetResponseDedicatedInferencePendingDeploymentSpecVpc- Dedicated
Inferences GetResponse Dedicated Inference Spec - Structured configuration for a Dedicated Inference deployment.
- Dedicated
Inferences GetResponse Dedicated Inference Spec Model Deployments Item - Configuration for a single model deployment.
- Dedicated
Inferences GetResponse Dedicated Inference Spec Name - Name of the Dedicated Inference. Must be unique within the team.
- Dedicated
Inferences GetResponse Dedicated Inference Spec Vpc DedicatedInferencesGetResponseDedicatedInferenceSpecVpc- Dedicated
Inferences List Accelerators Response DedicatedInferencesListAcceleratorsResponse- Dedicated
Inferences List Accelerators Response Accelerators Item - A Dedicated Inference accelerator (GPU) in use by an instance.
- Dedicated
Inferences List Accelerators Response Links DedicatedInferencesListAcceleratorsResponseLinks- Dedicated
Inferences List Accelerators Response Links Pages DedicatedInferencesListAcceleratorsResponseLinksPages- Dedicated
Inferences List Accelerators Response Links Pages Subtype0 DedicatedInferencesListAcceleratorsResponseLinksPagesSubtype0- Dedicated
Inferences List Accelerators Response Links Pages Subtype1 DedicatedInferencesListAcceleratorsResponseLinksPagesSubtype1- Dedicated
Inferences List Accelerators Response Meta DedicatedInferencesListAcceleratorsResponseMeta- Dedicated
Inferences List Response DedicatedInferencesListResponse- Dedicated
Inferences List Response Dedicated Inferences Item - A Dedicated Inference instance.
- Dedicated
Inferences List Response Dedicated Inferences Item Endpoints DedicatedInferencesListResponseDedicatedInferencesItemEndpoints- Dedicated
Inferences List Response Dedicated Inferences Item Pending Deployment Spec - Pending deployment when status is provisioning or updating.
- Dedicated
Inferences List Response Dedicated Inferences Item Pending Deployment Spec Name - Name of the Dedicated Inference. Must be unique within the team.
- Dedicated
Inferences List Response Dedicated Inferences Item Pending Deployment Spec Vpc DedicatedInferencesListResponseDedicatedInferencesItemPendingDeploymentSpecVpc- Dedicated
Inferences List Response Dedicated Inferences Item Spec - Structured configuration for a Dedicated Inference deployment.
- Dedicated
Inferences List Response Dedicated Inferences Item Spec Model Deployments Item - Configuration for a single model deployment.
- Dedicated
Inferences List Response Dedicated Inferences Item Spec Name - Name of the Dedicated Inference. Must be unique within the team.
- Dedicated
Inferences List Response Dedicated Inferences Item Spec Vpc DedicatedInferencesListResponseDedicatedInferencesItemSpecVpc- Dedicated
Inferences List Response Links DedicatedInferencesListResponseLinks- Dedicated
Inferences List Response Meta DedicatedInferencesListResponseMeta- Dedicated
Inferences List Sizes Response - Available Dedicated Inference sizes and pricing.
- Dedicated
Inferences List Sizes Response Sizes Item DedicatedInferencesListSizesResponseSizesItem- Dedicated
Inferences List Tokens Response DedicatedInferencesListTokensResponse- Dedicated
Inferences List Tokens Response Links DedicatedInferencesListTokensResponseLinks- Dedicated
Inferences List Tokens Response Links Pages DedicatedInferencesListTokensResponseLinksPages- Dedicated
Inferences List Tokens Response Links Pages Subtype0 DedicatedInferencesListTokensResponseLinksPagesSubtype0- Dedicated
Inferences List Tokens Response Links Pages Subtype1 DedicatedInferencesListTokensResponseLinksPagesSubtype1- Dedicated
Inferences List Tokens Response Meta DedicatedInferencesListTokensResponseMeta- Dedicated
Inferences List Tokens Response Tokens Item - Access token for authenticating to Dedicated Inference endpoints.
- Dedicated
Inferences Patch Body DedicatedInferencesPatchBody- Dedicated
Inferences Patch Body Access Tokens - Provider tokens for model access (e.g. gated Hugging Face models).
- Dedicated
Inferences Patch Body Spec - Structured configuration for a Dedicated Inference deployment.
- Dedicated
Inferences Patch Body Spec Model Deployments Item - Configuration for a single model deployment.
- Dedicated
Inferences Patch Body Spec Name - Name of the Dedicated Inference. Must be unique within the team.
- Dedicated
Inferences Patch Body Spec Vpc DedicatedInferencesPatchBodySpecVpc- Dedicated
Inferences Patch Response DedicatedInferencesPatchResponse- Dedicated
Inferences Patch Response Dedicated Inference - A Dedicated Inference instance.
- Dedicated
Inferences Patch Response Dedicated Inference Endpoints DedicatedInferencesPatchResponseDedicatedInferenceEndpoints- Dedicated
Inferences Patch Response Dedicated Inference Pending Deployment Spec - Pending deployment when status is provisioning or updating.
- Dedicated
Inferences Patch Response Dedicated Inference Pending Deployment Spec Name - Name of the Dedicated Inference. Must be unique within the team.
- Dedicated
Inferences Patch Response Dedicated Inference Pending Deployment Spec Vpc DedicatedInferencesPatchResponseDedicatedInferencePendingDeploymentSpecVpc- Dedicated
Inferences Patch Response Dedicated Inference Spec - Structured configuration for a Dedicated Inference deployment.
- Dedicated
Inferences Patch Response Dedicated Inference Spec Model Deployments Item - Configuration for a single model deployment.
- Dedicated
Inferences Patch Response Dedicated Inference Spec Name - Name of the Dedicated Inference. Must be unique within the team.
- Dedicated
Inferences Patch Response Dedicated Inference Spec Vpc DedicatedInferencesPatchResponseDedicatedInferenceSpecVpc- Dimensions
Item DimensionsItem- Domains
Create Body DomainsCreateBody- Domains
Create Record Body DomainsCreateRecordBody- Domains
Create Record Body Subtype0 DomainsCreateRecordBodySubtype0- Domains
Create Record Body Subtype1 DomainsCreateRecordBodySubtype1- Domains
Create Record Body Subtype2 DomainsCreateRecordBodySubtype2- Domains
Create Record Body Subtype3 DomainsCreateRecordBodySubtype3- Domains
Create Record Body Subtype4 DomainsCreateRecordBodySubtype4- Domains
Create Record Body Subtype5 DomainsCreateRecordBodySubtype5- Domains
Create Record Body Subtype6 DomainsCreateRecordBodySubtype6- Domains
Create Record Body Subtype7 DomainsCreateRecordBodySubtype7- Domains
Create Record Body Subtype8 DomainsCreateRecordBodySubtype8- Domains
Create Record Response DomainsCreateRecordResponse- Domains
Create Record Response Domain Record DomainsCreateRecordResponseDomainRecord- Domains
Create Response DomainsCreateResponse- Domains
Create Response Domain DomainsCreateResponseDomain- Domains
GetRecord Response DomainsGetRecordResponse- Domains
GetRecord Response Domain Record DomainsGetRecordResponseDomainRecord- Domains
GetResponse DomainsGetResponse- Domains
GetResponse Domain DomainsGetResponseDomain- Domains
List Records Response DomainsListRecordsResponse- Domains
List Records Response Domain Records Item DomainsListRecordsResponseDomainRecordsItem- Domains
List Records Response Links DomainsListRecordsResponseLinks- Domains
List Records Response Links Pages DomainsListRecordsResponseLinksPages- Domains
List Records Response Links Pages Subtype0 DomainsListRecordsResponseLinksPagesSubtype0- Domains
List Records Response Links Pages Subtype1 DomainsListRecordsResponseLinksPagesSubtype1- Domains
List Records Response Meta DomainsListRecordsResponseMeta- Domains
List Response DomainsListResponse- Domains
List Response Domains Item DomainsListResponseDomainsItem- Domains
List Response Links DomainsListResponseLinks- Domains
List Response Links Pages DomainsListResponseLinksPages- Domains
List Response Links Pages Subtype0 DomainsListResponseLinksPagesSubtype0- Domains
List Response Links Pages Subtype1 DomainsListResponseLinksPagesSubtype1- Domains
List Response Meta DomainsListResponseMeta- Domains
Patch Record Body DomainsPatchRecordBody- Domains
Patch Record Response DomainsPatchRecordResponse- Domains
Patch Record Response Domain Record DomainsPatchRecordResponseDomainRecord- Domains
Update Record Body DomainsUpdateRecordBody- Domains
Update Record Response DomainsUpdateRecordResponse- Domains
Update Record Response Domain Record DomainsUpdateRecordResponseDomainRecord- Droplet
Actions GetResponse DropletActionsGetResponse- Droplet
Actions GetResponse Action DropletActionsGetResponseAction- Droplet
Actions GetResponse Action Region DropletActionsGetResponseActionRegion- Droplet
Actions List Response DropletActionsListResponse- Droplet
Actions List Response Actions Item DropletActionsListResponseActionsItem- Droplet
Actions List Response Actions Item Region DropletActionsListResponseActionsItemRegion- Droplet
Actions List Response Links DropletActionsListResponseLinks- Droplet
Actions List Response Links Pages DropletActionsListResponseLinksPages- Droplet
Actions List Response Links Pages Subtype0 DropletActionsListResponseLinksPagesSubtype0- Droplet
Actions List Response Links Pages Subtype1 DropletActionsListResponseLinksPagesSubtype1- Droplet
Actions List Response Meta DropletActionsListResponseMeta- Droplet
Actions Post Body DropletActionsPostBody- Droplet
Actions Post Body Subtype0 - Specifies the action that will be taken on the Droplet.
- Droplet
Actions Post Body Subtype1 DropletActionsPostBodySubtype1- Droplet
Actions Post Body Subtype2 DropletActionsPostBodySubtype2- Droplet
Actions Post Body Subtype3 DropletActionsPostBodySubtype3- Droplet
Actions Post Body Subtype4 DropletActionsPostBodySubtype4- Droplet
Actions Post Body Subtype5 DropletActionsPostBodySubtype5- Droplet
Actions Post Body Subtype6 DropletActionsPostBodySubtype6- Droplet
Actions Post Body Subtype7 DropletActionsPostBodySubtype7- Droplet
Actions Post Body Subtype8 DropletActionsPostBodySubtype8- Droplet
Actions Post Body Subtype1 Backup Policy DropletActionsPostBodySubtype1BackupPolicy- Droplet
Actions Post Body Subtype1 Backup Policy Hour - The hour of the day that the backup window will start.
- Droplet
Actions Post Body Subtype2 Backup Policy DropletActionsPostBodySubtype2BackupPolicy- Droplet
Actions Post Body Subtype2 Backup Policy Hour - The hour of the day that the backup window will start.
- Droplet
Actions Post ByTag Response DropletActionsPostByTagResponse- Droplet
Actions Post ByTag Response Actions Item DropletActionsPostByTagResponseActionsItem- Droplet
Actions Post ByTag Response Actions Item Region DropletActionsPostByTagResponseActionsItemRegion- Droplet
Actions Post Response DropletActionsPostResponse- Droplet
Actions Post Response Action DropletActionsPostResponseAction- Droplet
Actions Post Response Action Region DropletActionsPostResponseActionRegion- Droplets
Destroy With Associated Resources Selective Body - An object containing information about a resource to be scheduled for deletion.
- Droplets
GetBackup Policy Response DropletsGetBackupPolicyResponse- Droplets
GetBackup Policy Response Policy DropletsGetBackupPolicyResponsePolicy- Droplets
GetBackup Policy Response Policy Backup Policy DropletsGetBackupPolicyResponsePolicyBackupPolicy- Droplets
GetBackup Policy Response Policy Backup Policy Hour - The hour of the day that the backup window will start.
- Droplets
GetBackup Policy Response Policy Next Backup Window DropletsGetBackupPolicyResponsePolicyNextBackupWindow- Droplets
GetDestroy Associated Resources Status Response - An objects containing information about a resources scheduled for deletion.
- Droplets
GetDestroy Associated Resources Status Response Droplet - An object containing information about a resource scheduled for deletion.
- Droplets
GetDestroy Associated Resources Status Response Resources - An object containing additional information about resource related to a Droplet requested to be destroyed.
- Droplets
GetDestroy Associated Resources Status Response Resources Floating IpsItem - An object containing information about a resource scheduled for deletion.
- Droplets
GetDestroy Associated Resources Status Response Resources Reserved IpsItem - An object containing information about a resource scheduled for deletion.
- Droplets
GetDestroy Associated Resources Status Response Resources Snapshots Item - An object containing information about a resource scheduled for deletion.
- Droplets
GetDestroy Associated Resources Status Response Resources Volume Snapshots Item - An object containing information about a resource scheduled for deletion.
- Droplets
GetDestroy Associated Resources Status Response Resources Volumes Item - An object containing information about a resource scheduled for deletion.
- Droplets
GetResponse DropletsGetResponse- Droplets
GetResponse Droplet DropletsGetResponseDroplet- Droplets
GetResponse Droplet Disk Info Item DropletsGetResponseDropletDiskInfoItem- Droplets
GetResponse Droplet Disk Info Item Size DropletsGetResponseDropletDiskInfoItemSize- Droplets
GetResponse Droplet GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Droplets
GetResponse Droplet GpuInfo Vram DropletsGetResponseDropletGpuInfoVram- Droplets
GetResponse Droplet Image DropletsGetResponseDropletImage- Droplets
GetResponse Droplet Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - Droplets
GetResponse Droplet Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- Droplets
GetResponse Droplet Networks V4Item DropletsGetResponseDropletNetworksV4Item- Droplets
GetResponse Droplet Networks V6Item DropletsGetResponseDropletNetworksV6Item- Droplets
GetResponse Droplet Next Backup Window DropletsGetResponseDropletNextBackupWindow- Droplets
GetResponse Droplet Region DropletsGetResponseDropletRegion- Droplets
GetResponse Droplet Size DropletsGetResponseDropletSize- Droplets
GetResponse Droplet Size Disk Info Item DropletsGetResponseDropletSizeDiskInfoItem- Droplets
GetResponse Droplet Size Disk Info Item Size DropletsGetResponseDropletSizeDiskInfoItemSize- Droplets
GetResponse Droplet Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Droplets
GetResponse Droplet Size GpuInfo Vram DropletsGetResponseDropletSizeGpuInfoVram- Droplets
List Associated Resources Response DropletsListAssociatedResourcesResponse- Droplets
List Associated Resources Response Floating IpsItem - An objects containing information about a resource associated with a Droplet.
- Droplets
List Associated Resources Response Reserved IpsItem - An objects containing information about a resource associated with a Droplet.
- Droplets
List Associated Resources Response Snapshots Item - An objects containing information about a resource associated with a Droplet.
- Droplets
List Associated Resources Response Volume Snapshots Item - An objects containing information about a resource associated with a Droplet.
- Droplets
List Associated Resources Response Volumes Item - An objects containing information about a resource associated with a Droplet.
- Droplets
List Backup Policies Response DropletsListBackupPoliciesResponse- Droplets
List Backup Policies Response Links DropletsListBackupPoliciesResponseLinks- Droplets
List Backup Policies Response Links Pages DropletsListBackupPoliciesResponseLinksPages- Droplets
List Backup Policies Response Links Pages Subtype0 DropletsListBackupPoliciesResponseLinksPagesSubtype0- Droplets
List Backup Policies Response Links Pages Subtype1 DropletsListBackupPoliciesResponseLinksPagesSubtype1- Droplets
List Backup Policies Response Meta DropletsListBackupPoliciesResponseMeta- Droplets
List Backup Policies Response Policies Value DropletsListBackupPoliciesResponsePoliciesValue- Droplets
List Backup Policies Response Policies Value Backup Policy DropletsListBackupPoliciesResponsePoliciesValueBackupPolicy- Droplets
List Backup Policies Response Policies Value Backup Policy Hour - The hour of the day that the backup window will start.
- Droplets
List Backup Policies Response Policies Value Next Backup Window DropletsListBackupPoliciesResponsePoliciesValueNextBackupWindow- Droplets
List Backups Response DropletsListBackupsResponse- Droplets
List Backups Response Backups Item DropletsListBackupsResponseBackupsItem- Droplets
List Backups Response Links DropletsListBackupsResponseLinks- Droplets
List Backups Response Links Pages DropletsListBackupsResponseLinksPages- Droplets
List Backups Response Links Pages Subtype0 DropletsListBackupsResponseLinksPagesSubtype0- Droplets
List Backups Response Links Pages Subtype1 DropletsListBackupsResponseLinksPagesSubtype1- Droplets
List Backups Response Meta DropletsListBackupsResponseMeta- Droplets
List Firewalls Response DropletsListFirewallsResponse- Droplets
List Firewalls Response Firewalls Item DropletsListFirewallsResponseFirewallsItem- Droplets
List Firewalls Response Firewalls Item Inbound Rules Item DropletsListFirewallsResponseFirewallsItemInboundRulesItem- Droplets
List Firewalls Response Firewalls Item Inbound Rules Item Sources DropletsListFirewallsResponseFirewallsItemInboundRulesItemSources- Droplets
List Firewalls Response Firewalls Item Name - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
- Droplets
List Firewalls Response Firewalls Item Outbound Rules Item DropletsListFirewallsResponseFirewallsItemOutboundRulesItem- Droplets
List Firewalls Response Firewalls Item Outbound Rules Item Destinations DropletsListFirewallsResponseFirewallsItemOutboundRulesItemDestinations- Droplets
List Firewalls Response Firewalls Item Pending Changes Item DropletsListFirewallsResponseFirewallsItemPendingChangesItem- Droplets
List Firewalls Response Links DropletsListFirewallsResponseLinks- Droplets
List Firewalls Response Links Pages DropletsListFirewallsResponseLinksPages- Droplets
List Firewalls Response Links Pages Subtype0 DropletsListFirewallsResponseLinksPagesSubtype0- Droplets
List Firewalls Response Links Pages Subtype1 DropletsListFirewallsResponseLinksPagesSubtype1- Droplets
List Firewalls Response Meta DropletsListFirewallsResponseMeta- Droplets
List Kernels Response DropletsListKernelsResponse- Droplets
List Kernels Response Kernels Item - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - Droplets
List Kernels Response Links DropletsListKernelsResponseLinks- Droplets
List Kernels Response Links Pages DropletsListKernelsResponseLinksPages- Droplets
List Kernels Response Links Pages Subtype0 DropletsListKernelsResponseLinksPagesSubtype0- Droplets
List Kernels Response Links Pages Subtype1 DropletsListKernelsResponseLinksPagesSubtype1- Droplets
List Kernels Response Meta DropletsListKernelsResponseMeta- Droplets
List Neighbors IdsResponse DropletsListNeighborsIdsResponse- Droplets
List Neighbors Response DropletsListNeighborsResponse- Droplets
List Neighbors Response Droplets Item DropletsListNeighborsResponseDropletsItem- Droplets
List Neighbors Response Droplets Item Disk Info Item DropletsListNeighborsResponseDropletsItemDiskInfoItem- Droplets
List Neighbors Response Droplets Item Disk Info Item Size DropletsListNeighborsResponseDropletsItemDiskInfoItemSize- Droplets
List Neighbors Response Droplets Item GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Droplets
List Neighbors Response Droplets Item GpuInfo Vram DropletsListNeighborsResponseDropletsItemGpuInfoVram- Droplets
List Neighbors Response Droplets Item Image DropletsListNeighborsResponseDropletsItemImage- Droplets
List Neighbors Response Droplets Item Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - Droplets
List Neighbors Response Droplets Item Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- Droplets
List Neighbors Response Droplets Item Networks V4Item DropletsListNeighborsResponseDropletsItemNetworksV4Item- Droplets
List Neighbors Response Droplets Item Networks V6Item DropletsListNeighborsResponseDropletsItemNetworksV6Item- Droplets
List Neighbors Response Droplets Item Next Backup Window DropletsListNeighborsResponseDropletsItemNextBackupWindow- Droplets
List Neighbors Response Droplets Item Region DropletsListNeighborsResponseDropletsItemRegion- Droplets
List Neighbors Response Droplets Item Size DropletsListNeighborsResponseDropletsItemSize- Droplets
List Neighbors Response Droplets Item Size Disk Info Item DropletsListNeighborsResponseDropletsItemSizeDiskInfoItem- Droplets
List Neighbors Response Droplets Item Size Disk Info Item Size DropletsListNeighborsResponseDropletsItemSizeDiskInfoItemSize- Droplets
List Neighbors Response Droplets Item Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Droplets
List Neighbors Response Droplets Item Size GpuInfo Vram DropletsListNeighborsResponseDropletsItemSizeGpuInfoVram- Droplets
List Response DropletsListResponse- Droplets
List Response Droplets Item DropletsListResponseDropletsItem- Droplets
List Response Droplets Item Disk Info Item DropletsListResponseDropletsItemDiskInfoItem- Droplets
List Response Droplets Item Disk Info Item Size DropletsListResponseDropletsItemDiskInfoItemSize- Droplets
List Response Droplets Item GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Droplets
List Response Droplets Item GpuInfo Vram DropletsListResponseDropletsItemGpuInfoVram- Droplets
List Response Droplets Item Image DropletsListResponseDropletsItemImage- Droplets
List Response Droplets Item Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - Droplets
List Response Droplets Item Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- Droplets
List Response Droplets Item Networks V4Item DropletsListResponseDropletsItemNetworksV4Item- Droplets
List Response Droplets Item Networks V6Item DropletsListResponseDropletsItemNetworksV6Item- Droplets
List Response Droplets Item Next Backup Window DropletsListResponseDropletsItemNextBackupWindow- Droplets
List Response Droplets Item Region DropletsListResponseDropletsItemRegion- Droplets
List Response Droplets Item Size DropletsListResponseDropletsItemSize- Droplets
List Response Droplets Item Size Disk Info Item DropletsListResponseDropletsItemSizeDiskInfoItem- Droplets
List Response Droplets Item Size Disk Info Item Size DropletsListResponseDropletsItemSizeDiskInfoItemSize- Droplets
List Response Droplets Item Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Droplets
List Response Droplets Item Size GpuInfo Vram DropletsListResponseDropletsItemSizeGpuInfoVram- Droplets
List Response Links DropletsListResponseLinks- Droplets
List Response Links Pages DropletsListResponseLinksPages- Droplets
List Response Links Pages Subtype0 DropletsListResponseLinksPagesSubtype0- Droplets
List Response Links Pages Subtype1 DropletsListResponseLinksPagesSubtype1- Droplets
List Response Meta DropletsListResponseMeta- Droplets
List Snapshots Response DropletsListSnapshotsResponse- Droplets
List Snapshots Response Links DropletsListSnapshotsResponseLinks- Droplets
List Snapshots Response Links Pages DropletsListSnapshotsResponseLinksPages- Droplets
List Snapshots Response Links Pages Subtype0 DropletsListSnapshotsResponseLinksPagesSubtype0- Droplets
List Snapshots Response Links Pages Subtype1 DropletsListSnapshotsResponseLinksPagesSubtype1- Droplets
List Snapshots Response Meta DropletsListSnapshotsResponseMeta- Droplets
List Snapshots Response Snapshots Item DropletsListSnapshotsResponseSnapshotsItem- Droplets
List Supported Backup Policies Response DropletsListSupportedBackupPoliciesResponse- Droplets
List Supported Backup Policies Response Supported Policies Item DropletsListSupportedBackupPoliciesResponseSupportedPoliciesItem- Features
Item FeaturesItem- Findings
Item - The results of the scan.
- Firewalls
AddRules Body Variant0 Inbound Rules Item FirewallsAddRulesBodyVariant0InboundRulesItem- Firewalls
AddRules Body Variant0 Inbound Rules Item Sources FirewallsAddRulesBodyVariant0InboundRulesItemSources- Firewalls
AddRules Body Variant1 Outbound Rules Item FirewallsAddRulesBodyVariant1OutboundRulesItem- Firewalls
AddRules Body Variant1 Outbound Rules Item Destinations FirewallsAddRulesBodyVariant1OutboundRulesItemDestinations- Firewalls
AddTags Body FirewallsAddTagsBody- Firewalls
Assign Droplets Body FirewallsAssignDropletsBody- Firewalls
Create Body Variant0 Inbound Rules Item FirewallsCreateBodyVariant0InboundRulesItem- Firewalls
Create Body Variant0 Inbound Rules Item Sources FirewallsCreateBodyVariant0InboundRulesItemSources- Firewalls
Create Body Variant0 Name - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
- Firewalls
Create Body Variant0 Pending Changes Item FirewallsCreateBodyVariant0PendingChangesItem- Firewalls
Create Body Variant1 Name - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
- Firewalls
Create Body Variant1 Outbound Rules Item FirewallsCreateBodyVariant1OutboundRulesItem- Firewalls
Create Body Variant1 Outbound Rules Item Destinations FirewallsCreateBodyVariant1OutboundRulesItemDestinations- Firewalls
Create Body Variant1 Pending Changes Item FirewallsCreateBodyVariant1PendingChangesItem- Firewalls
Create Response FirewallsCreateResponse- Firewalls
Create Response Firewall FirewallsCreateResponseFirewall- Firewalls
Create Response Firewall Inbound Rules Item FirewallsCreateResponseFirewallInboundRulesItem- Firewalls
Create Response Firewall Inbound Rules Item Sources FirewallsCreateResponseFirewallInboundRulesItemSources- Firewalls
Create Response Firewall Name - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
- Firewalls
Create Response Firewall Outbound Rules Item FirewallsCreateResponseFirewallOutboundRulesItem- Firewalls
Create Response Firewall Outbound Rules Item Destinations FirewallsCreateResponseFirewallOutboundRulesItemDestinations- Firewalls
Create Response Firewall Pending Changes Item FirewallsCreateResponseFirewallPendingChangesItem- Firewalls
Delete Droplets Body FirewallsDeleteDropletsBody- Firewalls
Delete Rules Body Variant0 Inbound Rules Item FirewallsDeleteRulesBodyVariant0InboundRulesItem- Firewalls
Delete Rules Body Variant0 Inbound Rules Item Sources FirewallsDeleteRulesBodyVariant0InboundRulesItemSources- Firewalls
Delete Rules Body Variant1 Outbound Rules Item FirewallsDeleteRulesBodyVariant1OutboundRulesItem- Firewalls
Delete Rules Body Variant1 Outbound Rules Item Destinations FirewallsDeleteRulesBodyVariant1OutboundRulesItemDestinations- Firewalls
Delete Tags Body FirewallsDeleteTagsBody- Firewalls
GetResponse FirewallsGetResponse- Firewalls
GetResponse Firewall FirewallsGetResponseFirewall- Firewalls
GetResponse Firewall Inbound Rules Item FirewallsGetResponseFirewallInboundRulesItem- Firewalls
GetResponse Firewall Inbound Rules Item Sources FirewallsGetResponseFirewallInboundRulesItemSources- Firewalls
GetResponse Firewall Name - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
- Firewalls
GetResponse Firewall Outbound Rules Item FirewallsGetResponseFirewallOutboundRulesItem- Firewalls
GetResponse Firewall Outbound Rules Item Destinations FirewallsGetResponseFirewallOutboundRulesItemDestinations- Firewalls
GetResponse Firewall Pending Changes Item FirewallsGetResponseFirewallPendingChangesItem- Firewalls
List Response FirewallsListResponse- Firewalls
List Response Firewalls Item FirewallsListResponseFirewallsItem- Firewalls
List Response Firewalls Item Inbound Rules Item FirewallsListResponseFirewallsItemInboundRulesItem- Firewalls
List Response Firewalls Item Inbound Rules Item Sources FirewallsListResponseFirewallsItemInboundRulesItemSources- Firewalls
List Response Firewalls Item Name - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
- Firewalls
List Response Firewalls Item Outbound Rules Item FirewallsListResponseFirewallsItemOutboundRulesItem- Firewalls
List Response Firewalls Item Outbound Rules Item Destinations FirewallsListResponseFirewallsItemOutboundRulesItemDestinations- Firewalls
List Response Firewalls Item Pending Changes Item FirewallsListResponseFirewallsItemPendingChangesItem- Firewalls
List Response Links FirewallsListResponseLinks- Firewalls
List Response Links Pages FirewallsListResponseLinksPages- Firewalls
List Response Links Pages Subtype0 FirewallsListResponseLinksPagesSubtype0- Firewalls
List Response Links Pages Subtype1 FirewallsListResponseLinksPagesSubtype1- Firewalls
List Response Meta FirewallsListResponseMeta- Firewalls
Update Body Variant0 Inbound Rules Item FirewallsUpdateBodyVariant0InboundRulesItem- Firewalls
Update Body Variant0 Inbound Rules Item Sources FirewallsUpdateBodyVariant0InboundRulesItemSources- Firewalls
Update Body Variant0 Name - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
- Firewalls
Update Body Variant0 Pending Changes Item FirewallsUpdateBodyVariant0PendingChangesItem- Firewalls
Update Body Variant1 Name - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
- Firewalls
Update Body Variant1 Outbound Rules Item FirewallsUpdateBodyVariant1OutboundRulesItem- Firewalls
Update Body Variant1 Outbound Rules Item Destinations FirewallsUpdateBodyVariant1OutboundRulesItemDestinations- Firewalls
Update Body Variant1 Pending Changes Item FirewallsUpdateBodyVariant1PendingChangesItem- Firewalls
Update Response FirewallsUpdateResponse- Firewalls
Update Response Firewall FirewallsUpdateResponseFirewall- Firewalls
Update Response Firewall Inbound Rules Item FirewallsUpdateResponseFirewallInboundRulesItem- Firewalls
Update Response Firewall Inbound Rules Item Sources FirewallsUpdateResponseFirewallInboundRulesItemSources- Firewalls
Update Response Firewall Name - A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
- Firewalls
Update Response Firewall Outbound Rules Item FirewallsUpdateResponseFirewallOutboundRulesItem- Firewalls
Update Response Firewall Outbound Rules Item Destinations FirewallsUpdateResponseFirewallOutboundRulesItemDestinations- Firewalls
Update Response Firewall Pending Changes Item FirewallsUpdateResponseFirewallPendingChangesItem- FloatingI
PsAction GetResponse FloatingIPsActionGetResponse- FloatingI
PsAction GetResponse Action FloatingIPsActionGetResponseAction- FloatingI
PsAction GetResponse Action Region FloatingIPsActionGetResponseActionRegion- FloatingI
PsAction List Response FloatingIPsActionListResponse- FloatingI
PsAction List Response Actions Item FloatingIPsActionListResponseActionsItem- FloatingI
PsAction List Response Actions Item Region FloatingIPsActionListResponseActionsItemRegion- FloatingI
PsAction List Response Links FloatingIPsActionListResponseLinks- FloatingI
PsAction List Response Links Pages FloatingIPsActionListResponseLinksPages- FloatingI
PsAction List Response Links Pages Subtype0 FloatingIPsActionListResponseLinksPagesSubtype0- FloatingI
PsAction List Response Links Pages Subtype1 FloatingIPsActionListResponseLinksPagesSubtype1- FloatingI
PsAction List Response Meta FloatingIPsActionListResponseMeta- FloatingI
PsAction Post Response FloatingIPsActionPostResponse- FloatingI
PsAction Post Response Action FloatingIPsActionPostResponseAction- FloatingI
PsAction Post Response Action Region FloatingIPsActionPostResponseActionRegion- FloatingI
PsCreate Response FloatingIPsCreateResponse- FloatingI
PsCreate Response Floating Ip FloatingIPsCreateResponseFloatingIp- FloatingI
PsCreate Response Floating IpDroplet - The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.
Requiresdroplet:readscope. - FloatingI
PsCreate Response Floating IpDroplet Subtype1 FloatingIPsCreateResponseFloatingIpDropletSubtype1- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Disk Info Item FloatingIPsCreateResponseFloatingIpDropletSubtype1DiskInfoItem- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Disk Info Item Size FloatingIPsCreateResponseFloatingIpDropletSubtype1DiskInfoItemSize- FloatingI
PsCreate Response Floating IpDroplet Subtype1 GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- FloatingI
PsCreate Response Floating IpDroplet Subtype1 GpuInfo Vram FloatingIPsCreateResponseFloatingIpDropletSubtype1GpuInfoVram- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Image FloatingIPsCreateResponseFloatingIpDropletSubtype1Image- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - FloatingI
PsCreate Response Floating IpDroplet Subtype1 Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Networks V4Item FloatingIPsCreateResponseFloatingIpDropletSubtype1NetworksV4Item- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Networks V6Item FloatingIPsCreateResponseFloatingIpDropletSubtype1NetworksV6Item- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Next Backup Window FloatingIPsCreateResponseFloatingIpDropletSubtype1NextBackupWindow- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Region FloatingIPsCreateResponseFloatingIpDropletSubtype1Region- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Size FloatingIPsCreateResponseFloatingIpDropletSubtype1Size- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Size Disk Info Item FloatingIPsCreateResponseFloatingIpDropletSubtype1SizeDiskInfoItem- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Size Disk Info Item Size FloatingIPsCreateResponseFloatingIpDropletSubtype1SizeDiskInfoItemSize- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Size GpuInfo Vram FloatingIPsCreateResponseFloatingIpDropletSubtype1SizeGpuInfoVram- FloatingI
PsCreate Response Floating IpRegion FloatingIPsCreateResponseFloatingIpRegion- FloatingI
PsCreate Response Links FloatingIPsCreateResponseLinks- FloatingI
PsCreate Response Links Actions Item - The linked actions can be used to check the status of a Droplet’s create event.
- FloatingI
PsCreate Response Links Droplets Item - The linked actions can be used to check the status of a Droplet’s create event.
- FloatingI
PsGet Response FloatingIPsGetResponse- FloatingI
PsGet Response Floating Ip FloatingIPsGetResponseFloatingIp- FloatingI
PsGet Response Floating IpDroplet - The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.
Requiresdroplet:readscope. - FloatingI
PsGet Response Floating IpDroplet Subtype1 FloatingIPsGetResponseFloatingIpDropletSubtype1- FloatingI
PsGet Response Floating IpDroplet Subtype1 Disk Info Item FloatingIPsGetResponseFloatingIpDropletSubtype1DiskInfoItem- FloatingI
PsGet Response Floating IpDroplet Subtype1 Disk Info Item Size FloatingIPsGetResponseFloatingIpDropletSubtype1DiskInfoItemSize- FloatingI
PsGet Response Floating IpDroplet Subtype1 GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- FloatingI
PsGet Response Floating IpDroplet Subtype1 GpuInfo Vram FloatingIPsGetResponseFloatingIpDropletSubtype1GpuInfoVram- FloatingI
PsGet Response Floating IpDroplet Subtype1 Image FloatingIPsGetResponseFloatingIpDropletSubtype1Image- FloatingI
PsGet Response Floating IpDroplet Subtype1 Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - FloatingI
PsGet Response Floating IpDroplet Subtype1 Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- FloatingI
PsGet Response Floating IpDroplet Subtype1 Networks V4Item FloatingIPsGetResponseFloatingIpDropletSubtype1NetworksV4Item- FloatingI
PsGet Response Floating IpDroplet Subtype1 Networks V6Item FloatingIPsGetResponseFloatingIpDropletSubtype1NetworksV6Item- FloatingI
PsGet Response Floating IpDroplet Subtype1 Next Backup Window FloatingIPsGetResponseFloatingIpDropletSubtype1NextBackupWindow- FloatingI
PsGet Response Floating IpDroplet Subtype1 Region FloatingIPsGetResponseFloatingIpDropletSubtype1Region- FloatingI
PsGet Response Floating IpDroplet Subtype1 Size FloatingIPsGetResponseFloatingIpDropletSubtype1Size- FloatingI
PsGet Response Floating IpDroplet Subtype1 Size Disk Info Item FloatingIPsGetResponseFloatingIpDropletSubtype1SizeDiskInfoItem- FloatingI
PsGet Response Floating IpDroplet Subtype1 Size Disk Info Item Size FloatingIPsGetResponseFloatingIpDropletSubtype1SizeDiskInfoItemSize- FloatingI
PsGet Response Floating IpDroplet Subtype1 Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- FloatingI
PsGet Response Floating IpDroplet Subtype1 Size GpuInfo Vram FloatingIPsGetResponseFloatingIpDropletSubtype1SizeGpuInfoVram- FloatingI
PsGet Response Floating IpRegion FloatingIPsGetResponseFloatingIpRegion- FloatingI
PsList Response FloatingIPsListResponse- FloatingI
PsList Response Floating IpsItem FloatingIPsListResponseFloatingIpsItem- FloatingI
PsList Response Floating IpsItem Droplet - The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.
Requiresdroplet:readscope. - FloatingI
PsList Response Floating IpsItem Droplet Subtype1 FloatingIPsListResponseFloatingIpsItemDropletSubtype1- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Disk Info Item FloatingIPsListResponseFloatingIpsItemDropletSubtype1DiskInfoItem- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Disk Info Item Size FloatingIPsListResponseFloatingIpsItemDropletSubtype1DiskInfoItemSize- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 GpuInfo Vram FloatingIPsListResponseFloatingIpsItemDropletSubtype1GpuInfoVram- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Image FloatingIPsListResponseFloatingIpsItemDropletSubtype1Image- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Networks V4Item FloatingIPsListResponseFloatingIpsItemDropletSubtype1NetworksV4Item- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Networks V6Item FloatingIPsListResponseFloatingIpsItemDropletSubtype1NetworksV6Item- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Next Backup Window FloatingIPsListResponseFloatingIpsItemDropletSubtype1NextBackupWindow- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Region FloatingIPsListResponseFloatingIpsItemDropletSubtype1Region- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Size FloatingIPsListResponseFloatingIpsItemDropletSubtype1Size- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Size Disk Info Item FloatingIPsListResponseFloatingIpsItemDropletSubtype1SizeDiskInfoItem- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Size Disk Info Item Size FloatingIPsListResponseFloatingIpsItemDropletSubtype1SizeDiskInfoItemSize- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Size GpuInfo Vram FloatingIPsListResponseFloatingIpsItemDropletSubtype1SizeGpuInfoVram- FloatingI
PsList Response Floating IpsItem Region FloatingIPsListResponseFloatingIpsItemRegion- FloatingI
PsList Response Links FloatingIPsListResponseLinks- FloatingI
PsList Response Links Pages FloatingIPsListResponseLinksPages- FloatingI
PsList Response Links Pages Subtype0 FloatingIPsListResponseLinksPagesSubtype0- FloatingI
PsList Response Links Pages Subtype1 FloatingIPsListResponseLinksPagesSubtype1- FloatingI
PsList Response Meta FloatingIPsListResponseMeta- Functions
Access KeyCreate Body FunctionsAccessKeyCreateBody- Functions
Access KeyCreate Response FunctionsAccessKeyCreateResponse- Functions
Access KeyCreate Response Access Key FunctionsAccessKeyCreateResponseAccessKey- Functions
Access KeyList Response FunctionsAccessKeyListResponse- Functions
Access KeyList Response Access Keys Item FunctionsAccessKeyListResponseAccessKeysItem- Functions
Access KeyUpdate Body FunctionsAccessKeyUpdateBody- Functions
Access KeyUpdate Response FunctionsAccessKeyUpdateResponse- Functions
Access KeyUpdate Response Access Key FunctionsAccessKeyUpdateResponseAccessKey- Functions
Components That ArePart OfThis Deployment Item FunctionsComponentsThatArePartOfThisDeploymentItem- Functions
Create Namespace Body FunctionsCreateNamespaceBody- Functions
Create Namespace Response FunctionsCreateNamespaceResponse- Functions
Create Namespace Response Namespace FunctionsCreateNamespaceResponseNamespace- Functions
Create Trigger Body FunctionsCreateTriggerBody- Functions
Create Trigger Body Scheduled Details - Trigger details for SCHEDULED type, where body is optional.
- Functions
Create Trigger Body Scheduled Details Body - Optional data to be sent to function while triggering the function.
- Functions
Create Trigger Response FunctionsCreateTriggerResponse- Functions
Create Trigger Response Trigger FunctionsCreateTriggerResponseTrigger- Functions
Create Trigger Response Trigger Scheduled Details - Trigger details for SCHEDULED type, where body is optional.
- Functions
Create Trigger Response Trigger Scheduled Details Body - Optional data to be sent to function while triggering the function.
- Functions
Create Trigger Response Trigger Scheduled Runs FunctionsCreateTriggerResponseTriggerScheduledRuns- Functions
GetNamespace Response FunctionsGetNamespaceResponse- Functions
GetNamespace Response Namespace FunctionsGetNamespaceResponseNamespace- Functions
GetTrigger Response FunctionsGetTriggerResponse- Functions
GetTrigger Response Trigger FunctionsGetTriggerResponseTrigger- Functions
GetTrigger Response Trigger Scheduled Details - Trigger details for SCHEDULED type, where body is optional.
- Functions
GetTrigger Response Trigger Scheduled Details Body - Optional data to be sent to function while triggering the function.
- Functions
GetTrigger Response Trigger Scheduled Runs FunctionsGetTriggerResponseTriggerScheduledRuns- Functions
List Namespaces Response FunctionsListNamespacesResponse- Functions
List Namespaces Response Namespaces Item FunctionsListNamespacesResponseNamespacesItem- Functions
List Triggers Response FunctionsListTriggersResponse- Functions
List Triggers Response Triggers Item FunctionsListTriggersResponseTriggersItem- Functions
List Triggers Response Triggers Item Scheduled Details - Trigger details for SCHEDULED type, where body is optional.
- Functions
List Triggers Response Triggers Item Scheduled Details Body - Optional data to be sent to function while triggering the function.
- Functions
List Triggers Response Triggers Item Scheduled Runs FunctionsListTriggersResponseTriggersItemScheduledRuns- Functions
Update Trigger Body FunctionsUpdateTriggerBody- Functions
Update Trigger Body Scheduled Details - Trigger details for SCHEDULED type, where body is optional.
- Functions
Update Trigger Body Scheduled Details Body - Optional data to be sent to function while triggering the function.
- Functions
Update Trigger Response FunctionsUpdateTriggerResponse- Functions
Update Trigger Response Trigger FunctionsUpdateTriggerResponseTrigger- Functions
Update Trigger Response Trigger Scheduled Details - Trigger details for SCHEDULED type, where body is optional.
- Functions
Update Trigger Response Trigger Scheduled Details Body - Optional data to be sent to function while triggering the function.
- Functions
Update Trigger Response Trigger Scheduled Runs FunctionsUpdateTriggerResponseTriggerScheduledRuns- Genai
Attach Agent Body - Information for linking an agent
- Genai
Attach Agent Function Body - Information for a agent function link
- Genai
Attach Agent Function Response - Information about a newly function linked agent
- Genai
Attach Agent Function Response Agent - An Agent
- Genai
Attach Agent Function Response Agent Chatbot GenaiAttachAgentFunctionResponseAgentChatbot- Genai
Attach Agent Guardrails Body - Information about linking an agent to a guardrail
- Genai
Attach Agent Guardrails Body Guardrails Item GenaiAttachAgentGuardrailsBodyGuardrailsItem- Genai
Attach Agent Guardrails Response - Information about an updated agent
- Genai
Attach Agent Guardrails Response Agent - An Agent
- Genai
Attach Agent Guardrails Response Agent Chatbot GenaiAttachAgentGuardrailsResponseAgentChatbot- Genai
Attach Agent Response - Information about a newly linked agent
- Genai
Attach Knowledge Base Response - Information about a linked knowledge base
- Genai
Attach Knowledge Base Response Agent - An Agent
- Genai
Attach Knowledge Base Response Agent Chatbot GenaiAttachKnowledgeBaseResponseAgentChatbot- Genai
Attach Knowledge Bases Response - Information about a linked knowledge base
- Genai
Attach Knowledge Bases Response Agent - An Agent
- Genai
Attach Knowledge Bases Response Agent Chatbot GenaiAttachKnowledgeBasesResponseAgentChatbot- Genai
Cancel Indexing JobBody - CancelKnowledgeBaseIndexingJobInputPublic description
- Genai
Cancel Indexing JobResponse - CancelKnowledgeBaseIndexingJobOutput description
- Genai
Cancel Indexing JobResponse Job - IndexingJob description
- Genai
Cancel Model Evaluation RunBody GenaiCancelModelEvaluationRunBody- Genai
Cancel Model Evaluation RunResponse GenaiCancelModelEvaluationRunResponse- Genai
Cancel Model Evaluation RunResponse Run - Model Evaluation Run Summary - lightweight view used in run history list.
- Genai
Create Agent ApiKey Body GenaiCreateAgentApiKeyBody- Genai
Create Agent ApiKey Response GenaiCreateAgentApiKeyResponse- Genai
Create Agent ApiKey Response ApiKey Info - Agent API Key Info
- Genai
Create Agent Body - Parameters for Agent Creation
- Genai
Create Agent Body McpServers Item - McpServer defines a remote MCP server configuration for an agent.
- Genai
Create Agent Response - Information about a newly created Agent
- Genai
Create Agent Response Agent - An Agent
- Genai
Create Agent Response Agent Chatbot GenaiCreateAgentResponseAgentChatbot- Genai
Create Anthropic ApiKey Body - CreateAnthropicAPIKeyInputPublic is used to create a new Anthropic API key for a specific agent.
- Genai
Create Anthropic ApiKey Response - CreateAnthropicAPIKeyOutput is used to return the newly created Anthropic API key.
- Genai
Create Anthropic ApiKey Response ApiKey Info - Anthropic API Key Info
- Genai
Create Custom Evaluation Metric Body GenaiCreateCustomEvaluationMetricBody- Genai
Create Custom Evaluation Metric Body Config - Configuration for a custom model-evaluation metric scored by an LLM judge. Prompt and model response are always included in the judge context.
- Genai
Create Custom Evaluation Metric Response GenaiCreateCustomEvaluationMetricResponse- Genai
Create Custom Evaluation Metric Response Metric GenaiCreateCustomEvaluationMetricResponseMetric- Genai
Create Data Source File Upload Presigned Urls Body - Request for pre-signed URL’s to upload files for KB Data Sources
- Genai
Create Data Source File Upload Presigned Urls Body Files Item - A single file’s metadata in the request.
- Genai
Create Data Source File Upload Presigned Urls Response - Response with pre-signed urls to upload files.
- Genai
Create Data Source File Upload Presigned Urls Response Uploads Item - Detailed info about each presigned URL returned to the client.
- Genai
Create Evaluation Dataset Body - Creates an evaluation dataset for an agent
- Genai
Create Evaluation Dataset Body File Upload Dataset - File to upload as data source for knowledge base.
- Genai
Create Evaluation Dataset File Upload Presigned Urls Body - Request for pre-signed URL’s to upload files for KB Data Sources
- Genai
Create Evaluation Dataset File Upload Presigned Urls Body Files Item - A single file’s metadata in the request.
- Genai
Create Evaluation Dataset File Upload Presigned Urls Response - Response with pre-signed urls to upload files.
- Genai
Create Evaluation Dataset File Upload Presigned Urls Response Uploads Item - Detailed info about each presigned URL returned to the client.
- Genai
Create Evaluation Dataset Response - Output for creating an agent evaluation dataset
- Genai
Create Evaluation Test Case Body GenaiCreateEvaluationTestCaseBody- Genai
Create Evaluation Test Case Body Star Metric GenaiCreateEvaluationTestCaseBodyStarMetric- Genai
Create Evaluation Test Case Response GenaiCreateEvaluationTestCaseResponse- Genai
Create Indexing JobBody - StartKnowledgeBaseIndexingJobInputPublic description
- Genai
Create Indexing JobResponse - StartKnowledgeBaseIndexingJobOutput description
- Genai
Create Indexing JobResponse Job - IndexingJob description
- Genai
Create Knowledge Base Body - Data to create a new knowledge base.
- Genai
Create Knowledge Base Body Datasources Item GenaiCreateKnowledgeBaseBodyDatasourcesItem- Genai
Create Knowledge Base Body Reranking Config - Configuration for cross-encoder reranking during retrieval.
- Genai
Create Knowledge Base Data Source Body - Data to create a knowledge base data source
- Genai
Create Knowledge Base Data Source Body AwsData Source - AWS S3 Data Source
- Genai
Create Knowledge Base Data Source Body Chunking Options GenaiCreateKnowledgeBaseDataSourceBodyChunkingOptions- Genai
Create Knowledge Base Data Source Body Spaces Data Source - Spaces Bucket Data Source
- Genai
Create Knowledge Base Data Source Body WebCrawler Data Source - WebCrawlerDataSource
- Genai
Create Knowledge Base Data Source Response - Information about a newly created knowldege base data source
- Genai
Create Knowledge Base Data Source Response Knowledge Base Data Source - Data Source configuration for Knowledge Bases
- Genai
Create Knowledge Base Response - Information about a newly created knowledge base
- Genai
Create Knowledge Base Response Knowledge Base - Knowledgebase Description
- Genai
Create Model ApiKey Body GenaiCreateModelApiKeyBody- Genai
Create Model ApiKey Response GenaiCreateModelApiKeyResponse- Genai
Create Model Eval Dataset Upload Presigned Urls Body - Public request for presigned upload URLs for model evaluation dataset files.
- Genai
Create Model Eval Dataset Upload Presigned Urls Body Files Item - A single file’s metadata in the request.
- Genai
Create Model Eval Dataset Upload Presigned Urls Response - Response with pre-signed urls to upload files.
- Genai
Create Model Eval Dataset Upload Presigned Urls Response Uploads Item - Detailed info about each presigned URL returned to the client.
- Genai
Create Model Evaluation RunBody GenaiCreateModelEvaluationRunBody- Genai
Create Model Evaluation RunBody Candidate Inference Config - Inference configuration for the candidate model during evaluation.
- Genai
Create Model Evaluation RunBody Star Metric GenaiCreateModelEvaluationRunBodyStarMetric- Genai
Create Model Evaluation RunResponse GenaiCreateModelEvaluationRunResponse- Genai
Create Model Router Body - Create a model router
- Genai
Create Model Router Body Policies Item - Model router policy
- Genai
Create Model Router Response - Information about a newly created model router
- Genai
Create Model Router Response Model Router - Model router
- Genai
Create Oauth2 Dropbox Tokens Body - The oauth2 code from google
- Genai
Create Oauth2 Dropbox Tokens Response - The dropbox oauth2 token and refresh token
- Genai
Create Openai ApiKey Body - CreateOpenAIAPIKeyInputPublic is used to create a new OpenAI API key for a specific agent.
- Genai
Create Openai ApiKey Response - CreateOpenAIAPIKeyOutput is used to return the newly created OpenAI API key.
- Genai
Create Openai ApiKey Response ApiKey Info - OpenAI API Key Info
- Genai
Create Scheduled Indexing Body GenaiCreateScheduledIndexingBody- Genai
Create Scheduled Indexing Response GenaiCreateScheduledIndexingResponse- Genai
Create Scheduled Indexing Response Indexing Info - Metadata for scheduled indexing entries
- Genai
Create Workspace Body - Parameters for Workspace Creation
- Genai
Create Workspace Response GenaiCreateWorkspaceResponse- Genai
Create Workspace Response Workspace GenaiCreateWorkspaceResponseWorkspace- Genai
Delete Agent ApiKey Response GenaiDeleteAgentApiKeyResponse- Genai
Delete Agent ApiKey Response ApiKey Info - Agent API Key Info
- Genai
Delete Agent Response - Info about a deleted agent
- Genai
Delete Agent Response Agent - An Agent
- Genai
Delete Agent Response Agent Chatbot GenaiDeleteAgentResponseAgentChatbot- Genai
Delete Anthropic ApiKey Response - DeleteAnthropicAPIKeyOutput is used to return the deleted Anthropic API key.
- Genai
Delete Anthropic ApiKey Response ApiKey Info - Anthropic API Key Info
- Genai
Delete Custom Model Response - Response containing delete operation status (public)
- Genai
Delete Knowledge Base Data Source Response - Information about a newly deleted knowledge base data source
- Genai
Delete Knowledge Base Response - Information about a deleted knowledge base
- Genai
Delete Model ApiKey Response GenaiDeleteModelApiKeyResponse- Genai
Delete Model ApiKey Response ApiKey Info - Model API Key Info
- Genai
Delete Model Evaluation RunResponse GenaiDeleteModelEvaluationRunResponse- Genai
Delete Model Router Response - Information about a deleted model router
- Genai
Delete Openai ApiKey Response - DeleteOpenAIAPIKeyOutput is used to return the deleted OpenAI API key.
- Genai
Delete Openai ApiKey Response ApiKey Info - OpenAI API Key Info
- Genai
Delete Scheduled Indexing Response GenaiDeleteScheduledIndexingResponse- Genai
Delete Scheduled Indexing Response Indexing Info - Metadata for scheduled indexing entries
- Genai
Delete Workspace Response GenaiDeleteWorkspaceResponse- Genai
Detach Agent Function Response - Information about a newly unlinked agent
- Genai
Detach Agent Function Response Agent - An Agent
- Genai
Detach Agent Function Response Agent Chatbot GenaiDetachAgentFunctionResponseAgentChatbot- Genai
Detach Agent Guardrail Response - UnlinkAgentGuardrailOutput description
- Genai
Detach Agent Guardrail Response Agent - An Agent
- Genai
Detach Agent Guardrail Response Agent Chatbot GenaiDetachAgentGuardrailResponseAgentChatbot- Genai
Detach Agent Response - Information about a removed linkage
- Genai
Detach Knowledge Base Response - Informatinon about a unlinked knowledge base
- Genai
Detach Knowledge Base Response Agent - An Agent
- Genai
Detach Knowledge Base Response Agent Chatbot GenaiDetachKnowledgeBaseResponseAgentChatbot- Genai
GetAgent Children Response - Child list for an agent
- Genai
GetAgent Children Response Children Item - An Agent
- Genai
GetAgent Children Response Children Item Chatbot GenaiGetAgentChildrenResponseChildrenItemChatbot- Genai
GetAgent Response - One Agent
- Genai
GetAgent Response Agent - An Agent
- Genai
GetAgent Response Agent Chatbot GenaiGetAgentResponseAgentChatbot- Genai
GetAgent Usage Response - Agent usage
- Genai
GetAgent Usage Response LogInsights Usage - Resource Usage Description
- Genai
GetAgent Usage Response Usage - Resource Usage Description
- Genai
GetAnthropic ApiKey Response GenaiGetAnthropicApiKeyResponse- Genai
GetAnthropic ApiKey Response ApiKey Info - Anthropic API Key Info
- Genai
GetCustom Model Response - Response containing a single custom model (public)
- Genai
GetCustom Model Response Model - Custom model - user-imported model from HuggingFace, Spaces, etc.
- Genai
GetEvaluation Dataset Download UrlResponse - Response containing a presigned download URL for an evaluation dataset.
- Genai
GetEvaluation RunPrompt Results Response GenaiGetEvaluationRunPromptResultsResponse- Genai
GetEvaluation RunPrompt Results Response Prompt GenaiGetEvaluationRunPromptResultsResponsePrompt- Genai
GetEvaluation RunResponse GenaiGetEvaluationRunResponse- Genai
GetEvaluation RunResponse Evaluation Run GenaiGetEvaluationRunResponseEvaluationRun- Genai
GetEvaluation RunResults Response - Gets the full results of an evaluation run with all prompts.
- Genai
GetEvaluation RunResults Response Evaluation Run GenaiGetEvaluationRunResultsResponseEvaluationRun- Genai
GetEvaluation RunResults Response Links - Links to other pages
- Genai
GetEvaluation RunResults Response Meta - Meta information about the data set
- Genai
GetEvaluation RunResults Response Prompts Item GenaiGetEvaluationRunResultsResponsePromptsItem- Genai
GetEvaluation Test Case Response GenaiGetEvaluationTestCaseResponse- Genai
GetEvaluation Test Case Response Evaluation Test Case GenaiGetEvaluationTestCaseResponseEvaluationTestCase- Genai
GetIndexing JobDetails Signed UrlResponse GenaiGetIndexingJobDetailsSignedUrlResponse- Genai
GetIndexing JobResponse - GetKnowledgeBaseIndexingJobOutput description
- Genai
GetIndexing JobResponse Job - IndexingJob description
- Genai
GetKnowledge Base Response - The knowledge base
- Genai
GetKnowledge Base Response Knowledge Base - Knowledgebase Description
- Genai
GetModel Catalog Card Response GenaiGetModelCatalogCardResponse- Genai
GetModel Catalog Card Response Data - Detail view for GetModelCatalogCard
- Genai
GetModel Evaluation Preset Response GenaiGetModelEvaluationPresetResponse- Genai
GetModel Evaluation Preset Response Preset - Model Evaluation Preset - a saved, reusable configuration for model
evaluation runs. Each section (dataset, judge, metrics, candidate, system
prompt) is independent and may be empty; sections the preset omits must be
supplied inline on the run that references it. Use
saved_sectionsto tell “section saved with empty value” apart from “section not saved at all” — each section’s scalar fields are left empty when the section was not saved. - Genai
GetModel Evaluation RunResponse GenaiGetModelEvaluationRunResponse- Genai
GetModel Evaluation RunResponse Links - Links to other pages
- Genai
GetModel Evaluation RunResponse Meta - Meta information about the data set
- Genai
GetModel Evaluation RunResponse Results Item - Result for a single prompt in a model evaluation run.
- Genai
GetModel Evaluation RunResponse Run - Model Evaluation Run Detail - full view returned when fetching a specific run.
- Genai
GetModel Evaluation RunResults Download UrlResponse - Response containing a presigned download URL for model evaluation run results.
- Genai
GetModel Router Response - The model router
- Genai
GetModel Router Response Model Router - Model router
- Genai
GetOauth2 UrlResponse - The url for the oauth2 flow
- Genai
GetOpenai ApiKey Response GenaiGetOpenaiApiKeyResponse- Genai
GetOpenai ApiKey Response ApiKey Info - OpenAI API Key Info
- Genai
GetScheduled Indexing Response GenaiGetScheduledIndexingResponse- Genai
GetScheduled Indexing Response Indexing Info - Metadata for scheduled indexing entries
- Genai
GetWorkspace Response GenaiGetWorkspaceResponse- Genai
GetWorkspace Response Workspace GenaiGetWorkspaceResponseWorkspace- Genai
Import Custom Model Body - Request to import a custom model (public)
- Genai
Import Custom Model Body Source Ref - Reference to the original source of the model
- Genai
Import Custom Model Body Tags - User-defined tags for organizing models
- Genai
Import Custom Model Response - Response containing imported model details (public)
- Genai
Import Custom Model Response Import Job - Import job tracking for a custom model
- Genai
Import Custom Model Response Model - Custom model - user-imported model from HuggingFace, Spaces, etc.
- Genai
Import Custom Model Response Validation Steps Item - Validation step result during model import
- Genai
List Agent ApiKeys Response GenaiListAgentApiKeysResponse- Genai
List Agent ApiKeys Response ApiKey Infos Item - Agent API Key Info
- Genai
List Agent ApiKeys Response Links - Links to other pages
- Genai
List Agent ApiKeys Response Meta - Meta information about the data set
- Genai
List Agent Versions Response - List of agent versions
- Genai
List Agent Versions Response Agent Versions Item - Represents an AgentVersion entity
- Genai
List Agent Versions Response Links - Links to other pages
- Genai
List Agent Versions Response Meta - Meta information about the data set
- Genai
List Agents ByAnthropic KeyResponse - List of Agents that linked to a specific Anthropic Key
- Genai
List Agents ByAnthropic KeyResponse Agents Item - An Agent
- Genai
List Agents ByAnthropic KeyResponse Agents Item Chatbot GenaiListAgentsByAnthropicKeyResponseAgentsItemChatbot- Genai
List Agents ByAnthropic KeyResponse Links - Links to other pages
- Genai
List Agents ByAnthropic KeyResponse Meta - Meta information about the data set
- Genai
List Agents ByOpenai KeyResponse - List of Agents that are linked to a specific OpenAI Key
- Genai
List Agents ByOpenai KeyResponse Agents Item - An Agent
- Genai
List Agents ByOpenai KeyResponse Agents Item Chatbot GenaiListAgentsByOpenaiKeyResponseAgentsItemChatbot- Genai
List Agents ByOpenai KeyResponse Links - Links to other pages
- Genai
List Agents ByOpenai KeyResponse Meta - Meta information about the data set
- Genai
List Agents ByWorkspace Response GenaiListAgentsByWorkspaceResponse- Genai
List Agents ByWorkspace Response Agents Item - An Agent
- Genai
List Agents ByWorkspace Response Agents Item Chatbot GenaiListAgentsByWorkspaceResponseAgentsItemChatbot- Genai
List Agents ByWorkspace Response Links - Links to other pages
- Genai
List Agents ByWorkspace Response Meta - Meta information about the data set
- Genai
List Agents Response - List of Agents
- Genai
List Agents Response Agents Item - A GenAI Agent’s configuration
- Genai
List Agents Response Agents Item Chatbot GenaiListAgentsResponseAgentsItemChatbot- Genai
List Agents Response Links - Links to other pages
- Genai
List Agents Response Meta - Meta information about the data set
- Genai
List Anthropic ApiKeys Response - ListAnthropicAPIKeysOutput is used to return the list of Anthropic API keys for a specific agent.
- Genai
List Anthropic ApiKeys Response ApiKey Infos Item - Anthropic API Key Info
- Genai
List Anthropic ApiKeys Response Links - Links to other pages
- Genai
List Anthropic ApiKeys Response Meta - Meta information about the data set
- Genai
List Custom Models Response - Response containing a list of custom models (public)
- Genai
List Custom Models Response Links - Links to other pages
- Genai
List Custom Models Response Meta - Meta information about the data set
- Genai
List Custom Models Response Models Item - Custom model - user-imported model from HuggingFace, Spaces, etc.
- Genai
List Datacenter Regions Response - Region Codes
- Genai
List Datacenter Regions Response Regions Item - Description for a specific Region
- Genai
List Evaluation Datasets Response - Output for listing evaluation datasets.
- Genai
List Evaluation Datasets Response Evaluation Datasets Item GenaiListEvaluationDatasetsResponseEvaluationDatasetsItem- Genai
List Evaluation Metrics Response GenaiListEvaluationMetricsResponse- Genai
List Evaluation Metrics Response Metrics Item GenaiListEvaluationMetricsResponseMetricsItem- Genai
List Evaluation Runs ByTest Case Response GenaiListEvaluationRunsByTestCaseResponse- Genai
List Evaluation Runs ByTest Case Response Evaluation Runs Item GenaiListEvaluationRunsByTestCaseResponseEvaluationRunsItem- Genai
List Evaluation Test Cases ByWorkspace Response GenaiListEvaluationTestCasesByWorkspaceResponse- Genai
List Evaluation Test Cases ByWorkspace Response Evaluation Test Cases Item GenaiListEvaluationTestCasesByWorkspaceResponseEvaluationTestCasesItem- Genai
List Evaluation Test Cases Response GenaiListEvaluationTestCasesResponse- Genai
List Evaluation Test Cases Response Evaluation Test Cases Item GenaiListEvaluationTestCasesResponseEvaluationTestCasesItem- Genai
List Indexing JobData Sources Response GenaiListIndexingJobDataSourcesResponse- Genai
List Indexing JobData Sources Response Indexed Data Sources Item GenaiListIndexingJobDataSourcesResponseIndexedDataSourcesItem- Genai
List Indexing Jobs ByKnowledge Base Response - Indexing jobs
- Genai
List Indexing Jobs ByKnowledge Base Response Jobs Item - IndexingJob description
- Genai
List Indexing Jobs ByKnowledge Base Response Links - Links to other pages
- Genai
List Indexing Jobs ByKnowledge Base Response Meta - Meta information about the data set
- Genai
List Indexing Jobs Response - Indexing jobs
- Genai
List Indexing Jobs Response Jobs Item - IndexingJob description
- Genai
List Indexing Jobs Response Links - Links to other pages
- Genai
List Indexing Jobs Response Meta - Meta information about the data set
- Genai
List Knowledge Base Data Sources Response - A list of knowledge base data sources
- Genai
List Knowledge Base Data Sources Response Knowledge Base Data Sources Item - Data Source configuration for Knowledge Bases
- Genai
List Knowledge Base Data Sources Response Links - Links to other pages
- Genai
List Knowledge Base Data Sources Response Meta - Meta information about the data set
- Genai
List Knowledge Bases Response - List of knowledge bases
- Genai
List Knowledge Bases Response Knowledge Bases Item - Knowledgebase Description
- Genai
List Knowledge Bases Response Links - Links to other pages
- Genai
List Knowledge Bases Response Meta - Meta information about the data set
- Genai
List Model ApiKeys Response GenaiListModelApiKeysResponse- Genai
List Model ApiKeys Response ApiKey Infos Item - Model API Key Info
- Genai
List Model ApiKeys Response Links - Links to other pages
- Genai
List Model ApiKeys Response Meta - Meta information about the data set
- Genai
List Model Catalog Response GenaiListModelCatalogResponse- Genai
List Model Catalog Response Data Item - List item for ListModelCatalog
- Genai
List Model Catalog Response Meta - Meta information about the data set
- Genai
List Model Evaluation Metrics Response GenaiListModelEvaluationMetricsResponse- Genai
List Model Evaluation Metrics Response Metrics Item GenaiListModelEvaluationMetricsResponseMetricsItem- Genai
List Model Evaluation Presets Response GenaiListModelEvaluationPresetsResponse- Genai
List Model Evaluation Presets Response Presets Item - Model Evaluation Preset - a saved, reusable configuration for model
evaluation runs. Each section (dataset, judge, metrics, candidate, system
prompt) is independent and may be empty; sections the preset omits must be
supplied inline on the run that references it. Use
saved_sectionsto tell “section saved with empty value” apart from “section not saved at all” — each section’s scalar fields are left empty when the section was not saved. - Genai
List Model Evaluation Runs Response GenaiListModelEvaluationRunsResponse- Genai
List Model Evaluation Runs Response Links - Links to other pages
- Genai
List Model Evaluation Runs Response Meta - Meta information about the data set
- Genai
List Model Evaluation Runs Response Runs Item - Model Evaluation Run Summary - lightweight view used in run history list.
- Genai
List Model Router Presets Response - List of model router presets
- Genai
List Model Router Presets Response Links - Links to other pages
- Genai
List Model Router Presets Response Meta - Meta information about the data set
- Genai
List Model Router Presets Response Presets Item - Model router preset used to prefill new router configurations.
- Genai
List Model Router Task Presets Response - List of model router task presets
- Genai
List Model Router Task Presets Response Links - Links to other pages
- Genai
List Model Router Task Presets Response Meta - Meta information about the data set
- Genai
List Model Router Task Presets Response Tasks Item - Task preset that can be referenced by slug in model router policies.
- Genai
List Model Routers Response - List of model routers
- Genai
List Model Routers Response Links - Links to other pages
- Genai
List Model Routers Response Meta - Meta information about the data set
- Genai
List Model Routers Response Model Routers Item - Model router
- Genai
List Models Response - A list of models
- Genai
List Models Response Links - Links to other pages
- Genai
List Models Response Meta - Meta information about the data set
- Genai
List Models Response Models Item - A machine learning model stored on the GenAI platform
- Genai
List Openai ApiKeys Response - ListOpenAIAPIKeysOutput is used to return the list of OpenAI API keys for a specific agent.
- Genai
List Openai ApiKeys Response ApiKey Infos Item - OpenAI API Key Info
- Genai
List Openai ApiKeys Response Links - Links to other pages
- Genai
List Openai ApiKeys Response Meta - Meta information about the data set
- Genai
List Workspaces Response GenaiListWorkspacesResponse- Genai
List Workspaces Response Workspaces Item GenaiListWorkspacesResponseWorkspacesItem- Genai
Regenerate Agent ApiKey Response GenaiRegenerateAgentApiKeyResponse- Genai
Regenerate Agent ApiKey Response ApiKey Info - Agent API Key Info
- Genai
Regenerate Model ApiKey Response GenaiRegenerateModelApiKeyResponse- Genai
Regenerate Model ApiKey Response ApiKey Info - Model API Key Info
- Genai
Rollback ToAgent Version Body GenaiRollbackToAgentVersionBody- Genai
Rollback ToAgent Version Response GenaiRollbackToAgentVersionResponse- Genai
Rollback ToAgent Version Response Audit Header - An alternative way to provide auth information. for internal use only.
- Genai
RunEvaluation Test Case Body - Run an evaluation test case.
- Genai
RunEvaluation Test Case Response GenaiRunEvaluationTestCaseResponse- Genai
Update Agent ApiKey Body GenaiUpdateAgentApiKeyBody- Genai
Update Agent ApiKey Response GenaiUpdateAgentApiKeyResponse- Genai
Update Agent ApiKey Response ApiKey Info - Agent API Key Info
- Genai
Update Agent Body - Data to modify an existing Agent
- Genai
Update Agent Body McpServers Item - McpServer defines a remote MCP server configuration for an agent.
- Genai
Update Agent Deployment Visibility Body - UpdateAgentDeploymentVisibilityInputPublic description
- Genai
Update Agent Deployment Visibility Response - UpdateAgentDeploymentVisbilityOutput description
- Genai
Update Agent Deployment Visibility Response Agent - An Agent
- Genai
Update Agent Deployment Visibility Response Agent Chatbot GenaiUpdateAgentDeploymentVisibilityResponseAgentChatbot- Genai
Update Agent Function Body - Information about updating an agent function
- Genai
Update Agent Function Response - The updated agent
- Genai
Update Agent Function Response Agent - An Agent
- Genai
Update Agent Function Response Agent Chatbot GenaiUpdateAgentFunctionResponseAgentChatbot- Genai
Update Agent Response - Information about an updated agent
- Genai
Update Agent Response Agent - An Agent
- Genai
Update Agent Response Agent Chatbot GenaiUpdateAgentResponseAgentChatbot- Genai
Update Agents Workspace Body - Parameters for Moving agents to a Workspace
- Genai
Update Agents Workspace Response GenaiUpdateAgentsWorkspaceResponse- Genai
Update Agents Workspace Response Workspace GenaiUpdateAgentsWorkspaceResponseWorkspace- Genai
Update Anthropic ApiKey Body - UpdateAnthropicAPIKeyInputPublic is used to update an existing Anthropic API key for a specific agent.
- Genai
Update Anthropic ApiKey Response - UpdateAnthropicAPIKeyOutput is used to return the updated Anthropic API key.
- Genai
Update Anthropic ApiKey Response ApiKey Info - Anthropic API Key Info
- Genai
Update Attached Agent Body - Information about updating the linkage of an agent
- Genai
Update Attached Agent Response - Information about an updated linkage
- Genai
Update Custom Evaluation Metric Body GenaiUpdateCustomEvaluationMetricBody- Genai
Update Custom Evaluation Metric Body Config - Configuration for a custom model-evaluation metric scored by an LLM judge. Prompt and model response are always included in the judge context.
- Genai
Update Custom Evaluation Metric Response GenaiUpdateCustomEvaluationMetricResponse- Genai
Update Custom Evaluation Metric Response Metric GenaiUpdateCustomEvaluationMetricResponseMetric- Genai
Update Custom Model Metadata Body - Request to update custom model metadata (public)
- Genai
Update Custom Model Metadata Body Tags - User-defined tags for organizing models
- Genai
Update Custom Model Metadata Response - Response containing the updated custom model (public)
- Genai
Update Custom Model Metadata Response Model - Custom model - user-imported model from HuggingFace, Spaces, etc.
- Genai
Update Evaluation Test Case Body GenaiUpdateEvaluationTestCaseBody- Genai
Update Evaluation Test Case Body Metrics GenaiUpdateEvaluationTestCaseBodyMetrics- Genai
Update Evaluation Test Case Body Star Metric GenaiUpdateEvaluationTestCaseBodyStarMetric- Genai
Update Evaluation Test Case Response GenaiUpdateEvaluationTestCaseResponse- Genai
Update Knowledge Base Body - Information about updating a knowledge base
- Genai
Update Knowledge Base Body Reranking Config - Configuration for cross-encoder reranking during retrieval.
- Genai
Update Knowledge Base Data Source Body - Update a data source of a knowledge base with change in chunking algorithm/options
- Genai
Update Knowledge Base Data Source Body Chunking Options GenaiUpdateKnowledgeBaseDataSourceBodyChunkingOptions- Genai
Update Knowledge Base Data Source Response - Update a data source of a knowledge base with change in chunking algorithm/options
- Genai
Update Knowledge Base Data Source Response Knowledge Base Data Source - Data Source configuration for Knowledge Bases
- Genai
Update Knowledge Base Response - Information about an updated knowledge base
- Genai
Update Knowledge Base Response Knowledge Base - Knowledgebase Description
- Genai
Update Model ApiKey Body GenaiUpdateModelApiKeyBody- Genai
Update Model ApiKey Response GenaiUpdateModelApiKeyResponse- Genai
Update Model ApiKey Response ApiKey Info - Model API Key Info
- Genai
Update Model Evaluation RunBody GenaiUpdateModelEvaluationRunBody- Genai
Update Model Evaluation RunResponse GenaiUpdateModelEvaluationRunResponse- Genai
Update Model Evaluation RunResponse Run - Model Evaluation Run Summary - lightweight view used in run history list.
- Genai
Update Model Router Body - Information about updating a model router
- Genai
Update Model Router Body Policies Item - Model router policy
- Genai
Update Model Router Response - Information about an updated model router
- Genai
Update Model Router Response Model Router - Model router
- Genai
Update Openai ApiKey Body - UpdateOpenAIAPIKeyInputPublic is used to update an existing OpenAI API key for a specific agent.
- Genai
Update Openai ApiKey Response - UpdateOpenAIAPIKeyOutput is used to return the updated OpenAI API key.
- Genai
Update Openai ApiKey Response ApiKey Info - OpenAI API Key Info
- Genai
Update Workspace Body - Parameters for Update Workspace
- Genai
Update Workspace Response GenaiUpdateWorkspaceResponse- Genai
Update Workspace Response Workspace GenaiUpdateWorkspaceResponseWorkspace- Geographical
Information About AnApp Origin GeographicalInformationAboutAnAppOrigin- Image
Actions GetResponse ImageActionsGetResponse- Image
Actions GetResponse Region ImageActionsGetResponseRegion- Image
Actions List Response ImageActionsListResponse- Image
Actions List Response Actions Item ImageActionsListResponseActionsItem- Image
Actions List Response Actions Item Region ImageActionsListResponseActionsItemRegion- Image
Actions List Response Links ImageActionsListResponseLinks- Image
Actions List Response Links Pages ImageActionsListResponseLinksPages- Image
Actions List Response Links Pages Subtype0 ImageActionsListResponseLinksPagesSubtype0- Image
Actions List Response Links Pages Subtype1 ImageActionsListResponseLinksPagesSubtype1- Image
Actions List Response Meta ImageActionsListResponseMeta- Image
Actions Post Response ImageActionsPostResponse- Image
Actions Post Response Region ImageActionsPostResponseRegion- Images
Create Custom Body ImagesCreateCustomBody- Images
Create Custom Response ImagesCreateCustomResponse- Images
Create Custom Response Image ImagesCreateCustomResponseImage- Images
GetResponse ImagesGetResponse- Images
GetResponse Image ImagesGetResponseImage- Images
List Response ImagesListResponse- Images
List Response Images Item ImagesListResponseImagesItem- Images
List Response Links ImagesListResponseLinks- Images
List Response Links Pages ImagesListResponseLinksPages- Images
List Response Links Pages Subtype0 ImagesListResponseLinksPagesSubtype0- Images
List Response Links Pages Subtype1 ImagesListResponseLinksPagesSubtype1- Images
List Response Meta ImagesListResponseMeta- Images
Post Account Transfer Accept Body ImagesPostAccountTransferAcceptBody- Images
Post Account Transfer Cancel Body ImagesPostAccountTransferCancelBody- Images
Post Account Transfer Create Response ImagesPostAccountTransferCreateResponse- Images
Post Account Transfer Decline Body ImagesPostAccountTransferDeclineBody- Images
Update Body ImagesUpdateBody- Images
Update Response ImagesUpdateResponse- Images
Update Response Image ImagesUpdateResponseImage- Inference
Cancel Batch Response - A Batch Inference job.
- Inference
Cancel Batch Response Errors Item InferenceCancelBatchResponseErrorsItem- Inference
Cancel Batch Response Request Counts - Aggregate request counts.
- Inference
Create Async Invoke Body - Request body for asynchronously invoking a model. Supports image generation, audio generation, and text-to-speech models. The
inputobject fields vary depending on the model type. - Inference
Create Async Invoke Body Input - The input parameters for the model invocation. Fields vary by model type.
- Inference
Create Async Invoke Body Tags Item InferenceCreateAsyncInvokeBodyTagsItem- Inference
Create Async Invoke Response - Response returned when an asynchronous invocation request is accepted. The job status is QUEUED initially. Use the request_id to poll for the result.
- Inference
Create Batch Body - Request body for creating a batch inference job.
- Inference
Create Batch File Response - Presigned upload URL and
file_idfor a new batch input file. - Inference
Create Batch Response - A Batch Inference job.
- Inference
Create Batch Response Errors Item InferenceCreateBatchResponseErrorsItem- Inference
Create Batch Response Request Counts - Aggregate request counts.
- Inference
Create Chat Completion Body InferenceCreateChatCompletionBody- Inference
Create Chat Completion Body Messages Item - A message in the chat conversation.
- Inference
Create Chat Completion Body Messages Item Tool Calls Item InferenceCreateChatCompletionBodyMessagesItemToolCallsItem- Inference
Create Chat Completion Body Messages Item Tool Calls Item Function InferenceCreateChatCompletionBodyMessagesItemToolCallsItemFunction- Inference
Create Chat Completion Body Stream Options - Options for streaming response. Only set this when you set stream to true.
- Inference
Create Chat Completion Body Tool Choice Variant1 Function InferenceCreateChatCompletionBodyToolChoiceVariant1Function- Inference
Create Chat Completion Body Tools Item InferenceCreateChatCompletionBodyToolsItem- Inference
Create Chat Completion Body Tools Item Function InferenceCreateChatCompletionBodyToolsItemFunction- Inference
Create Chat Completion Response - Represents a chat completion response returned by model, based on the provided input.
- Inference
Create Chat Completion Response Choices Item InferenceCreateChatCompletionResponseChoicesItem- Inference
Create Chat Completion Response Choices Item Logprobs - Log probability information for the choice.
- Inference
Create Chat Completion Response Choices Item Logprobs Content Item InferenceCreateChatCompletionResponseChoicesItemLogprobsContentItem- Inference
Create Chat Completion Response Choices Item Logprobs Content Item TopLogprobs Item InferenceCreateChatCompletionResponseChoicesItemLogprobsContentItemTopLogprobsItem- Inference
Create Chat Completion Response Choices Item Logprobs Refusal Item InferenceCreateChatCompletionResponseChoicesItemLogprobsRefusalItem- Inference
Create Chat Completion Response Choices Item Logprobs Refusal Item TopLogprobs Item InferenceCreateChatCompletionResponseChoicesItemLogprobsRefusalItemTopLogprobsItem- Inference
Create Chat Completion Response Choices Item Message - A chat completion message generated by the model.
- Inference
Create Chat Completion Response Choices Item Message Tool Calls Item InferenceCreateChatCompletionResponseChoicesItemMessageToolCallsItem- Inference
Create Chat Completion Response Choices Item Message Tool Calls Item Function InferenceCreateChatCompletionResponseChoicesItemMessageToolCallsItemFunction- Inference
Create Chat Completion Response Usage - Usage statistics for the completion request.
- Inference
Create Chat Completion Response Usage Cache Creation - Breakdown of prompt tokens written to cache.
- Inference
Create Embedding Body - Request body for
POST /v1/embeddings(OpenAI-compatible). Extra fields are rejected. - Inference
Create Embedding Response - OpenAI-style embeddings response.
- Inference
Create Embedding Response Data Item - One row in the embeddings
dataarray, aligned with a singleinputitem. - Inference
Create Embedding Response Usage - Token usage for the embeddings request.
- Inference
Create Image Body - Request body for image generation.
- Inference
Create Image Body Prompt - A text description of the desired image(s). Supports up to 32,000 characters and provides automatic prompt optimization for best results.
- Inference
Create Image Body User - A unique identifier representing your end-user, which can help DigitalOcean to monitor and detect abuse.
- Inference
Create Image Response - The response from the image generation endpoint.
- Inference
Create Image Response Data Item - Represents the content of a generated image.
- Inference
Create Image Response Usage - Token usage information for the image generation.
- Inference
Create Image Response Usage Input Tokens Details - Detailed breakdown of input tokens.
- Inference
Create Messages Body - Request body for
POST /v1/messages. Required fields aremodel,messages, andmax_tokens. - Inference
Create Messages Body Messages Item - One turn in the conversation. Roles are
userorassistant(nosystemrole; use the top-levelsystemfield). Content may be a string (equivalent to a single text block) or an array of content blocks. - Inference
Create Messages Body Messages Item Content Variant1 Item Source - Image payload (for example base64-encoded bytes).
- Inference
Create Messages Body Metadata - Optional request metadata.
- Inference
Create Messages Body System Variant1 Item - A text content block in a request message.
- Inference
Create Messages Body Thinking - Extended thinking configuration. Executors that do not support thinking may ignore this field.
- Inference
Create Messages Body Tools Item - Tool definition the model may call (
name, JSON Schema forinput). - Inference
Create Messages Response - Non-streaming assistant message from
POST /v1/messages.typeis alwaysmessageandroleis alwaysassistant. - Inference
Create Messages Response Usage - Token usage for a non-streaming
POST /v1/messagesresponse. - Inference
Create Response Body - Request body for sending a prompt to a model using the Responses API.
- Inference
Create Response Body Input Variant1 Item InferenceCreateResponseBodyInputVariant1Item- Inference
Create Response Body Stream Options - Options for streaming response. Only set this when you set stream to true.
- Inference
Create Response Body Tool Choice Variant1 Function InferenceCreateResponseBodyToolChoiceVariant1Function- Inference
Create Response Body Tools Item InferenceCreateResponseBodyToolsItem- Inference
Create Response Response - The response includes structured output and token usage details.
- Inference
Create Response Response Output Item InferenceCreateResponseResponseOutputItem- Inference
Create Response Response Output Item Content Item InferenceCreateResponseResponseOutputItemContentItem- Inference
Create Response Response Tools Item InferenceCreateResponseResponseToolsItem- Inference
Create Response Response Usage - Detailed usage statistics for the Responses API request, including input/output token counts and detailed breakdowns.
- Inference
Create Response Response Usage Input Tokens Details - A detailed breakdown of the input tokens.
- Inference
Create Response Response Usage Output Tokens Details - A detailed breakdown of the output tokens.
- Inference
GetBatch Response - A Batch Inference job.
- Inference
GetBatch Response Errors Item InferenceGetBatchResponseErrorsItem- Inference
GetBatch Response Request Counts - Aggregate request counts.
- Inference
List Models Response - Response listing available models.
- Inference
List Models Response Data Item - Describes a model offering that can be used with the API.
- Invoices
GetBy Uuid Response InvoicesGetByUuidResponse- Invoices
GetBy Uuid Response Invoice Items Item InvoicesGetByUuidResponseInvoiceItemsItem- Invoices
GetBy Uuid Response Links InvoicesGetByUuidResponseLinks- Invoices
GetBy Uuid Response Links Pages InvoicesGetByUuidResponseLinksPages- Invoices
GetBy Uuid Response Links Pages Subtype0 InvoicesGetByUuidResponseLinksPagesSubtype0- Invoices
GetBy Uuid Response Links Pages Subtype1 InvoicesGetByUuidResponseLinksPagesSubtype1- Invoices
GetBy Uuid Response Meta InvoicesGetByUuidResponseMeta- Invoices
GetSummary ByUuid Response InvoicesGetSummaryByUuidResponse- Invoices
GetSummary ByUuid Response Credits AndAdjustments InvoicesGetSummaryByUuidResponseCreditsAndAdjustments- Invoices
GetSummary ByUuid Response Overages InvoicesGetSummaryByUuidResponseOverages- Invoices
GetSummary ByUuid Response Product Charges InvoicesGetSummaryByUuidResponseProductCharges- Invoices
GetSummary ByUuid Response Product Charges Items Item InvoicesGetSummaryByUuidResponseProductChargesItemsItem- Invoices
GetSummary ByUuid Response Taxes InvoicesGetSummaryByUuidResponseTaxes- Invoices
GetSummary ByUuid Response User Billing Address InvoicesGetSummaryByUuidResponseUserBillingAddress- Invoices
List Response InvoicesListResponse- Invoices
List Response Invoice Preview - The invoice preview.
- Invoices
List Response Invoices Item - The invoice preview.
- Invoices
List Response Links InvoicesListResponseLinks- Invoices
List Response Links Pages InvoicesListResponseLinksPages- Invoices
List Response Links Pages Subtype0 InvoicesListResponseLinksPagesSubtype0- Invoices
List Response Links Pages Subtype1 InvoicesListResponseLinksPagesSubtype1- Invoices
List Response Meta InvoicesListResponseMeta- JobComponents
That ArePart OfThis Deployment Item JobComponentsThatArePartOfThisDeploymentItem- Kubernetes
AddNode Pool Body KubernetesAddNodePoolBody- Kubernetes
AddNode Pool Body Taints Item KubernetesAddNodePoolBodyTaintsItem- Kubernetes
AddNode Pool Response KubernetesAddNodePoolResponse- Kubernetes
AddNode Pool Response Node Pool KubernetesAddNodePoolResponseNodePool- Kubernetes
AddNode Pool Response Node Pool Taints Item KubernetesAddNodePoolResponseNodePoolTaintsItem- Kubernetes
AddRegistries Body KubernetesAddRegistriesBody- Kubernetes
AddRegistry Body KubernetesAddRegistryBody- Kubernetes
Create Cluster Body KubernetesCreateClusterBody- Kubernetes
Create Cluster Body AmdGpu Device Metrics Exporter Plugin - An object specifying whether the AMD Device Metrics Exporter should be enabled in the Kubernetes cluster.
- Kubernetes
Create Cluster Body AmdGpu Device Plugin - An object specifying whether the AMD GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an AMD GPU node pool.
- Kubernetes
Create Cluster Body Cluster Autoscaler Configuration - An object specifying custom cluster autoscaler configuration.
- Kubernetes
Create Cluster Body Control Plane Firewall - An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only).
- Kubernetes
Create Cluster Body Coredns Autoscaler - An object specifying whether the Cluster Proportional Autoscaler (CPA) add-on for CoreDNS should be enabled for the Kubernetes cluster.
- Kubernetes
Create Cluster Body Maintenance Policy - An object specifying the maintenance window policy for the Kubernetes cluster.
- Kubernetes
Create Cluster Body Node Pools Item KubernetesCreateClusterBodyNodePoolsItem- Kubernetes
Create Cluster Body Node Pools Item Taints Item KubernetesCreateClusterBodyNodePoolsItemTaintsItem- Kubernetes
Create Cluster Body Nvidia GpuDevice Plugin - An object specifying whether the Nvidia GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an Nvidia GPU node pool.
- Kubernetes
Create Cluster Body P2pOci Registry Plugin - An object specifying whether the Peer-to-peer OCI registry component should be enabled for the Kubernetes cluster.
- Kubernetes
Create Cluster Body Rdma Shared DevPlugin - An object specifying whether the RDMA shared device plugin should be enabled in the Kubernetes cluster.
- Kubernetes
Create Cluster Body Routing Agent - An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster.
- Kubernetes
Create Cluster Body Sso - An object specifying Single Sign-On (SSO) configuration for the Kubernetes cluster.
- Kubernetes
Create Cluster Body Status - An object containing a
stateattribute whose value is set to a string indicating the current status of the cluster. - Kubernetes
Create Cluster Response KubernetesCreateClusterResponse- Kubernetes
Create Cluster Response Kubernetes Cluster KubernetesCreateClusterResponseKubernetesCluster- Kubernetes
Create Cluster Response Kubernetes Cluster AmdGpu Device Metrics Exporter Plugin - An object specifying whether the AMD Device Metrics Exporter should be enabled in the Kubernetes cluster.
- Kubernetes
Create Cluster Response Kubernetes Cluster AmdGpu Device Plugin - An object specifying whether the AMD GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an AMD GPU node pool.
- Kubernetes
Create Cluster Response Kubernetes Cluster Cluster Autoscaler Configuration - An object specifying custom cluster autoscaler configuration.
- Kubernetes
Create Cluster Response Kubernetes Cluster Control Plane Firewall - An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only).
- Kubernetes
Create Cluster Response Kubernetes Cluster Coredns Autoscaler - An object specifying whether the Cluster Proportional Autoscaler (CPA) add-on for CoreDNS should be enabled for the Kubernetes cluster.
- Kubernetes
Create Cluster Response Kubernetes Cluster Maintenance Policy - An object specifying the maintenance window policy for the Kubernetes cluster.
- Kubernetes
Create Cluster Response Kubernetes Cluster Node Pools Item KubernetesCreateClusterResponseKubernetesClusterNodePoolsItem- Kubernetes
Create Cluster Response Kubernetes Cluster Node Pools Item Taints Item KubernetesCreateClusterResponseKubernetesClusterNodePoolsItemTaintsItem- Kubernetes
Create Cluster Response Kubernetes Cluster Nvidia GpuDevice Plugin - An object specifying whether the Nvidia GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an Nvidia GPU node pool.
- Kubernetes
Create Cluster Response Kubernetes Cluster P2pOci Registry Plugin - An object specifying whether the Peer-to-peer OCI registry component should be enabled for the Kubernetes cluster.
- Kubernetes
Create Cluster Response Kubernetes Cluster Rdma Shared DevPlugin - An object specifying whether the RDMA shared device plugin should be enabled in the Kubernetes cluster.
- Kubernetes
Create Cluster Response Kubernetes Cluster Routing Agent - An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster.
- Kubernetes
Create Cluster Response Kubernetes Cluster Sso - An object specifying Single Sign-On (SSO) configuration for the Kubernetes cluster.
- Kubernetes
Create Cluster Response Kubernetes Cluster Status - An object containing a
stateattribute whose value is set to a string indicating the current status of the cluster. - Kubernetes
Destroy Associated Resources Selective Body - An object containing the IDs of resources to be destroyed along with their associated with a Kubernetes cluster.
- Kubernetes
GetAvailable Upgrades Response KubernetesGetAvailableUpgradesResponse- Kubernetes
GetAvailable Upgrades Response Available Upgrade Versions Item KubernetesGetAvailableUpgradesResponseAvailableUpgradeVersionsItem- Kubernetes
GetCluster Lint Results Response KubernetesGetClusterLintResultsResponse- Kubernetes
GetCluster Lint Results Response Diagnostics Item KubernetesGetClusterLintResultsResponseDiagnosticsItem- Kubernetes
GetCluster Lint Results Response Diagnostics Item Object - Metadata about the Kubernetes API object the diagnostic is reported on.
- Kubernetes
GetCluster Response KubernetesGetClusterResponse- Kubernetes
GetCluster Response Kubernetes Cluster KubernetesGetClusterResponseKubernetesCluster- Kubernetes
GetCluster Response Kubernetes Cluster AmdGpu Device Metrics Exporter Plugin - An object specifying whether the AMD Device Metrics Exporter should be enabled in the Kubernetes cluster.
- Kubernetes
GetCluster Response Kubernetes Cluster AmdGpu Device Plugin - An object specifying whether the AMD GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an AMD GPU node pool.
- Kubernetes
GetCluster Response Kubernetes Cluster Cluster Autoscaler Configuration - An object specifying custom cluster autoscaler configuration.
- Kubernetes
GetCluster Response Kubernetes Cluster Control Plane Firewall - An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only).
- Kubernetes
GetCluster Response Kubernetes Cluster Coredns Autoscaler - An object specifying whether the Cluster Proportional Autoscaler (CPA) add-on for CoreDNS should be enabled for the Kubernetes cluster.
- Kubernetes
GetCluster Response Kubernetes Cluster Maintenance Policy - An object specifying the maintenance window policy for the Kubernetes cluster.
- Kubernetes
GetCluster Response Kubernetes Cluster Node Pools Item KubernetesGetClusterResponseKubernetesClusterNodePoolsItem- Kubernetes
GetCluster Response Kubernetes Cluster Node Pools Item Taints Item KubernetesGetClusterResponseKubernetesClusterNodePoolsItemTaintsItem- Kubernetes
GetCluster Response Kubernetes Cluster Nvidia GpuDevice Plugin - An object specifying whether the Nvidia GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an Nvidia GPU node pool.
- Kubernetes
GetCluster Response Kubernetes Cluster P2pOci Registry Plugin - An object specifying whether the Peer-to-peer OCI registry component should be enabled for the Kubernetes cluster.
- Kubernetes
GetCluster Response Kubernetes Cluster Rdma Shared DevPlugin - An object specifying whether the RDMA shared device plugin should be enabled in the Kubernetes cluster.
- Kubernetes
GetCluster Response Kubernetes Cluster Routing Agent - An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster.
- Kubernetes
GetCluster Response Kubernetes Cluster Sso - An object specifying Single Sign-On (SSO) configuration for the Kubernetes cluster.
- Kubernetes
GetCluster Response Kubernetes Cluster Status - An object containing a
stateattribute whose value is set to a string indicating the current status of the cluster. - Kubernetes
GetCluster User Response KubernetesGetClusterUserResponse- Kubernetes
GetCluster User Response Kubernetes Cluster User KubernetesGetClusterUserResponseKubernetesClusterUser- Kubernetes
GetCredentials Response KubernetesGetCredentialsResponse- Kubernetes
GetNode Pool Response KubernetesGetNodePoolResponse- Kubernetes
GetNode Pool Response Node Pool KubernetesGetNodePoolResponseNodePool- Kubernetes
GetNode Pool Response Node Pool Taints Item KubernetesGetNodePoolResponseNodePoolTaintsItem- Kubernetes
GetStatus Messages Response KubernetesGetStatusMessagesResponse- Kubernetes
GetStatus Messages Response Messages Item KubernetesGetStatusMessagesResponseMessagesItem- Kubernetes
List Associated Resources Response - An object containing the IDs of resources associated with a Kubernetes cluster.
- Kubernetes
List Associated Resources Response Load Balancers Item KubernetesListAssociatedResourcesResponseLoadBalancersItem- Kubernetes
List Associated Resources Response Volume Snapshots Item KubernetesListAssociatedResourcesResponseVolumeSnapshotsItem- Kubernetes
List Associated Resources Response Volumes Item KubernetesListAssociatedResourcesResponseVolumesItem- Kubernetes
List Clusters Response KubernetesListClustersResponse- Kubernetes
List Clusters Response Kubernetes Clusters Item KubernetesListClustersResponseKubernetesClustersItem- Kubernetes
List Clusters Response Kubernetes Clusters Item AmdGpu Device Metrics Exporter Plugin - An object specifying whether the AMD Device Metrics Exporter should be enabled in the Kubernetes cluster.
- Kubernetes
List Clusters Response Kubernetes Clusters Item AmdGpu Device Plugin - An object specifying whether the AMD GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an AMD GPU node pool.
- Kubernetes
List Clusters Response Kubernetes Clusters Item Cluster Autoscaler Configuration - An object specifying custom cluster autoscaler configuration.
- Kubernetes
List Clusters Response Kubernetes Clusters Item Control Plane Firewall - An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only).
- Kubernetes
List Clusters Response Kubernetes Clusters Item Coredns Autoscaler - An object specifying whether the Cluster Proportional Autoscaler (CPA) add-on for CoreDNS should be enabled for the Kubernetes cluster.
- Kubernetes
List Clusters Response Kubernetes Clusters Item Maintenance Policy - An object specifying the maintenance window policy for the Kubernetes cluster.
- Kubernetes
List Clusters Response Kubernetes Clusters Item Node Pools Item KubernetesListClustersResponseKubernetesClustersItemNodePoolsItem- Kubernetes
List Clusters Response Kubernetes Clusters Item Node Pools Item Taints Item KubernetesListClustersResponseKubernetesClustersItemNodePoolsItemTaintsItem- Kubernetes
List Clusters Response Kubernetes Clusters Item Nvidia GpuDevice Plugin - An object specifying whether the Nvidia GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an Nvidia GPU node pool.
- Kubernetes
List Clusters Response Kubernetes Clusters Item P2pOci Registry Plugin - An object specifying whether the Peer-to-peer OCI registry component should be enabled for the Kubernetes cluster.
- Kubernetes
List Clusters Response Kubernetes Clusters Item Rdma Shared DevPlugin - An object specifying whether the RDMA shared device plugin should be enabled in the Kubernetes cluster.
- Kubernetes
List Clusters Response Kubernetes Clusters Item Routing Agent - An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster.
- Kubernetes
List Clusters Response Kubernetes Clusters Item Sso - An object specifying Single Sign-On (SSO) configuration for the Kubernetes cluster.
- Kubernetes
List Clusters Response Kubernetes Clusters Item Status - An object containing a
stateattribute whose value is set to a string indicating the current status of the cluster. - Kubernetes
List Clusters Response Links KubernetesListClustersResponseLinks- Kubernetes
List Clusters Response Links Pages KubernetesListClustersResponseLinksPages- Kubernetes
List Clusters Response Links Pages Subtype0 KubernetesListClustersResponseLinksPagesSubtype0- Kubernetes
List Clusters Response Links Pages Subtype1 KubernetesListClustersResponseLinksPagesSubtype1- Kubernetes
List Clusters Response Meta KubernetesListClustersResponseMeta- Kubernetes
List Node Pools Response KubernetesListNodePoolsResponse- Kubernetes
List Node Pools Response Node Pools Item KubernetesListNodePoolsResponseNodePoolsItem- Kubernetes
List Node Pools Response Node Pools Item Taints Item KubernetesListNodePoolsResponseNodePoolsItemTaintsItem- Kubernetes
List Options Response KubernetesListOptionsResponse- Kubernetes
List Options Response Options KubernetesListOptionsResponseOptions- Kubernetes
List Options Response Options Regions Item KubernetesListOptionsResponseOptionsRegionsItem- Kubernetes
List Options Response Options Sizes Item KubernetesListOptionsResponseOptionsSizesItem- Kubernetes
List Options Response Options Versions Item KubernetesListOptionsResponseOptionsVersionsItem- Kubernetes
Recycle Node Pool Body KubernetesRecycleNodePoolBody- Kubernetes
Remove Registries Body KubernetesRemoveRegistriesBody- Kubernetes
Remove Registry Body KubernetesRemoveRegistryBody- Kubernetes
RunCluster Lint Body KubernetesRunClusterLintBody- Kubernetes
RunCluster Lint Response KubernetesRunClusterLintResponse- Kubernetes
Update Cluster Body KubernetesUpdateClusterBody- Kubernetes
Update Cluster Body AmdGpu Device Metrics Exporter Plugin - An object specifying whether the AMD Device Metrics Exporter should be enabled in the Kubernetes cluster.
- Kubernetes
Update Cluster Body AmdGpu Device Plugin - An object specifying whether the AMD GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an AMD GPU node pool.
- Kubernetes
Update Cluster Body Cluster Autoscaler Configuration - An object specifying custom cluster autoscaler configuration.
- Kubernetes
Update Cluster Body Control Plane Firewall - An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only).
- Kubernetes
Update Cluster Body Coredns Autoscaler - An object specifying whether the Cluster Proportional Autoscaler (CPA) add-on for CoreDNS should be enabled for the Kubernetes cluster.
- Kubernetes
Update Cluster Body Maintenance Policy - An object specifying the maintenance window policy for the Kubernetes cluster.
- Kubernetes
Update Cluster Body Nvidia GpuDevice Plugin - An object specifying whether the Nvidia GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an Nvidia GPU node pool.
- Kubernetes
Update Cluster Body P2pOci Registry Plugin - An object specifying whether the Peer-to-peer OCI registry component should be enabled for the Kubernetes cluster.
- Kubernetes
Update Cluster Body Rdma Shared DevPlugin - An object specifying whether the RDMA shared device plugin should be enabled in the Kubernetes cluster.
- Kubernetes
Update Cluster Body Routing Agent - An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster.
- Kubernetes
Update Cluster Body Sso - An object specifying Single Sign-On (SSO) configuration for the Kubernetes cluster.
- Kubernetes
Update Cluster Response KubernetesUpdateClusterResponse- Kubernetes
Update Cluster Response Kubernetes Cluster KubernetesUpdateClusterResponseKubernetesCluster- Kubernetes
Update Cluster Response Kubernetes Cluster AmdGpu Device Metrics Exporter Plugin - An object specifying whether the AMD Device Metrics Exporter should be enabled in the Kubernetes cluster.
- Kubernetes
Update Cluster Response Kubernetes Cluster AmdGpu Device Plugin - An object specifying whether the AMD GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an AMD GPU node pool.
- Kubernetes
Update Cluster Response Kubernetes Cluster Cluster Autoscaler Configuration - An object specifying custom cluster autoscaler configuration.
- Kubernetes
Update Cluster Response Kubernetes Cluster Control Plane Firewall - An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only).
- Kubernetes
Update Cluster Response Kubernetes Cluster Coredns Autoscaler - An object specifying whether the Cluster Proportional Autoscaler (CPA) add-on for CoreDNS should be enabled for the Kubernetes cluster.
- Kubernetes
Update Cluster Response Kubernetes Cluster Maintenance Policy - An object specifying the maintenance window policy for the Kubernetes cluster.
- Kubernetes
Update Cluster Response Kubernetes Cluster Node Pools Item KubernetesUpdateClusterResponseKubernetesClusterNodePoolsItem- Kubernetes
Update Cluster Response Kubernetes Cluster Node Pools Item Taints Item KubernetesUpdateClusterResponseKubernetesClusterNodePoolsItemTaintsItem- Kubernetes
Update Cluster Response Kubernetes Cluster Nvidia GpuDevice Plugin - An object specifying whether the Nvidia GPU Device Plugin should be enabled in the Kubernetes cluster. It’s enabled by default for clusters with an Nvidia GPU node pool.
- Kubernetes
Update Cluster Response Kubernetes Cluster P2pOci Registry Plugin - An object specifying whether the Peer-to-peer OCI registry component should be enabled for the Kubernetes cluster.
- Kubernetes
Update Cluster Response Kubernetes Cluster Rdma Shared DevPlugin - An object specifying whether the RDMA shared device plugin should be enabled in the Kubernetes cluster.
- Kubernetes
Update Cluster Response Kubernetes Cluster Routing Agent - An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster.
- Kubernetes
Update Cluster Response Kubernetes Cluster Sso - An object specifying Single Sign-On (SSO) configuration for the Kubernetes cluster.
- Kubernetes
Update Cluster Response Kubernetes Cluster Status - An object containing a
stateattribute whose value is set to a string indicating the current status of the cluster. - Kubernetes
Update Node Pool Body KubernetesUpdateNodePoolBody- Kubernetes
Update Node Pool Body Taints Item KubernetesUpdateNodePoolBodyTaintsItem- Kubernetes
Update Node Pool Response KubernetesUpdateNodePoolResponse- Kubernetes
Update Node Pool Response Node Pool KubernetesUpdateNodePoolResponseNodePool- Kubernetes
Update Node Pool Response Node Pool Taints Item KubernetesUpdateNodePoolResponseNodePoolTaintsItem- Kubernetes
Upgrade Cluster Body KubernetesUpgradeClusterBody- List
OfTxt Validation Records Item ListOfTxtValidationRecordsItem- Load
Balancers AddDroplets Body LoadBalancersAddDropletsBody- Load
Balancers AddForwarding Rules Body LoadBalancersAddForwardingRulesBody- Load
Balancers AddForwarding Rules Body Forwarding Rules Item - An object specifying a forwarding rule for a load balancer.
- Load
Balancers Create Response LoadBalancersCreateResponse- Load
Balancers Create Response Load Balancer LoadBalancersCreateResponseLoadBalancer- Load
Balancers Create Response Load Balancer Domains Item - An object specifying domain configurations for a Global load balancer.
- Load
Balancers Create Response Load Balancer Firewall - An object specifying allow and deny rules to control traffic to the load balancer.
- Load
Balancers Create Response Load Balancer Forwarding Rules Item - An object specifying a forwarding rule for a load balancer.
- Load
Balancers Create Response Load Balancer GlbSettings - An object specifying forwarding configurations for a Global load balancer.
- Load
Balancers Create Response Load Balancer GlbSettings Cdn - An object specifying CDN configurations for a Global load balancer.
- Load
Balancers Create Response Load Balancer Health Check - An object specifying health check settings for the load balancer.
- Load
Balancers Create Response Load Balancer Ip - An attribute containing the public-facing IP address of the load balancer.
- Load
Balancers Create Response Load Balancer Region LoadBalancersCreateResponseLoadBalancerRegion- Load
Balancers Create Response Load Balancer Sticky Sessions - An object specifying sticky sessions settings for the load balancer.
- Load
Balancers GetResponse LoadBalancersGetResponse- Load
Balancers GetResponse Load Balancer LoadBalancersGetResponseLoadBalancer- Load
Balancers GetResponse Load Balancer Domains Item - An object specifying domain configurations for a Global load balancer.
- Load
Balancers GetResponse Load Balancer Firewall - An object specifying allow and deny rules to control traffic to the load balancer.
- Load
Balancers GetResponse Load Balancer Forwarding Rules Item - An object specifying a forwarding rule for a load balancer.
- Load
Balancers GetResponse Load Balancer GlbSettings - An object specifying forwarding configurations for a Global load balancer.
- Load
Balancers GetResponse Load Balancer GlbSettings Cdn - An object specifying CDN configurations for a Global load balancer.
- Load
Balancers GetResponse Load Balancer Health Check - An object specifying health check settings for the load balancer.
- Load
Balancers GetResponse Load Balancer Ip - An attribute containing the public-facing IP address of the load balancer.
- Load
Balancers GetResponse Load Balancer Region LoadBalancersGetResponseLoadBalancerRegion- Load
Balancers GetResponse Load Balancer Sticky Sessions - An object specifying sticky sessions settings for the load balancer.
- Load
Balancers List Response LoadBalancersListResponse- Load
Balancers List Response Links LoadBalancersListResponseLinks- Load
Balancers List Response Links Pages LoadBalancersListResponseLinksPages- Load
Balancers List Response Links Pages Subtype0 LoadBalancersListResponseLinksPagesSubtype0- Load
Balancers List Response Links Pages Subtype1 LoadBalancersListResponseLinksPagesSubtype1- Load
Balancers List Response Load Balancers Item LoadBalancersListResponseLoadBalancersItem- Load
Balancers List Response Load Balancers Item Domains Item - An object specifying domain configurations for a Global load balancer.
- Load
Balancers List Response Load Balancers Item Firewall - An object specifying allow and deny rules to control traffic to the load balancer.
- Load
Balancers List Response Load Balancers Item Forwarding Rules Item - An object specifying a forwarding rule for a load balancer.
- Load
Balancers List Response Load Balancers Item GlbSettings - An object specifying forwarding configurations for a Global load balancer.
- Load
Balancers List Response Load Balancers Item GlbSettings Cdn - An object specifying CDN configurations for a Global load balancer.
- Load
Balancers List Response Load Balancers Item Health Check - An object specifying health check settings for the load balancer.
- Load
Balancers List Response Load Balancers Item Ip - An attribute containing the public-facing IP address of the load balancer.
- Load
Balancers List Response Load Balancers Item Region LoadBalancersListResponseLoadBalancersItemRegion- Load
Balancers List Response Load Balancers Item Sticky Sessions - An object specifying sticky sessions settings for the load balancer.
- Load
Balancers List Response Meta LoadBalancersListResponseMeta- Load
Balancers Remove Droplets Body LoadBalancersRemoveDropletsBody- Load
Balancers Remove Forwarding Rules Body LoadBalancersRemoveForwardingRulesBody- Load
Balancers Remove Forwarding Rules Body Forwarding Rules Item - An object specifying a forwarding rule for a load balancer.
- Load
Balancers Update Response LoadBalancersUpdateResponse- Load
Balancers Update Response Load Balancer LoadBalancersUpdateResponseLoadBalancer- Load
Balancers Update Response Load Balancer Domains Item - An object specifying domain configurations for a Global load balancer.
- Load
Balancers Update Response Load Balancer Firewall - An object specifying allow and deny rules to control traffic to the load balancer.
- Load
Balancers Update Response Load Balancer Forwarding Rules Item - An object specifying a forwarding rule for a load balancer.
- Load
Balancers Update Response Load Balancer GlbSettings - An object specifying forwarding configurations for a Global load balancer.
- Load
Balancers Update Response Load Balancer GlbSettings Cdn - An object specifying CDN configurations for a Global load balancer.
- Load
Balancers Update Response Load Balancer Health Check - An object specifying health check settings for the load balancer.
- Load
Balancers Update Response Load Balancer Ip - An attribute containing the public-facing IP address of the load balancer.
- Load
Balancers Update Response Load Balancer Region LoadBalancersUpdateResponseLoadBalancerRegion- Load
Balancers Update Response Load Balancer Sticky Sessions - An object specifying sticky sessions settings for the load balancer.
- Metadata
Item MetadataItem- Mitigation
Steps Item MitigationStepsItem- Monitoring
Create Alert Policy Body MonitoringCreateAlertPolicyBody- Monitoring
Create Alert Policy Body Alerts MonitoringCreateAlertPolicyBodyAlerts- Monitoring
Create Alert Policy Body Alerts Slack Item MonitoringCreateAlertPolicyBodyAlertsSlackItem- Monitoring
Create Alert Policy Response MonitoringCreateAlertPolicyResponse- Monitoring
Create Alert Policy Response Policy MonitoringCreateAlertPolicyResponsePolicy- Monitoring
Create Alert Policy Response Policy Alerts MonitoringCreateAlertPolicyResponsePolicyAlerts- Monitoring
Create Alert Policy Response Policy Alerts Slack Item MonitoringCreateAlertPolicyResponsePolicyAlertsSlackItem- Monitoring
Create Destination Body MonitoringCreateDestinationBody- Monitoring
Create Destination Body Config MonitoringCreateDestinationBodyConfig- Monitoring
Create Destination Body Config Credentials - Credentials for an OpenSearch cluster user. Optional if
cluster_uuidis passed. - Monitoring
Create Destination Response MonitoringCreateDestinationResponse- Monitoring
Create Destination Response Destination MonitoringCreateDestinationResponseDestination- Monitoring
Create Destination Response Destination Config - OpenSearch destination configuration with
credentialsomitted. - Monitoring
Create Sink Body MonitoringCreateSinkBody- Monitoring
Create Sink Body Resources Item MonitoringCreateSinkBodyResourcesItem- Monitoring
Create Sink Body Resources Item Urn - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Monitoring
GetAlert Policy Response MonitoringGetAlertPolicyResponse- Monitoring
GetAlert Policy Response Policy MonitoringGetAlertPolicyResponsePolicy- Monitoring
GetAlert Policy Response Policy Alerts MonitoringGetAlertPolicyResponsePolicyAlerts- Monitoring
GetAlert Policy Response Policy Alerts Slack Item MonitoringGetAlertPolicyResponsePolicyAlertsSlackItem- Monitoring
GetApp CpuPercentage Metrics Response MonitoringGetAppCpuPercentageMetricsResponse- Monitoring
GetApp CpuPercentage Metrics Response Data MonitoringGetAppCpuPercentageMetricsResponseData- Monitoring
GetApp CpuPercentage Metrics Response Data Result Item MonitoringGetAppCpuPercentageMetricsResponseDataResultItem- Monitoring
GetApp Memory Percentage Metrics Response MonitoringGetAppMemoryPercentageMetricsResponse- Monitoring
GetApp Memory Percentage Metrics Response Data MonitoringGetAppMemoryPercentageMetricsResponseData- Monitoring
GetApp Memory Percentage Metrics Response Data Result Item MonitoringGetAppMemoryPercentageMetricsResponseDataResultItem- Monitoring
GetApp Restart Count Metrics YmlResponse MonitoringGetAppRestartCountMetricsYmlResponse- Monitoring
GetApp Restart Count Metrics YmlResponse Data MonitoringGetAppRestartCountMetricsYmlResponseData- Monitoring
GetApp Restart Count Metrics YmlResponse Data Result Item MonitoringGetAppRestartCountMetricsYmlResponseDataResultItem- Monitoring
GetDatabase Mysql CpuUsage Response MonitoringGetDatabaseMysqlCpuUsageResponse- Monitoring
GetDatabase Mysql CpuUsage Response Data MonitoringGetDatabaseMysqlCpuUsageResponseData- Monitoring
GetDatabase Mysql CpuUsage Response Data Result Item MonitoringGetDatabaseMysqlCpuUsageResponseDataResultItem- Monitoring
GetDatabase Mysql Disk Usage Response MonitoringGetDatabaseMysqlDiskUsageResponse- Monitoring
GetDatabase Mysql Disk Usage Response Data MonitoringGetDatabaseMysqlDiskUsageResponseData- Monitoring
GetDatabase Mysql Disk Usage Response Data Result Item MonitoringGetDatabaseMysqlDiskUsageResponseDataResultItem- Monitoring
GetDatabase Mysql Index VsSequential Reads Response MonitoringGetDatabaseMysqlIndexVsSequentialReadsResponse- Monitoring
GetDatabase Mysql Index VsSequential Reads Response Data MonitoringGetDatabaseMysqlIndexVsSequentialReadsResponseData- Monitoring
GetDatabase Mysql Index VsSequential Reads Response Data Result Item MonitoringGetDatabaseMysqlIndexVsSequentialReadsResponseDataResultItem- Monitoring
GetDatabase Mysql Load Response MonitoringGetDatabaseMysqlLoadResponse- Monitoring
GetDatabase Mysql Load Response Data MonitoringGetDatabaseMysqlLoadResponseData- Monitoring
GetDatabase Mysql Load Response Data Result Item MonitoringGetDatabaseMysqlLoadResponseDataResultItem- Monitoring
GetDatabase Mysql Memory Usage Response MonitoringGetDatabaseMysqlMemoryUsageResponse- Monitoring
GetDatabase Mysql Memory Usage Response Data MonitoringGetDatabaseMysqlMemoryUsageResponseData- Monitoring
GetDatabase Mysql Memory Usage Response Data Result Item MonitoringGetDatabaseMysqlMemoryUsageResponseDataResultItem- Monitoring
GetDatabase Mysql OpRates Response MonitoringGetDatabaseMysqlOpRatesResponse- Monitoring
GetDatabase Mysql OpRates Response Data MonitoringGetDatabaseMysqlOpRatesResponseData- Monitoring
GetDatabase Mysql OpRates Response Data Result Item MonitoringGetDatabaseMysqlOpRatesResponseDataResultItem- Monitoring
GetDatabase Mysql Schema Latency Response MonitoringGetDatabaseMysqlSchemaLatencyResponse- Monitoring
GetDatabase Mysql Schema Latency Response Data MonitoringGetDatabaseMysqlSchemaLatencyResponseData- Monitoring
GetDatabase Mysql Schema Latency Response Data Result Item MonitoringGetDatabaseMysqlSchemaLatencyResponseDataResultItem- Monitoring
GetDatabase Mysql Schema Throughput Response MonitoringGetDatabaseMysqlSchemaThroughputResponse- Monitoring
GetDatabase Mysql Schema Throughput Response Data MonitoringGetDatabaseMysqlSchemaThroughputResponseData- Monitoring
GetDatabase Mysql Schema Throughput Response Data Result Item MonitoringGetDatabaseMysqlSchemaThroughputResponseDataResultItem- Monitoring
GetDatabase Mysql Threads Active Response MonitoringGetDatabaseMysqlThreadsActiveResponse- Monitoring
GetDatabase Mysql Threads Active Response Data MonitoringGetDatabaseMysqlThreadsActiveResponseData- Monitoring
GetDatabase Mysql Threads Active Response Data Result Item MonitoringGetDatabaseMysqlThreadsActiveResponseDataResultItem- Monitoring
GetDatabase Mysql Threads Connected Response MonitoringGetDatabaseMysqlThreadsConnectedResponse- Monitoring
GetDatabase Mysql Threads Connected Response Data MonitoringGetDatabaseMysqlThreadsConnectedResponseData- Monitoring
GetDatabase Mysql Threads Connected Response Data Result Item MonitoringGetDatabaseMysqlThreadsConnectedResponseDataResultItem- Monitoring
GetDatabase Mysql Threads Created Rate Response MonitoringGetDatabaseMysqlThreadsCreatedRateResponse- Monitoring
GetDatabase Mysql Threads Created Rate Response Data MonitoringGetDatabaseMysqlThreadsCreatedRateResponseData- Monitoring
GetDatabase Mysql Threads Created Rate Response Data Result Item MonitoringGetDatabaseMysqlThreadsCreatedRateResponseDataResultItem- Monitoring
GetDestination Response MonitoringGetDestinationResponse- Monitoring
GetDestination Response Destination MonitoringGetDestinationResponseDestination- Monitoring
GetDestination Response Destination Config - OpenSearch destination configuration with
credentialsomitted. - Monitoring
GetDroplet Autoscale Current CpuUtilization YmlResponse MonitoringGetDropletAutoscaleCurrentCpuUtilizationYmlResponse- Monitoring
GetDroplet Autoscale Current CpuUtilization YmlResponse Data MonitoringGetDropletAutoscaleCurrentCpuUtilizationYmlResponseData- Monitoring
GetDroplet Autoscale Current CpuUtilization YmlResponse Data Result Item MonitoringGetDropletAutoscaleCurrentCpuUtilizationYmlResponseDataResultItem- Monitoring
GetDroplet Autoscale Current Instances Response MonitoringGetDropletAutoscaleCurrentInstancesResponse- Monitoring
GetDroplet Autoscale Current Instances Response Data MonitoringGetDropletAutoscaleCurrentInstancesResponseData- Monitoring
GetDroplet Autoscale Current Instances Response Data Result Item MonitoringGetDropletAutoscaleCurrentInstancesResponseDataResultItem- Monitoring
GetDroplet Autoscale Current Memory Utilization Response MonitoringGetDropletAutoscaleCurrentMemoryUtilizationResponse- Monitoring
GetDroplet Autoscale Current Memory Utilization Response Data MonitoringGetDropletAutoscaleCurrentMemoryUtilizationResponseData- Monitoring
GetDroplet Autoscale Current Memory Utilization Response Data Result Item MonitoringGetDropletAutoscaleCurrentMemoryUtilizationResponseDataResultItem- Monitoring
GetDroplet Autoscale Target CpuUtilization Response MonitoringGetDropletAutoscaleTargetCpuUtilizationResponse- Monitoring
GetDroplet Autoscale Target CpuUtilization Response Data MonitoringGetDropletAutoscaleTargetCpuUtilizationResponseData- Monitoring
GetDroplet Autoscale Target CpuUtilization Response Data Result Item MonitoringGetDropletAutoscaleTargetCpuUtilizationResponseDataResultItem- Monitoring
GetDroplet Autoscale Target Instances Response MonitoringGetDropletAutoscaleTargetInstancesResponse- Monitoring
GetDroplet Autoscale Target Instances Response Data MonitoringGetDropletAutoscaleTargetInstancesResponseData- Monitoring
GetDroplet Autoscale Target Instances Response Data Result Item MonitoringGetDropletAutoscaleTargetInstancesResponseDataResultItem- Monitoring
GetDroplet Autoscale Target Memory Utilization Response MonitoringGetDropletAutoscaleTargetMemoryUtilizationResponse- Monitoring
GetDroplet Autoscale Target Memory Utilization Response Data MonitoringGetDropletAutoscaleTargetMemoryUtilizationResponseData- Monitoring
GetDroplet Autoscale Target Memory Utilization Response Data Result Item MonitoringGetDropletAutoscaleTargetMemoryUtilizationResponseDataResultItem- Monitoring
GetDroplet Bandwidth Metrics Response MonitoringGetDropletBandwidthMetricsResponse- Monitoring
GetDroplet Bandwidth Metrics Response Data MonitoringGetDropletBandwidthMetricsResponseData- Monitoring
GetDroplet Bandwidth Metrics Response Data Result Item MonitoringGetDropletBandwidthMetricsResponseDataResultItem- Monitoring
GetDroplet CpuMetrics Response MonitoringGetDropletCpuMetricsResponse- Monitoring
GetDroplet CpuMetrics Response Data MonitoringGetDropletCpuMetricsResponseData- Monitoring
GetDroplet CpuMetrics Response Data Result Item MonitoringGetDropletCpuMetricsResponseDataResultItem- Monitoring
GetDroplet Filesystem Free Metrics Response MonitoringGetDropletFilesystemFreeMetricsResponse- Monitoring
GetDroplet Filesystem Free Metrics Response Data MonitoringGetDropletFilesystemFreeMetricsResponseData- Monitoring
GetDroplet Filesystem Free Metrics Response Data Result Item MonitoringGetDropletFilesystemFreeMetricsResponseDataResultItem- Monitoring
GetDroplet Filesystem Size Metrics Response MonitoringGetDropletFilesystemSizeMetricsResponse- Monitoring
GetDroplet Filesystem Size Metrics Response Data MonitoringGetDropletFilesystemSizeMetricsResponseData- Monitoring
GetDroplet Filesystem Size Metrics Response Data Result Item MonitoringGetDropletFilesystemSizeMetricsResponseDataResultItem- Monitoring
GetDroplet Load1 Metrics Response MonitoringGetDropletLoad1MetricsResponse- Monitoring
GetDroplet Load1 Metrics Response Data MonitoringGetDropletLoad1MetricsResponseData- Monitoring
GetDroplet Load1 Metrics Response Data Result Item MonitoringGetDropletLoad1MetricsResponseDataResultItem- Monitoring
GetDroplet Load5 Metrics Response MonitoringGetDropletLoad5MetricsResponse- Monitoring
GetDroplet Load5 Metrics Response Data MonitoringGetDropletLoad5MetricsResponseData- Monitoring
GetDroplet Load5 Metrics Response Data Result Item MonitoringGetDropletLoad5MetricsResponseDataResultItem- Monitoring
GetDroplet Load15 Metrics Response MonitoringGetDropletLoad15MetricsResponse- Monitoring
GetDroplet Load15 Metrics Response Data MonitoringGetDropletLoad15MetricsResponseData- Monitoring
GetDroplet Load15 Metrics Response Data Result Item MonitoringGetDropletLoad15MetricsResponseDataResultItem- Monitoring
GetDroplet Memory Available Metrics Response MonitoringGetDropletMemoryAvailableMetricsResponse- Monitoring
GetDroplet Memory Available Metrics Response Data MonitoringGetDropletMemoryAvailableMetricsResponseData- Monitoring
GetDroplet Memory Available Metrics Response Data Result Item MonitoringGetDropletMemoryAvailableMetricsResponseDataResultItem- Monitoring
GetDroplet Memory Cached Metrics Response MonitoringGetDropletMemoryCachedMetricsResponse- Monitoring
GetDroplet Memory Cached Metrics Response Data MonitoringGetDropletMemoryCachedMetricsResponseData- Monitoring
GetDroplet Memory Cached Metrics Response Data Result Item MonitoringGetDropletMemoryCachedMetricsResponseDataResultItem- Monitoring
GetDroplet Memory Free Metrics Response MonitoringGetDropletMemoryFreeMetricsResponse- Monitoring
GetDroplet Memory Free Metrics Response Data MonitoringGetDropletMemoryFreeMetricsResponseData- Monitoring
GetDroplet Memory Free Metrics Response Data Result Item MonitoringGetDropletMemoryFreeMetricsResponseDataResultItem- Monitoring
GetDroplet Memory Total Metrics Response MonitoringGetDropletMemoryTotalMetricsResponse- Monitoring
GetDroplet Memory Total Metrics Response Data MonitoringGetDropletMemoryTotalMetricsResponseData- Monitoring
GetDroplet Memory Total Metrics Response Data Result Item MonitoringGetDropletMemoryTotalMetricsResponseDataResultItem- Monitoring
GetLb Droplets Connections Response MonitoringGetLbDropletsConnectionsResponse- Monitoring
GetLb Droplets Connections Response Data MonitoringGetLbDropletsConnectionsResponseData- Monitoring
GetLb Droplets Connections Response Data Result Item MonitoringGetLbDropletsConnectionsResponseDataResultItem- Monitoring
GetLb Droplets Downtime Response MonitoringGetLbDropletsDowntimeResponse- Monitoring
GetLb Droplets Downtime Response Data MonitoringGetLbDropletsDowntimeResponseData- Monitoring
GetLb Droplets Downtime Response Data Result Item MonitoringGetLbDropletsDowntimeResponseDataResultItem- Monitoring
GetLb Droplets Health Checks Response MonitoringGetLbDropletsHealthChecksResponse- Monitoring
GetLb Droplets Health Checks Response Data MonitoringGetLbDropletsHealthChecksResponseData- Monitoring
GetLb Droplets Health Checks Response Data Result Item MonitoringGetLbDropletsHealthChecksResponseDataResultItem- Monitoring
GetLb Droplets Http Response Time50p Response MonitoringGetLbDropletsHttpResponseTime50pResponse- Monitoring
GetLb Droplets Http Response Time50p Response Data MonitoringGetLbDropletsHttpResponseTime50pResponseData- Monitoring
GetLb Droplets Http Response Time50p Response Data Result Item MonitoringGetLbDropletsHttpResponseTime50pResponseDataResultItem- Monitoring
GetLb Droplets Http Response Time95p Response MonitoringGetLbDropletsHttpResponseTime95pResponse- Monitoring
GetLb Droplets Http Response Time95p Response Data MonitoringGetLbDropletsHttpResponseTime95pResponseData- Monitoring
GetLb Droplets Http Response Time95p Response Data Result Item MonitoringGetLbDropletsHttpResponseTime95pResponseDataResultItem- Monitoring
GetLb Droplets Http Response Time99p Response MonitoringGetLbDropletsHttpResponseTime99pResponse- Monitoring
GetLb Droplets Http Response Time99p Response Data MonitoringGetLbDropletsHttpResponseTime99pResponseData- Monitoring
GetLb Droplets Http Response Time99p Response Data Result Item MonitoringGetLbDropletsHttpResponseTime99pResponseDataResultItem- Monitoring
GetLb Droplets Http Response Time AvgResponse MonitoringGetLbDropletsHttpResponseTimeAvgResponse- Monitoring
GetLb Droplets Http Response Time AvgResponse Data MonitoringGetLbDropletsHttpResponseTimeAvgResponseData- Monitoring
GetLb Droplets Http Response Time AvgResponse Data Result Item MonitoringGetLbDropletsHttpResponseTimeAvgResponseDataResultItem- Monitoring
GetLb Droplets Http Responses Response MonitoringGetLbDropletsHttpResponsesResponse- Monitoring
GetLb Droplets Http Responses Response Data MonitoringGetLbDropletsHttpResponsesResponseData- Monitoring
GetLb Droplets Http Responses Response Data Result Item MonitoringGetLbDropletsHttpResponsesResponseDataResultItem- Monitoring
GetLb Droplets Http Session Duration50p Response MonitoringGetLbDropletsHttpSessionDuration50pResponse- Monitoring
GetLb Droplets Http Session Duration50p Response Data MonitoringGetLbDropletsHttpSessionDuration50pResponseData- Monitoring
GetLb Droplets Http Session Duration50p Response Data Result Item MonitoringGetLbDropletsHttpSessionDuration50pResponseDataResultItem- Monitoring
GetLb Droplets Http Session Duration95p Response MonitoringGetLbDropletsHttpSessionDuration95pResponse- Monitoring
GetLb Droplets Http Session Duration95p Response Data MonitoringGetLbDropletsHttpSessionDuration95pResponseData- Monitoring
GetLb Droplets Http Session Duration95p Response Data Result Item MonitoringGetLbDropletsHttpSessionDuration95pResponseDataResultItem- Monitoring
GetLb Droplets Http Session Duration AvgResponse MonitoringGetLbDropletsHttpSessionDurationAvgResponse- Monitoring
GetLb Droplets Http Session Duration AvgResponse Data MonitoringGetLbDropletsHttpSessionDurationAvgResponseData- Monitoring
GetLb Droplets Http Session Duration AvgResponse Data Result Item MonitoringGetLbDropletsHttpSessionDurationAvgResponseDataResultItem- Monitoring
GetLb Droplets Queue Size Response MonitoringGetLbDropletsQueueSizeResponse- Monitoring
GetLb Droplets Queue Size Response Data MonitoringGetLbDropletsQueueSizeResponseData- Monitoring
GetLb Droplets Queue Size Response Data Result Item MonitoringGetLbDropletsQueueSizeResponseDataResultItem- Monitoring
GetLb Frontend Connections Current Response MonitoringGetLbFrontendConnectionsCurrentResponse- Monitoring
GetLb Frontend Connections Current Response Data MonitoringGetLbFrontendConnectionsCurrentResponseData- Monitoring
GetLb Frontend Connections Current Response Data Result Item MonitoringGetLbFrontendConnectionsCurrentResponseDataResultItem- Monitoring
GetLb Frontend Connections Limit Response MonitoringGetLbFrontendConnectionsLimitResponse- Monitoring
GetLb Frontend Connections Limit Response Data MonitoringGetLbFrontendConnectionsLimitResponseData- Monitoring
GetLb Frontend Connections Limit Response Data Result Item MonitoringGetLbFrontendConnectionsLimitResponseDataResultItem- Monitoring
GetLb Frontend CpuUtilization Response MonitoringGetLbFrontendCpuUtilizationResponse- Monitoring
GetLb Frontend CpuUtilization Response Data MonitoringGetLbFrontendCpuUtilizationResponseData- Monitoring
GetLb Frontend CpuUtilization Response Data Result Item MonitoringGetLbFrontendCpuUtilizationResponseDataResultItem- Monitoring
GetLb Frontend Firewall Dropped Bytes Response MonitoringGetLbFrontendFirewallDroppedBytesResponse- Monitoring
GetLb Frontend Firewall Dropped Bytes Response Data MonitoringGetLbFrontendFirewallDroppedBytesResponseData- Monitoring
GetLb Frontend Firewall Dropped Bytes Response Data Result Item MonitoringGetLbFrontendFirewallDroppedBytesResponseDataResultItem- Monitoring
GetLb Frontend Firewall Dropped Packets Response MonitoringGetLbFrontendFirewallDroppedPacketsResponse- Monitoring
GetLb Frontend Firewall Dropped Packets Response Data MonitoringGetLbFrontendFirewallDroppedPacketsResponseData- Monitoring
GetLb Frontend Firewall Dropped Packets Response Data Result Item MonitoringGetLbFrontendFirewallDroppedPacketsResponseDataResultItem- Monitoring
GetLb Frontend Http Requests PerSecond Response MonitoringGetLbFrontendHttpRequestsPerSecondResponse- Monitoring
GetLb Frontend Http Requests PerSecond Response Data MonitoringGetLbFrontendHttpRequestsPerSecondResponseData- Monitoring
GetLb Frontend Http Requests PerSecond Response Data Result Item MonitoringGetLbFrontendHttpRequestsPerSecondResponseDataResultItem- Monitoring
GetLb Frontend Http Responses Response MonitoringGetLbFrontendHttpResponsesResponse- Monitoring
GetLb Frontend Http Responses Response Data MonitoringGetLbFrontendHttpResponsesResponseData- Monitoring
GetLb Frontend Http Responses Response Data Result Item MonitoringGetLbFrontendHttpResponsesResponseDataResultItem- Monitoring
GetLb Frontend Network Throughput Http Response MonitoringGetLbFrontendNetworkThroughputHttpResponse- Monitoring
GetLb Frontend Network Throughput Http Response Data MonitoringGetLbFrontendNetworkThroughputHttpResponseData- Monitoring
GetLb Frontend Network Throughput Http Response Data Result Item MonitoringGetLbFrontendNetworkThroughputHttpResponseDataResultItem- Monitoring
GetLb Frontend Network Throughput TcpResponse MonitoringGetLbFrontendNetworkThroughputTcpResponse- Monitoring
GetLb Frontend Network Throughput TcpResponse Data MonitoringGetLbFrontendNetworkThroughputTcpResponseData- Monitoring
GetLb Frontend Network Throughput TcpResponse Data Result Item MonitoringGetLbFrontendNetworkThroughputTcpResponseDataResultItem- Monitoring
GetLb Frontend Network Throughput UdpResponse MonitoringGetLbFrontendNetworkThroughputUdpResponse- Monitoring
GetLb Frontend Network Throughput UdpResponse Data MonitoringGetLbFrontendNetworkThroughputUdpResponseData- Monitoring
GetLb Frontend Network Throughput UdpResponse Data Result Item MonitoringGetLbFrontendNetworkThroughputUdpResponseDataResultItem- Monitoring
GetLb Frontend NlbTcp Network Throughput Response MonitoringGetLbFrontendNlbTcpNetworkThroughputResponse- Monitoring
GetLb Frontend NlbTcp Network Throughput Response Data MonitoringGetLbFrontendNlbTcpNetworkThroughputResponseData- Monitoring
GetLb Frontend NlbTcp Network Throughput Response Data Result Item MonitoringGetLbFrontendNlbTcpNetworkThroughputResponseDataResultItem- Monitoring
GetLb Frontend NlbUdp Network Throughput Response MonitoringGetLbFrontendNlbUdpNetworkThroughputResponse- Monitoring
GetLb Frontend NlbUdp Network Throughput Response Data MonitoringGetLbFrontendNlbUdpNetworkThroughputResponseData- Monitoring
GetLb Frontend NlbUdp Network Throughput Response Data Result Item MonitoringGetLbFrontendNlbUdpNetworkThroughputResponseDataResultItem- Monitoring
GetLb Frontend TlsConnections Current Response MonitoringGetLbFrontendTlsConnectionsCurrentResponse- Monitoring
GetLb Frontend TlsConnections Current Response Data MonitoringGetLbFrontendTlsConnectionsCurrentResponseData- Monitoring
GetLb Frontend TlsConnections Current Response Data Result Item MonitoringGetLbFrontendTlsConnectionsCurrentResponseDataResultItem- Monitoring
GetLb Frontend TlsConnections Exceeding Rate Limit Response MonitoringGetLbFrontendTlsConnectionsExceedingRateLimitResponse- Monitoring
GetLb Frontend TlsConnections Exceeding Rate Limit Response Data MonitoringGetLbFrontendTlsConnectionsExceedingRateLimitResponseData- Monitoring
GetLb Frontend TlsConnections Exceeding Rate Limit Response Data Result Item MonitoringGetLbFrontendTlsConnectionsExceedingRateLimitResponseDataResultItem- Monitoring
GetLb Frontend TlsConnections Limit Response MonitoringGetLbFrontendTlsConnectionsLimitResponse- Monitoring
GetLb Frontend TlsConnections Limit Response Data MonitoringGetLbFrontendTlsConnectionsLimitResponseData- Monitoring
GetLb Frontend TlsConnections Limit Response Data Result Item MonitoringGetLbFrontendTlsConnectionsLimitResponseDataResultItem- Monitoring
GetSink Response MonitoringGetSinkResponse- Monitoring
GetSink Response Sink MonitoringGetSinkResponseSink- Monitoring
GetSink Response Sink Destination MonitoringGetSinkResponseSinkDestination- Monitoring
GetSink Response Sink Destination Config MonitoringGetSinkResponseSinkDestinationConfig- Monitoring
GetSink Response Sink Destination Config Credentials - Credentials for an OpenSearch cluster user. Optional if
cluster_uuidis passed. - Monitoring
GetSink Response Sink Resources Item MonitoringGetSinkResponseSinkResourcesItem- Monitoring
GetSink Response Sink Resources Item Urn - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Monitoring
List Alert Policy Response MonitoringListAlertPolicyResponse- Monitoring
List Alert Policy Response Links MonitoringListAlertPolicyResponseLinks- Monitoring
List Alert Policy Response Links Pages MonitoringListAlertPolicyResponseLinksPages- Monitoring
List Alert Policy Response Links Pages Subtype0 MonitoringListAlertPolicyResponseLinksPagesSubtype0- Monitoring
List Alert Policy Response Links Pages Subtype1 MonitoringListAlertPolicyResponseLinksPagesSubtype1- Monitoring
List Alert Policy Response Meta MonitoringListAlertPolicyResponseMeta- Monitoring
List Alert Policy Response Policies Item MonitoringListAlertPolicyResponsePoliciesItem- Monitoring
List Alert Policy Response Policies Item Alerts MonitoringListAlertPolicyResponsePoliciesItemAlerts- Monitoring
List Alert Policy Response Policies Item Alerts Slack Item MonitoringListAlertPolicyResponsePoliciesItemAlertsSlackItem- Monitoring
List Destinations Response MonitoringListDestinationsResponse- Monitoring
List Destinations Response Destinations Item MonitoringListDestinationsResponseDestinationsItem- Monitoring
List Destinations Response Destinations Item Config - OpenSearch destination configuration with
credentialsomitted. - Monitoring
List Sinks Resource Id - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Monitoring
List Sinks Response MonitoringListSinksResponse- Monitoring
List Sinks Response Sinks Item MonitoringListSinksResponseSinksItem- Monitoring
List Sinks Response Sinks Item Destination MonitoringListSinksResponseSinksItemDestination- Monitoring
List Sinks Response Sinks Item Destination Config MonitoringListSinksResponseSinksItemDestinationConfig- Monitoring
List Sinks Response Sinks Item Destination Config Credentials - Credentials for an OpenSearch cluster user. Optional if
cluster_uuidis passed. - Monitoring
List Sinks Response Sinks Item Resources Item MonitoringListSinksResponseSinksItemResourcesItem- Monitoring
List Sinks Response Sinks Item Resources Item Urn - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Monitoring
Update Alert Policy Body MonitoringUpdateAlertPolicyBody- Monitoring
Update Alert Policy Body Alerts MonitoringUpdateAlertPolicyBodyAlerts- Monitoring
Update Alert Policy Body Alerts Slack Item MonitoringUpdateAlertPolicyBodyAlertsSlackItem- Monitoring
Update Alert Policy Response MonitoringUpdateAlertPolicyResponse- Monitoring
Update Alert Policy Response Policy MonitoringUpdateAlertPolicyResponsePolicy- Monitoring
Update Alert Policy Response Policy Alerts MonitoringUpdateAlertPolicyResponsePolicyAlerts- Monitoring
Update Alert Policy Response Policy Alerts Slack Item MonitoringUpdateAlertPolicyResponsePolicyAlertsSlackItem- Monitoring
Update Destination Body MonitoringUpdateDestinationBody- Monitoring
Update Destination Body Config MonitoringUpdateDestinationBodyConfig- Monitoring
Update Destination Body Config Credentials - Credentials for an OpenSearch cluster user. Optional if
cluster_uuidis passed. - Multiple
Droplet Request Backup Policy MultipleDropletRequestBackupPolicy- Multiple
Droplet Request Backup Policy Hour - The hour of the day that the backup window will start.
- Multiple
Droplet Request Names Item MultipleDropletRequestNamesItem- Multiple
Droplet Response Droplets Item MultipleDropletResponseDropletsItem- Multiple
Droplet Response Droplets Item Disk Info Item MultipleDropletResponseDropletsItemDiskInfoItem- Multiple
Droplet Response Droplets Item Disk Info Item Size MultipleDropletResponseDropletsItemDiskInfoItemSize- Multiple
Droplet Response Droplets Item GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Multiple
Droplet Response Droplets Item GpuInfo Vram MultipleDropletResponseDropletsItemGpuInfoVram- Multiple
Droplet Response Droplets Item Image MultipleDropletResponseDropletsItemImage- Multiple
Droplet Response Droplets Item Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - Multiple
Droplet Response Droplets Item Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- Multiple
Droplet Response Droplets Item Networks V4Item MultipleDropletResponseDropletsItemNetworksV4Item- Multiple
Droplet Response Droplets Item Networks V6Item MultipleDropletResponseDropletsItemNetworksV6Item- Multiple
Droplet Response Droplets Item Next Backup Window MultipleDropletResponseDropletsItemNextBackupWindow- Multiple
Droplet Response Droplets Item Region MultipleDropletResponseDropletsItemRegion- Multiple
Droplet Response Droplets Item Size MultipleDropletResponseDropletsItemSize- Multiple
Droplet Response Droplets Item Size Disk Info Item MultipleDropletResponseDropletsItemSizeDiskInfoItem- Multiple
Droplet Response Droplets Item Size Disk Info Item Size MultipleDropletResponseDropletsItemSizeDiskInfoItemSize- Multiple
Droplet Response Droplets Item Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Multiple
Droplet Response Droplets Item Size GpuInfo Vram MultipleDropletResponseDropletsItemSizeGpuInfoVram- Multiple
Droplet Response Links MultipleDropletResponseLinks- Multiple
Droplet Response Links Actions Item - The linked actions can be used to check the status of a Droplet’s create event.
- Name
Name - The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- NfsCreate
Access Point Body - Payload for creating a new access point on a share.
- NfsCreate
Access Point Body Access Policy - Provider-agnostic NFS access policy for an access point. Network CIDRs are managed by attach, detach, and managed-access workflows and are not part of this policy.
- NfsCreate
Access Point Response - Response returned after starting an access point mutation.
- NfsCreate
Access Point Response Access Point - Represents an NFS access point resource.
- NfsCreate
Access Point Response Access Point Access Policy - Provider-agnostic NFS access policy for an access point. Network CIDRs are managed by attach, detach, and managed-access workflows and are not part of this policy.
- NfsCreate
Access Point Response Action - The action that was submitted.
- NfsCreate
Action Body Variant0 Params NfsCreateActionBodyVariant0Params- NfsCreate
Action Body Variant1 Params NfsCreateActionBodyVariant1Params- NfsCreate
Action Body Variant2 Params NfsCreateActionBodyVariant2Params- NfsCreate
Action Body Variant3 Params NfsCreateActionBodyVariant3Params- NfsCreate
Action Body Variant4 Params NfsCreateActionBodyVariant4Params- NfsCreate
Action Body Variant5 Params NfsCreateActionBodyVariant5Params- NfsCreate
Action Response - Action response of an NFS share.
- NfsCreate
Action Response Action - The action that was submitted.
- NfsCreate
Body NfsCreateBody- NfsCreate
Response NfsCreateResponse- NfsCreate
Response Share NfsCreateResponseShare- NfsCreate
Response Share Access Points Item - Represents an NFS access point resource.
- NfsCreate
Response Share Access Points Item Access Policy - Provider-agnostic NFS access policy for an access point. Network CIDRs are managed by attach, detach, and managed-access workflows and are not part of this policy.
- NfsDelete
Access Point Response - Response returned after starting an access point mutation.
- NfsDelete
Access Point Response Access Point - Represents an NFS access point resource.
- NfsDelete
Access Point Response Access Point Access Policy - Provider-agnostic NFS access policy for an access point. Network CIDRs are managed by attach, detach, and managed-access workflows and are not part of this policy.
- NfsDelete
Access Point Response Action - The action that was submitted.
- NfsGet
Access Point Response - Response containing a single access point.
- NfsGet
Access Point Response Access Point - Represents an NFS access point resource.
- NfsGet
Access Point Response Access Point Access Policy - Provider-agnostic NFS access policy for an access point. Network CIDRs are managed by attach, detach, and managed-access workflows and are not part of this policy.
- NfsGet
Response NfsGetResponse- NfsGet
Response Share NfsGetResponseShare- NfsGet
Response Share Access Points Item - Represents an NFS access point resource.
- NfsGet
Response Share Access Points Item Access Policy - Provider-agnostic NFS access policy for an access point. Network CIDRs are managed by attach, detach, and managed-access workflows and are not part of this policy.
- NfsGet
Snapshot Response NfsGetSnapshotResponse- NfsGet
Snapshot Response Snapshot - Represents an NFS snapshot.
- NfsList
Access Points Response - Response containing a list of access points.
- NfsList
Access Points Response Access Points Item - Represents an NFS access point resource.
- NfsList
Access Points Response Access Points Item Access Policy - Provider-agnostic NFS access policy for an access point. Network CIDRs are managed by attach, detach, and managed-access workflows and are not part of this policy.
- NfsList
Response NfsListResponse- NfsList
Response Shares Item NfsListResponseSharesItem- NfsList
Response Shares Item Access Points Item - Represents an NFS access point resource.
- NfsList
Response Shares Item Access Points Item Access Policy - Provider-agnostic NFS access policy for an access point. Network CIDRs are managed by attach, detach, and managed-access workflows and are not part of this policy.
- NfsList
Snapshot Response NfsListSnapshotResponse- NfsList
Snapshot Response Snapshots Item - Represents an NFS snapshot.
- OneClicks
Install Kubernetes Body OneClicksInstallKubernetesBody- OneClicks
Install Kubernetes Response OneClicksInstallKubernetesResponse- OneClicks
List Response OneClicksListResponse- OneClicks
List Response1 Clicks Item OneClicksListResponse1ClicksItem- Organizations
Create Team Body OrganizationsCreateTeamBody- Organizations
Create Team Body Invitations Item - An invitation to join a newly created team.
- Organizations
Create Team Response OrganizationsCreateTeamResponse- Organizations
Create Team Response Invitations Value - The result of attempting to send a team invitation.
- Organizations
Create Team Response Team - The team resource returned when a team is created in an organization.
- Organizations
List Teams Response OrganizationsListTeamsResponse- Organizations
List Teams Response Teams Item - A team that belongs to an organization.
- Partner
Attachments Create Body PartnerAttachmentsCreateBody- Partner
Attachments Create Body Bgp - Optional BGP configurations
- Partner
Attachments Create Body Connection Bandwidth InMbps - Bandwidth (in Mbps) of the connection.
- Partner
Attachments Create Body Name - The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Partner
Attachments Create Response PartnerAttachmentsCreateResponse- Partner
Attachments Create Response Partner Attachment PartnerAttachmentsCreateResponsePartnerAttachment- Partner
Attachments Create Response Partner Attachment Bgp - The BGP configuration for the partner attachment.
- Partner
Attachments Create Response Partner Attachment Name - The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Partner
Attachments Delete Response PartnerAttachmentsDeleteResponse- Partner
Attachments Delete Response Partner Attachment PartnerAttachmentsDeleteResponsePartnerAttachment- Partner
Attachments Delete Response Partner Attachment Bgp - The BGP configuration for the partner attachment.
- Partner
Attachments Delete Response Partner Attachment Name - The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Partner
Attachments GetBgp Auth KeyResponse PartnerAttachmentsGetBgpAuthKeyResponse- Partner
Attachments GetResponse PartnerAttachmentsGetResponse- Partner
Attachments GetResponse Partner Attachment PartnerAttachmentsGetResponsePartnerAttachment- Partner
Attachments GetResponse Partner Attachment Bgp - The BGP configuration for the partner attachment.
- Partner
Attachments GetResponse Partner Attachment Name - The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Partner
Attachments GetService KeyResponse PartnerAttachmentsGetServiceKeyResponse- Partner
Attachments List Remote Routes Response PartnerAttachmentsListRemoteRoutesResponse- Partner
Attachments List Remote Routes Response Links PartnerAttachmentsListRemoteRoutesResponseLinks- Partner
Attachments List Remote Routes Response Links Pages PartnerAttachmentsListRemoteRoutesResponseLinksPages- Partner
Attachments List Remote Routes Response Links Pages Subtype0 PartnerAttachmentsListRemoteRoutesResponseLinksPagesSubtype0- Partner
Attachments List Remote Routes Response Links Pages Subtype1 PartnerAttachmentsListRemoteRoutesResponseLinksPagesSubtype1- Partner
Attachments List Remote Routes Response Meta PartnerAttachmentsListRemoteRoutesResponseMeta- Partner
Attachments List Remote Routes Response Remote Routes Item PartnerAttachmentsListRemoteRoutesResponseRemoteRoutesItem- Partner
Attachments List Response PartnerAttachmentsListResponse- Partner
Attachments List Response Links PartnerAttachmentsListResponseLinks- Partner
Attachments List Response Links Pages PartnerAttachmentsListResponseLinksPages- Partner
Attachments List Response Links Pages Subtype0 PartnerAttachmentsListResponseLinksPagesSubtype0- Partner
Attachments List Response Links Pages Subtype1 PartnerAttachmentsListResponseLinksPagesSubtype1- Partner
Attachments List Response Meta PartnerAttachmentsListResponseMeta- Partner
Attachments List Response Partner Attachments Item PartnerAttachmentsListResponsePartnerAttachmentsItem- Partner
Attachments List Response Partner Attachments Item Bgp - The BGP configuration for the partner attachment.
- Partner
Attachments List Response Partner Attachments Item Name - The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Partner
Attachments Patch Response PartnerAttachmentsPatchResponse- Partner
Attachments Patch Response Partner Attachment PartnerAttachmentsPatchResponsePartnerAttachment- Partner
Attachments Patch Response Partner Attachment Bgp - The BGP configuration for the partner attachment.
- Partner
Attachments Patch Response Partner Attachment Name - The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Plans
Item PlansItem- Projects
Assign Resources Body ProjectsAssignResourcesBody- Projects
Assign Resources Body Resources Item - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Projects
Assign Resources Default Body ProjectsAssignResourcesDefaultBody- Projects
Assign Resources Default Body Resources Item - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Projects
Assign Resources Default Response ProjectsAssignResourcesDefaultResponse- Projects
Assign Resources Default Response Resources Item ProjectsAssignResourcesDefaultResponseResourcesItem- Projects
Assign Resources Default Response Resources Item Links - The links object contains the
selfobject, which contains the resource relationship. - Projects
Assign Resources Default Response Resources Item Urn - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Projects
Assign Resources Response ProjectsAssignResourcesResponse- Projects
Assign Resources Response Resources Item ProjectsAssignResourcesResponseResourcesItem- Projects
Assign Resources Response Resources Item Links - The links object contains the
selfobject, which contains the resource relationship. - Projects
Assign Resources Response Resources Item Urn - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Projects
Create Body ProjectsCreateBody- Projects
Create Body Description - The description of the project. The maximum length is 255 characters.
- Projects
Create Body Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
Create Body Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
Create Response ProjectsCreateResponse- Projects
Create Response Project ProjectsCreateResponseProject- Projects
Create Response Project Description - The description of the project. The maximum length is 255 characters.
- Projects
Create Response Project Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
Create Response Project Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
GetDefault Response ProjectsGetDefaultResponse- Projects
GetDefault Response Project ProjectsGetDefaultResponseProject- Projects
GetDefault Response Project Description - The description of the project. The maximum length is 255 characters.
- Projects
GetDefault Response Project Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
GetDefault Response Project Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
GetResponse ProjectsGetResponse- Projects
GetResponse Project ProjectsGetResponseProject- Projects
GetResponse Project Description - The description of the project. The maximum length is 255 characters.
- Projects
GetResponse Project Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
GetResponse Project Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
List Resources Default Response ProjectsListResourcesDefaultResponse- Projects
List Resources Default Response Links ProjectsListResourcesDefaultResponseLinks- Projects
List Resources Default Response Links Pages ProjectsListResourcesDefaultResponseLinksPages- Projects
List Resources Default Response Links Pages Subtype0 ProjectsListResourcesDefaultResponseLinksPagesSubtype0- Projects
List Resources Default Response Links Pages Subtype1 ProjectsListResourcesDefaultResponseLinksPagesSubtype1- Projects
List Resources Default Response Meta ProjectsListResourcesDefaultResponseMeta- Projects
List Resources Default Response Resources Item ProjectsListResourcesDefaultResponseResourcesItem- Projects
List Resources Default Response Resources Item Links - The links object contains the
selfobject, which contains the resource relationship. - Projects
List Resources Default Response Resources Item Urn - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Projects
List Resources Response ProjectsListResourcesResponse- Projects
List Resources Response Links ProjectsListResourcesResponseLinks- Projects
List Resources Response Links Pages ProjectsListResourcesResponseLinksPages- Projects
List Resources Response Links Pages Subtype0 ProjectsListResourcesResponseLinksPagesSubtype0- Projects
List Resources Response Links Pages Subtype1 ProjectsListResourcesResponseLinksPagesSubtype1- Projects
List Resources Response Meta ProjectsListResourcesResponseMeta- Projects
List Resources Response Resources Item ProjectsListResourcesResponseResourcesItem- Projects
List Resources Response Resources Item Links - The links object contains the
selfobject, which contains the resource relationship. - Projects
List Resources Response Resources Item Urn - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Projects
List Response ProjectsListResponse- Projects
List Response Links ProjectsListResponseLinks- Projects
List Response Links Pages ProjectsListResponseLinksPages- Projects
List Response Links Pages Subtype0 ProjectsListResponseLinksPagesSubtype0- Projects
List Response Links Pages Subtype1 ProjectsListResponseLinksPagesSubtype1- Projects
List Response Meta ProjectsListResponseMeta- Projects
List Response Projects Item ProjectsListResponseProjectsItem- Projects
List Response Projects Item Description - The description of the project. The maximum length is 255 characters.
- Projects
List Response Projects Item Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
List Response Projects Item Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
Patch Body ProjectsPatchBody- Projects
Patch Body Description - The description of the project. The maximum length is 255 characters.
- Projects
Patch Body Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
Patch Body Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
Patch Default Body ProjectsPatchDefaultBody- Projects
Patch Default Body Description - The description of the project. The maximum length is 255 characters.
- Projects
Patch Default Body Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
Patch Default Body Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
Patch Default Response ProjectsPatchDefaultResponse- Projects
Patch Default Response Project ProjectsPatchDefaultResponseProject- Projects
Patch Default Response Project Description - The description of the project. The maximum length is 255 characters.
- Projects
Patch Default Response Project Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
Patch Default Response Project Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
Patch Response ProjectsPatchResponse- Projects
Patch Response Project ProjectsPatchResponseProject- Projects
Patch Response Project Description - The description of the project. The maximum length is 255 characters.
- Projects
Patch Response Project Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
Patch Response Project Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
Update Body ProjectsUpdateBody- Projects
Update Body Description - The description of the project. The maximum length is 255 characters.
- Projects
Update Body Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
Update Body Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
Update Default Body ProjectsUpdateDefaultBody- Projects
Update Default Body Description - The description of the project. The maximum length is 255 characters.
- Projects
Update Default Body Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
Update Default Body Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
Update Default Response ProjectsUpdateDefaultResponse- Projects
Update Default Response Project ProjectsUpdateDefaultResponseProject- Projects
Update Default Response Project Description - The description of the project. The maximum length is 255 characters.
- Projects
Update Default Response Project Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
Update Default Response Project Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Projects
Update Response ProjectsUpdateResponse- Projects
Update Response Project ProjectsUpdateResponseProject- Projects
Update Response Project Description - The description of the project. The maximum length is 255 characters.
- Projects
Update Response Project Name - The human-readable name for the project. The maximum length is 175 characters and the name must be unique.
- Projects
Update Response Project Purpose - The purpose of the project. The maximum length is 255 characters. It can have one of the following values:
- Regions
List Response RegionsListResponse- Regions
List Response Links RegionsListResponseLinks- Regions
List Response Links Pages RegionsListResponseLinksPages- Regions
List Response Links Pages Subtype0 RegionsListResponseLinksPagesSubtype0- Regions
List Response Links Pages Subtype1 RegionsListResponseLinksPagesSubtype1- Regions
List Response Meta RegionsListResponseMeta- Regions
List Response Regions Item RegionsListResponseRegionsItem- Registries
Create Body RegistriesCreateBody- Registries
Create Body Name - A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and
-, up to a limit of 63 characters. - Registries
Create Response RegistriesCreateResponse- Registries
Create Response Registry RegistriesCreateResponseRegistry- Registries
Create Response Registry Name - A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and
-, up to a limit of 63 characters. - Registries
GetDocker Credentials Response RegistriesGetDockerCredentialsResponse- Registries
GetDocker Credentials Response Auths RegistriesGetDockerCredentialsResponseAuths- Registries
GetDocker Credentials Response Auths Registry Digitalocean Com RegistriesGetDockerCredentialsResponseAuthsRegistryDigitaloceanCom- Registries
GetGarbage Collection Response RegistriesGetGarbageCollectionResponse- Registries
GetGarbage Collection Response Garbage Collection RegistriesGetGarbageCollectionResponseGarbageCollection- Registries
GetOptions Response RegistriesGetOptionsResponse- Registries
GetOptions Response Options RegistriesGetOptionsResponseOptions- Registries
GetOptions Response Options Subscription Tiers Item RegistriesGetOptionsResponseOptionsSubscriptionTiersItem- Registries
GetResponse RegistriesGetResponse- Registries
GetResponse Registry RegistriesGetResponseRegistry- Registries
GetResponse Registry Name - A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and
-, up to a limit of 63 characters. - Registries
GetSubscription Response RegistriesGetSubscriptionResponse- Registries
GetSubscription Response Subscription RegistriesGetSubscriptionResponseSubscription- Registries
GetSubscription Response Subscription Tier RegistriesGetSubscriptionResponseSubscriptionTier- Registries
List Garbage Collections Response RegistriesListGarbageCollectionsResponse- Registries
List Garbage Collections Response Garbage Collections Item RegistriesListGarbageCollectionsResponseGarbageCollectionsItem- Registries
List Repositories V2Response RegistriesListRepositoriesV2Response- Registries
List Repositories V2Response Links RegistriesListRepositoriesV2ResponseLinks- Registries
List Repositories V2Response Links Pages RegistriesListRepositoriesV2ResponseLinksPages- Registries
List Repositories V2Response Links Pages Subtype0 RegistriesListRepositoriesV2ResponseLinksPagesSubtype0- Registries
List Repositories V2Response Links Pages Subtype1 RegistriesListRepositoriesV2ResponseLinksPagesSubtype1- Registries
List Repositories V2Response Meta RegistriesListRepositoriesV2ResponseMeta- Registries
List Repositories V2Response Repositories Item RegistriesListRepositoriesV2ResponseRepositoriesItem- Registries
List Repositories V2Response Repositories Item Latest Manifest RegistriesListRepositoriesV2ResponseRepositoriesItemLatestManifest- Registries
List Repositories V2Response Repositories Item Latest Manifest Blobs Item RegistriesListRepositoriesV2ResponseRepositoriesItemLatestManifestBlobsItem- Registries
List Repository Manifests Response RegistriesListRepositoryManifestsResponse- Registries
List Repository Manifests Response Links RegistriesListRepositoryManifestsResponseLinks- Registries
List Repository Manifests Response Links Pages RegistriesListRepositoryManifestsResponseLinksPages- Registries
List Repository Manifests Response Links Pages Subtype0 RegistriesListRepositoryManifestsResponseLinksPagesSubtype0- Registries
List Repository Manifests Response Links Pages Subtype1 RegistriesListRepositoryManifestsResponseLinksPagesSubtype1- Registries
List Repository Manifests Response Manifests Item RegistriesListRepositoryManifestsResponseManifestsItem- Registries
List Repository Manifests Response Manifests Item Blobs Item RegistriesListRepositoryManifestsResponseManifestsItemBlobsItem- Registries
List Repository Manifests Response Meta RegistriesListRepositoryManifestsResponseMeta- Registries
List Repository Tags Response RegistriesListRepositoryTagsResponse- Registries
List Repository Tags Response Links RegistriesListRepositoryTagsResponseLinks- Registries
List Repository Tags Response Links Pages RegistriesListRepositoryTagsResponseLinksPages- Registries
List Repository Tags Response Links Pages Subtype0 RegistriesListRepositoryTagsResponseLinksPagesSubtype0- Registries
List Repository Tags Response Links Pages Subtype1 RegistriesListRepositoryTagsResponseLinksPagesSubtype1- Registries
List Repository Tags Response Meta RegistriesListRepositoryTagsResponseMeta- Registries
List Repository Tags Response Tags Item RegistriesListRepositoryTagsResponseTagsItem- Registries
List Response RegistriesListResponse- Registries
List Response Registries Item RegistriesListResponseRegistriesItem- Registries
List Response Registries Item Name - A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and
-, up to a limit of 63 characters. - Registries
List Response Registries Item Subscription RegistriesListResponseRegistriesItemSubscription- Registries
List Response Registries Item Subscription Tier RegistriesListResponseRegistriesItemSubscriptionTier- Registries
RunGarbage Collection Response RegistriesRunGarbageCollectionResponse- Registries
RunGarbage Collection Response Garbage Collection RegistriesRunGarbageCollectionResponseGarbageCollection- Registries
Update Garbage Collection Body RegistriesUpdateGarbageCollectionBody- Registries
Update Garbage Collection Response RegistriesUpdateGarbageCollectionResponse- Registries
Update Garbage Collection Response Garbage Collection RegistriesUpdateGarbageCollectionResponseGarbageCollection- Registries
Update Subscription Body RegistriesUpdateSubscriptionBody- Registries
Update Subscription Response RegistriesUpdateSubscriptionResponse- Registries
Update Subscription Response Subscription RegistriesUpdateSubscriptionResponseSubscription- Registries
Update Subscription Response Subscription Tier RegistriesUpdateSubscriptionResponseSubscriptionTier- Registries
Validate Name Body RegistriesValidateNameBody- Registries
Validate Name Body Name - A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and
-, up to a limit of 63 characters. - Registry
Create Body RegistryCreateBody- Registry
Create Body Name - A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and
-, up to a limit of 63 characters. - Registry
Create Response RegistryCreateResponse- Registry
Create Response Registry RegistryCreateResponseRegistry- Registry
Create Response Registry Name - A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and
-, up to a limit of 63 characters. - Registry
Create Response Registry Subscription RegistryCreateResponseRegistrySubscription- Registry
Create Response Registry Subscription Tier RegistryCreateResponseRegistrySubscriptionTier- Registry
GetDocker Credentials Response RegistryGetDockerCredentialsResponse- Registry
GetDocker Credentials Response Auths RegistryGetDockerCredentialsResponseAuths- Registry
GetDocker Credentials Response Auths Registry Digitalocean Com RegistryGetDockerCredentialsResponseAuthsRegistryDigitaloceanCom- Registry
GetGarbage Collection Response RegistryGetGarbageCollectionResponse- Registry
GetGarbage Collection Response Garbage Collection RegistryGetGarbageCollectionResponseGarbageCollection- Registry
GetOptions Response RegistryGetOptionsResponse- Registry
GetOptions Response Options RegistryGetOptionsResponseOptions- Registry
GetOptions Response Options Subscription Tiers Item RegistryGetOptionsResponseOptionsSubscriptionTiersItem- Registry
GetResponse RegistryGetResponse- Registry
GetResponse Registry RegistryGetResponseRegistry- Registry
GetResponse Registry Name - A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and
-, up to a limit of 63 characters. - Registry
GetResponse Registry Subscription RegistryGetResponseRegistrySubscription- Registry
GetResponse Registry Subscription Tier RegistryGetResponseRegistrySubscriptionTier- Registry
GetSubscription Response RegistryGetSubscriptionResponse- Registry
GetSubscription Response Subscription RegistryGetSubscriptionResponseSubscription- Registry
GetSubscription Response Subscription Tier RegistryGetSubscriptionResponseSubscriptionTier- Registry
List Garbage Collections Response RegistryListGarbageCollectionsResponse- Registry
List Garbage Collections Response Garbage Collections Item RegistryListGarbageCollectionsResponseGarbageCollectionsItem- Registry
List Repositories Response RegistryListRepositoriesResponse- Registry
List Repositories Response Links RegistryListRepositoriesResponseLinks- Registry
List Repositories Response Links Pages RegistryListRepositoriesResponseLinksPages- Registry
List Repositories Response Links Pages Subtype0 RegistryListRepositoriesResponseLinksPagesSubtype0- Registry
List Repositories Response Links Pages Subtype1 RegistryListRepositoriesResponseLinksPagesSubtype1- Registry
List Repositories Response Meta RegistryListRepositoriesResponseMeta- Registry
List Repositories Response Repositories Item RegistryListRepositoriesResponseRepositoriesItem- Registry
List Repositories Response Repositories Item Latest Tag RegistryListRepositoriesResponseRepositoriesItemLatestTag- Registry
List Repositories V2Response RegistryListRepositoriesV2Response- Registry
List Repositories V2Response Links RegistryListRepositoriesV2ResponseLinks- Registry
List Repositories V2Response Links Pages RegistryListRepositoriesV2ResponseLinksPages- Registry
List Repositories V2Response Links Pages Subtype0 RegistryListRepositoriesV2ResponseLinksPagesSubtype0- Registry
List Repositories V2Response Links Pages Subtype1 RegistryListRepositoriesV2ResponseLinksPagesSubtype1- Registry
List Repositories V2Response Meta RegistryListRepositoriesV2ResponseMeta- Registry
List Repositories V2Response Repositories Item RegistryListRepositoriesV2ResponseRepositoriesItem- Registry
List Repositories V2Response Repositories Item Latest Manifest RegistryListRepositoriesV2ResponseRepositoriesItemLatestManifest- Registry
List Repositories V2Response Repositories Item Latest Manifest Blobs Item RegistryListRepositoriesV2ResponseRepositoriesItemLatestManifestBlobsItem- Registry
List Repository Manifests Response RegistryListRepositoryManifestsResponse- Registry
List Repository Manifests Response Links RegistryListRepositoryManifestsResponseLinks- Registry
List Repository Manifests Response Links Pages RegistryListRepositoryManifestsResponseLinksPages- Registry
List Repository Manifests Response Links Pages Subtype0 RegistryListRepositoryManifestsResponseLinksPagesSubtype0- Registry
List Repository Manifests Response Links Pages Subtype1 RegistryListRepositoryManifestsResponseLinksPagesSubtype1- Registry
List Repository Manifests Response Manifests Item RegistryListRepositoryManifestsResponseManifestsItem- Registry
List Repository Manifests Response Manifests Item Blobs Item RegistryListRepositoryManifestsResponseManifestsItemBlobsItem- Registry
List Repository Manifests Response Meta RegistryListRepositoryManifestsResponseMeta- Registry
List Repository Tags Response RegistryListRepositoryTagsResponse- Registry
List Repository Tags Response Links RegistryListRepositoryTagsResponseLinks- Registry
List Repository Tags Response Links Pages RegistryListRepositoryTagsResponseLinksPages- Registry
List Repository Tags Response Links Pages Subtype0 RegistryListRepositoryTagsResponseLinksPagesSubtype0- Registry
List Repository Tags Response Links Pages Subtype1 RegistryListRepositoryTagsResponseLinksPagesSubtype1- Registry
List Repository Tags Response Meta RegistryListRepositoryTagsResponseMeta- Registry
List Repository Tags Response Tags Item RegistryListRepositoryTagsResponseTagsItem- Registry
RunGarbage Collection Body RegistryRunGarbageCollectionBody- Registry
RunGarbage Collection Response RegistryRunGarbageCollectionResponse- Registry
RunGarbage Collection Response Garbage Collection RegistryRunGarbageCollectionResponseGarbageCollection- Registry
Update Garbage Collection Body RegistryUpdateGarbageCollectionBody- Registry
Update Garbage Collection Response RegistryUpdateGarbageCollectionResponse- Registry
Update Garbage Collection Response Garbage Collection RegistryUpdateGarbageCollectionResponseGarbageCollection- Registry
Update Subscription Body RegistryUpdateSubscriptionBody- Registry
Update Subscription Response RegistryUpdateSubscriptionResponse- Registry
Update Subscription Response Subscription RegistryUpdateSubscriptionResponseSubscription- Registry
Update Subscription Response Subscription Tier RegistryUpdateSubscriptionResponseSubscriptionTier- Registry
Validate Name Body RegistryValidateNameBody- Registry
Validate Name Body Name - A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and
-, up to a limit of 63 characters. - Reserve
ToRegion ReserveToRegion- ReservedI
PsActions GetResponse ReservedIPsActionsGetResponse- ReservedI
PsActions GetResponse Action ReservedIPsActionsGetResponseAction- ReservedI
PsActions GetResponse Action Region ReservedIPsActionsGetResponseActionRegion- ReservedI
PsActions List Response ReservedIPsActionsListResponse- ReservedI
PsActions List Response Actions Item ReservedIPsActionsListResponseActionsItem- ReservedI
PsActions List Response Actions Item Region ReservedIPsActionsListResponseActionsItemRegion- ReservedI
PsActions List Response Links ReservedIPsActionsListResponseLinks- ReservedI
PsActions List Response Links Pages ReservedIPsActionsListResponseLinksPages- ReservedI
PsActions List Response Links Pages Subtype0 ReservedIPsActionsListResponseLinksPagesSubtype0- ReservedI
PsActions List Response Links Pages Subtype1 ReservedIPsActionsListResponseLinksPagesSubtype1- ReservedI
PsActions List Response Meta ReservedIPsActionsListResponseMeta- ReservedI
PsActions Post Response ReservedIPsActionsPostResponse- ReservedI
PsActions Post Response Action ReservedIPsActionsPostResponseAction- ReservedI
PsActions Post Response Action Region ReservedIPsActionsPostResponseActionRegion- ReservedI
PsCreate Response ReservedIPsCreateResponse- ReservedI
PsCreate Response Links ReservedIPsCreateResponseLinks- ReservedI
PsCreate Response Links Actions Item - The linked actions can be used to check the status of a Droplet’s create event.
- ReservedI
PsCreate Response Links Droplets Item - The linked actions can be used to check the status of a Droplet’s create event.
- ReservedI
PsCreate Response Reserved Ip ReservedIPsCreateResponseReservedIp- ReservedI
PsCreate Response Reserved IpDroplet - The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.
Requiresdroplet:readscope. - ReservedI
PsCreate Response Reserved IpDroplet Subtype1 ReservedIPsCreateResponseReservedIpDropletSubtype1- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Disk Info Item ReservedIPsCreateResponseReservedIpDropletSubtype1DiskInfoItem- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Disk Info Item Size ReservedIPsCreateResponseReservedIpDropletSubtype1DiskInfoItemSize- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 GpuInfo Vram ReservedIPsCreateResponseReservedIpDropletSubtype1GpuInfoVram- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Image ReservedIPsCreateResponseReservedIpDropletSubtype1Image- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Networks V4Item ReservedIPsCreateResponseReservedIpDropletSubtype1NetworksV4Item- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Networks V6Item ReservedIPsCreateResponseReservedIpDropletSubtype1NetworksV6Item- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Next Backup Window ReservedIPsCreateResponseReservedIpDropletSubtype1NextBackupWindow- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Region ReservedIPsCreateResponseReservedIpDropletSubtype1Region- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Size ReservedIPsCreateResponseReservedIpDropletSubtype1Size- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Size Disk Info Item ReservedIPsCreateResponseReservedIpDropletSubtype1SizeDiskInfoItem- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Size Disk Info Item Size ReservedIPsCreateResponseReservedIpDropletSubtype1SizeDiskInfoItemSize- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Size GpuInfo Vram ReservedIPsCreateResponseReservedIpDropletSubtype1SizeGpuInfoVram- ReservedI
PsCreate Response Reserved IpRegion ReservedIPsCreateResponseReservedIpRegion- ReservedI
PsGet Response ReservedIPsGetResponse- ReservedI
PsGet Response Reserved Ip ReservedIPsGetResponseReservedIp- ReservedI
PsGet Response Reserved IpDroplet - The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.
Requiresdroplet:readscope. - ReservedI
PsGet Response Reserved IpDroplet Subtype1 ReservedIPsGetResponseReservedIpDropletSubtype1- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Disk Info Item ReservedIPsGetResponseReservedIpDropletSubtype1DiskInfoItem- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Disk Info Item Size ReservedIPsGetResponseReservedIpDropletSubtype1DiskInfoItemSize- ReservedI
PsGet Response Reserved IpDroplet Subtype1 GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- ReservedI
PsGet Response Reserved IpDroplet Subtype1 GpuInfo Vram ReservedIPsGetResponseReservedIpDropletSubtype1GpuInfoVram- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Image ReservedIPsGetResponseReservedIpDropletSubtype1Image- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - ReservedI
PsGet Response Reserved IpDroplet Subtype1 Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Networks V4Item ReservedIPsGetResponseReservedIpDropletSubtype1NetworksV4Item- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Networks V6Item ReservedIPsGetResponseReservedIpDropletSubtype1NetworksV6Item- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Next Backup Window ReservedIPsGetResponseReservedIpDropletSubtype1NextBackupWindow- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Region ReservedIPsGetResponseReservedIpDropletSubtype1Region- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Size ReservedIPsGetResponseReservedIpDropletSubtype1Size- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Size Disk Info Item ReservedIPsGetResponseReservedIpDropletSubtype1SizeDiskInfoItem- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Size Disk Info Item Size ReservedIPsGetResponseReservedIpDropletSubtype1SizeDiskInfoItemSize- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Size GpuInfo Vram ReservedIPsGetResponseReservedIpDropletSubtype1SizeGpuInfoVram- ReservedI
PsGet Response Reserved IpRegion ReservedIPsGetResponseReservedIpRegion- ReservedI
PsList Response ReservedIPsListResponse- ReservedI
PsList Response Links ReservedIPsListResponseLinks- ReservedI
PsList Response Links Pages ReservedIPsListResponseLinksPages- ReservedI
PsList Response Links Pages Subtype0 ReservedIPsListResponseLinksPagesSubtype0- ReservedI
PsList Response Links Pages Subtype1 ReservedIPsListResponseLinksPagesSubtype1- ReservedI
PsList Response Meta ReservedIPsListResponseMeta- ReservedI
PsList Response Reserved IpsItem ReservedIPsListResponseReservedIpsItem- ReservedI
PsList Response Reserved IpsItem Droplet - The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.
Requiresdroplet:readscope. - ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 ReservedIPsListResponseReservedIpsItemDropletSubtype1- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Disk Info Item ReservedIPsListResponseReservedIpsItemDropletSubtype1DiskInfoItem- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Disk Info Item Size ReservedIPsListResponseReservedIpsItemDropletSubtype1DiskInfoItemSize- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 GpuInfo Vram ReservedIPsListResponseReservedIpsItemDropletSubtype1GpuInfoVram- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Image ReservedIPsListResponseReservedIpsItemDropletSubtype1Image- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Networks V4Item ReservedIPsListResponseReservedIpsItemDropletSubtype1NetworksV4Item- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Networks V6Item ReservedIPsListResponseReservedIpsItemDropletSubtype1NetworksV6Item- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Next Backup Window ReservedIPsListResponseReservedIpsItemDropletSubtype1NextBackupWindow- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Region ReservedIPsListResponseReservedIpsItemDropletSubtype1Region- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Size ReservedIPsListResponseReservedIpsItemDropletSubtype1Size- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Size Disk Info Item ReservedIPsListResponseReservedIpsItemDropletSubtype1SizeDiskInfoItem- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Size Disk Info Item Size ReservedIPsListResponseReservedIpsItemDropletSubtype1SizeDiskInfoItemSize- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Size GpuInfo Vram ReservedIPsListResponseReservedIpsItemDropletSubtype1SizeGpuInfoVram- ReservedI
PsList Response Reserved IpsItem Region ReservedIPsListResponseReservedIpsItemRegion- ReservedI
Pv6Actions Post Response ReservedIPv6ActionsPostResponse- ReservedI
Pv6Actions Post Response Action ReservedIPv6ActionsPostResponseAction- ReservedI
Pv6Actions Post Response Action Region ReservedIPv6ActionsPostResponseActionRegion- ReservedI
Pv6Create Response ReservedIPv6CreateResponse- ReservedI
Pv6Create Response Reserved Ipv6 ReservedIPv6CreateResponseReservedIpv6- ReservedI
Pv6Get Response ReservedIPv6GetResponse- ReservedI
Pv6Get Response Reserved Ipv6 ReservedIPv6GetResponseReservedIpv6- ReservedI
Pv6Get Response Reserved Ipv6 Droplet ReservedIPv6GetResponseReservedIpv6Droplet- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 ReservedIPv6GetResponseReservedIpv6DropletSubtype1- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Disk Info Item ReservedIPv6GetResponseReservedIpv6DropletSubtype1DiskInfoItem- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Disk Info Item Size ReservedIPv6GetResponseReservedIpv6DropletSubtype1DiskInfoItemSize- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 GpuInfo Vram ReservedIPv6GetResponseReservedIpv6DropletSubtype1GpuInfoVram- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Image ReservedIPv6GetResponseReservedIpv6DropletSubtype1Image- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Networks V4Item ReservedIPv6GetResponseReservedIpv6DropletSubtype1NetworksV4Item- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Networks V6Item ReservedIPv6GetResponseReservedIpv6DropletSubtype1NetworksV6Item- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Next Backup Window ReservedIPv6GetResponseReservedIpv6DropletSubtype1NextBackupWindow- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Region ReservedIPv6GetResponseReservedIpv6DropletSubtype1Region- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Size ReservedIPv6GetResponseReservedIpv6DropletSubtype1Size- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Size Disk Info Item ReservedIPv6GetResponseReservedIpv6DropletSubtype1SizeDiskInfoItem- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Size Disk Info Item Size ReservedIPv6GetResponseReservedIpv6DropletSubtype1SizeDiskInfoItemSize- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Size GpuInfo Vram ReservedIPv6GetResponseReservedIpv6DropletSubtype1SizeGpuInfoVram- ReservedI
Pv6List Response ReservedIPv6ListResponse- ReservedI
Pv6List Response Links ReservedIPv6ListResponseLinks- ReservedI
Pv6List Response Links Pages ReservedIPv6ListResponseLinksPages- ReservedI
Pv6List Response Links Pages Subtype0 ReservedIPv6ListResponseLinksPagesSubtype0- ReservedI
Pv6List Response Links Pages Subtype1 ReservedIPv6ListResponseLinksPagesSubtype1- ReservedI
Pv6List Response Meta ReservedIPv6ListResponseMeta- ReservedI
Pv6List Response Reserved Ipv6s Item ReservedIPv6ListResponseReservedIpv6sItem- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet - Requires
droplet:readscope. - ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Disk Info Item ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1DiskInfoItem- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Disk Info Item Size ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1DiskInfoItemSize- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 GpuInfo Vram ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1GpuInfoVram- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Image ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1Image- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Networks V4Item ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1NetworksV4Item- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Networks V6Item ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1NetworksV6Item- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Next Backup Window ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1NextBackupWindow- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Region ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1Region- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Size ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1Size- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Size Disk Info Item ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1SizeDiskInfoItem- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Size Disk Info Item Size ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1SizeDiskInfoItemSize- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Size GpuInfo Vram ReservedIPv6ListResponseReservedIpv6sItemDropletSubtype1SizeGpuInfoVram- Response
Value - Typed value returned by generated client methods.
- Security
Create Scan Response SecurityCreateScanResponse- Security
Create Scan Response Scan SecurityCreateScanResponseScan- Security
Create Scan Rule Body SecurityCreateScanRuleBody- Security
Create Suppression Body SecurityCreateSuppressionBody- Security
Create Suppression Response SecurityCreateSuppressionResponse- Security
Create Suppression Response Links SecurityCreateSuppressionResponseLinks- Security
Create Suppression Response Links Pages SecurityCreateSuppressionResponseLinksPages- Security
Create Suppression Response Meta SecurityCreateSuppressionResponseMeta- Security
Create Suppression Response Resources Item SecurityCreateSuppressionResponseResourcesItem- Security
GetLatest Scan Response SecurityGetLatestScanResponse- Security
GetLatest Scan Response Scan SecurityGetLatestScanResponseScan- Security
GetScan Response SecurityGetScanResponse- Security
GetScan Response Scan SecurityGetScanResponseScan- Security
List Scan Finding Affected Resources Response SecurityListScanFindingAffectedResourcesResponse- Security
List Scan Finding Affected Resources Response Affected Resources Item SecurityListScanFindingAffectedResourcesResponseAffectedResourcesItem- Security
List Scans Response SecurityListScansResponse- Security
List Scans Response Links SecurityListScansResponseLinks- Security
List Scans Response Links Pages SecurityListScansResponseLinksPages- Security
List Scans Response Links Pages Subtype0 SecurityListScansResponseLinksPagesSubtype0- Security
List Scans Response Links Pages Subtype1 SecurityListScansResponseLinksPagesSubtype1- Security
List Scans Response Meta SecurityListScansResponseMeta- Security
List Scans Response Scans Item SecurityListScansResponseScansItem- Security
List Settings Response SecurityListSettingsResponse- Security
List Settings Response Plan Downgrades Value - Resources moving to a tier at a given effective time.
- Security
List Settings Response Settings SecurityListSettingsResponseSettings- Security
List Settings Response Settings Suppressions SecurityListSettingsResponseSettingsSuppressions- Security
List Settings Response Settings Suppressions Links SecurityListSettingsResponseSettingsSuppressionsLinks- Security
List Settings Response Settings Suppressions Links Pages SecurityListSettingsResponseSettingsSuppressionsLinksPages- Security
List Settings Response Settings Suppressions Meta SecurityListSettingsResponseSettingsSuppressionsMeta- Security
List Settings Response Tier Coverage Value SecurityListSettingsResponseTierCoverageValue- Security
Update Settings Plan Body SecurityUpdateSettingsPlanBody- Security
Update Settings Plan Body Tier Coverage Value SecurityUpdateSettingsPlanBodyTierCoverageValue- Security
Update Settings Plan Response SecurityUpdateSettingsPlanResponse- Security
Update Settings Plan Response Tier Coverage Value SecurityUpdateSettingsPlanResponseTierCoverageValue- Service
Components That ArePart OfThis Deployment Item ServiceComponentsThatArePartOfThisDeploymentItem- Single
Droplet Request Backup Policy SingleDropletRequestBackupPolicy- Single
Droplet Request Backup Policy Hour - The hour of the day that the backup window will start.
- Single
Droplet Request Name - The human-readable string you wish to use when displaying the Droplet name. The name, if set to a domain name managed in the DigitalOcean DNS management system, will configure a PTR record for the Droplet. The name set during creation will also determine the hostname for the Droplet in its internal configuration.
- Single
Droplet Response Droplet SingleDropletResponseDroplet- Single
Droplet Response Droplet Disk Info Item SingleDropletResponseDropletDiskInfoItem- Single
Droplet Response Droplet Disk Info Item Size SingleDropletResponseDropletDiskInfoItemSize- Single
Droplet Response Droplet GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Single
Droplet Response Droplet GpuInfo Vram SingleDropletResponseDropletGpuInfoVram- Single
Droplet Response Droplet Image SingleDropletResponseDropletImage- Single
Droplet Response Droplet Kernel - Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to
null. - Single
Droplet Response Droplet Networks - The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
- Single
Droplet Response Droplet Networks V4Item SingleDropletResponseDropletNetworksV4Item- Single
Droplet Response Droplet Networks V6Item SingleDropletResponseDropletNetworksV6Item- Single
Droplet Response Droplet Next Backup Window SingleDropletResponseDropletNextBackupWindow- Single
Droplet Response Droplet Region SingleDropletResponseDropletRegion- Single
Droplet Response Droplet Size SingleDropletResponseDropletSize- Single
Droplet Response Droplet Size Disk Info Item SingleDropletResponseDropletSizeDiskInfoItem- Single
Droplet Response Droplet Size Disk Info Item Size SingleDropletResponseDropletSizeDiskInfoItemSize- Single
Droplet Response Droplet Size GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Single
Droplet Response Droplet Size GpuInfo Vram SingleDropletResponseDropletSizeGpuInfoVram- Single
Droplet Response Links SingleDropletResponseLinks- Single
Droplet Response Links Actions Item - The linked actions can be used to check the status of a Droplet’s create event.
- Sizes
List Response SizesListResponse- Sizes
List Response Links SizesListResponseLinks- Sizes
List Response Links Pages SizesListResponseLinksPages- Sizes
List Response Links Pages Subtype0 SizesListResponseLinksPagesSubtype0- Sizes
List Response Links Pages Subtype1 SizesListResponseLinksPagesSubtype1- Sizes
List Response Meta SizesListResponseMeta- Sizes
List Response Sizes Item SizesListResponseSizesItem- Sizes
List Response Sizes Item Disk Info Item SizesListResponseSizesItemDiskInfoItem- Sizes
List Response Sizes Item Disk Info Item Size SizesListResponseSizesItemDiskInfoItemSize- Sizes
List Response Sizes Item GpuInfo - An object containing information about the GPU capabilities of Droplets created with this size.
- Sizes
List Response Sizes Item GpuInfo Vram SizesListResponseSizesItemGpuInfoVram- Slack
Webhooks ToSend Alerts ToItem SlackWebhooksToSendAlertsToItem- Snapshots
GetResponse SnapshotsGetResponse- Snapshots
GetResponse Snapshot SnapshotsGetResponseSnapshot- Snapshots
List Response SnapshotsListResponse- Snapshots
List Response Links SnapshotsListResponseLinks- Snapshots
List Response Links Pages SnapshotsListResponseLinksPages- Snapshots
List Response Links Pages Subtype0 SnapshotsListResponseLinksPagesSubtype0- Snapshots
List Response Links Pages Subtype1 SnapshotsListResponseLinksPagesSubtype1- Snapshots
List Response Meta SnapshotsListResponseMeta- Snapshots
List Response Snapshots Item SnapshotsListResponseSnapshotsItem- Spaces
KeyCreate Body SpacesKeyCreateBody- Spaces
KeyCreate Body Grants Item SpacesKeyCreateBodyGrantsItem- Spaces
KeyCreate Response SpacesKeyCreateResponse- Spaces
KeyCreate Response Key SpacesKeyCreateResponseKey- Spaces
KeyCreate Response KeyGrants Item SpacesKeyCreateResponseKeyGrantsItem- Spaces
KeyGet Response SpacesKeyGetResponse- Spaces
KeyGet Response Keys Item SpacesKeyGetResponseKeysItem- Spaces
KeyGet Response Keys Item Grants Item SpacesKeyGetResponseKeysItemGrantsItem- Spaces
KeyList Response SpacesKeyListResponse- Spaces
KeyList Response Keys Item SpacesKeyListResponseKeysItem- Spaces
KeyList Response Keys Item Grants Item SpacesKeyListResponseKeysItemGrantsItem- Spaces
KeyList Response Links SpacesKeyListResponseLinks- Spaces
KeyList Response Links Pages SpacesKeyListResponseLinksPages- Spaces
KeyList Response Links Pages Subtype0 SpacesKeyListResponseLinksPagesSubtype0- Spaces
KeyList Response Links Pages Subtype1 SpacesKeyListResponseLinksPagesSubtype1- Spaces
KeyList Response Meta SpacesKeyListResponseMeta- Spaces
KeyPatch Body SpacesKeyPatchBody- Spaces
KeyPatch Body Grants Item SpacesKeyPatchBodyGrantsItem- Spaces
KeyPatch Response SpacesKeyPatchResponse- Spaces
KeyPatch Response Key SpacesKeyPatchResponseKey- Spaces
KeyPatch Response KeyGrants Item SpacesKeyPatchResponseKeyGrantsItem- Spaces
KeyUpdate Body SpacesKeyUpdateBody- Spaces
KeyUpdate Body Grants Item SpacesKeyUpdateBodyGrantsItem- Spaces
KeyUpdate Response SpacesKeyUpdateResponse- Spaces
KeyUpdate Response Key SpacesKeyUpdateResponseKey- Spaces
KeyUpdate Response KeyGrants Item SpacesKeyUpdateResponseKeyGrantsItem- SshKeys
Create Body SshKeysCreateBody- SshKeys
Create Response SshKeysCreateResponse- SshKeys
Create Response SshKey SshKeysCreateResponseSshKey- SshKeys
GetResponse SshKeysGetResponse- SshKeys
GetResponse SshKey SshKeysGetResponseSshKey- SshKeys
List Response SshKeysListResponse- SshKeys
List Response Links SshKeysListResponseLinks- SshKeys
List Response Links Pages SshKeysListResponseLinksPages- SshKeys
List Response Links Pages Subtype0 SshKeysListResponseLinksPagesSubtype0- SshKeys
List Response Links Pages Subtype1 SshKeysListResponseLinksPagesSubtype1- SshKeys
List Response Meta SshKeysListResponseMeta- SshKeys
List Response SshKeys Item SshKeysListResponseSshKeysItem- SshKeys
Update Body SshKeysUpdateBody- SshKeys
Update Response SshKeysUpdateResponse- SshKeys
Update Response SshKey SshKeysUpdateResponseSshKey- Static
Site Components That ArePart OfThis Deployment Item StaticSiteComponentsThatArePartOfThisDeploymentItem- Steps
OfAn Alerts Progress Item StepsOfAnAlertsProgressItem- Steps
OfAn Alerts Progress Item Reason StepsOfAnAlertsProgressItemReason- Tags
Assign Resources Body TagsAssignResourcesBody- Tags
Assign Resources Body Resources Item TagsAssignResourcesBodyResourcesItem- Tags
Assign Resources TagId TagsAssignResourcesTagId- Tags
Create Body - A tag is a label that can be applied to a resource (currently Droplets, Images, Volumes, Volume Snapshots, and Database clusters) in order to better organize or facilitate the lookups and actions on it.
Tags have two attributes: a user defined
nameattribute and an embeddedresourcesattribute with information about resources that have been tagged. - Tags
Create Body Name - The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.
- Tags
Create Body Resources - An embedded object containing key value pairs of resource type and resource statistics.
It also includes a count of the total number of resources tagged with the current tag as well as a
last_tagged_uriattribute set to the last resource tagged with the current tag. - Tags
Create Body Resources Databases TagsCreateBodyResourcesDatabases- Tags
Create Body Resources Droplets TagsCreateBodyResourcesDroplets- Tags
Create Body Resources Imgages TagsCreateBodyResourcesImgages- Tags
Create Body Resources Volume Snapshots TagsCreateBodyResourcesVolumeSnapshots- Tags
Create Body Resources Volumes TagsCreateBodyResourcesVolumes- Tags
Create Response TagsCreateResponse- Tags
Create Response Tag - A tag is a label that can be applied to a resource (currently Droplets, Images, Volumes, Volume Snapshots, and Database clusters) in order to better organize or facilitate the lookups and actions on it.
Tags have two attributes: a user defined
nameattribute and an embeddedresourcesattribute with information about resources that have been tagged. - Tags
Create Response TagName - The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.
- Tags
Create Response TagResources - An embedded object containing key value pairs of resource type and resource statistics.
It also includes a count of the total number of resources tagged with the current tag as well as a
last_tagged_uriattribute set to the last resource tagged with the current tag. - Tags
Create Response TagResources Databases TagsCreateResponseTagResourcesDatabases- Tags
Create Response TagResources Droplets TagsCreateResponseTagResourcesDroplets- Tags
Create Response TagResources Imgages TagsCreateResponseTagResourcesImgages- Tags
Create Response TagResources Volume Snapshots TagsCreateResponseTagResourcesVolumeSnapshots- Tags
Create Response TagResources Volumes TagsCreateResponseTagResourcesVolumes- Tags
Delete TagId TagsDeleteTagId- Tags
GetResponse TagsGetResponse- Tags
GetResponse Tag - A tag is a label that can be applied to a resource (currently Droplets, Images, Volumes, Volume Snapshots, and Database clusters) in order to better organize or facilitate the lookups and actions on it.
Tags have two attributes: a user defined
nameattribute and an embeddedresourcesattribute with information about resources that have been tagged. - Tags
GetResponse TagName - The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.
- Tags
GetResponse TagResources - An embedded object containing key value pairs of resource type and resource statistics.
It also includes a count of the total number of resources tagged with the current tag as well as a
last_tagged_uriattribute set to the last resource tagged with the current tag. - Tags
GetResponse TagResources Databases TagsGetResponseTagResourcesDatabases- Tags
GetResponse TagResources Droplets TagsGetResponseTagResourcesDroplets- Tags
GetResponse TagResources Imgages TagsGetResponseTagResourcesImgages- Tags
GetResponse TagResources Volume Snapshots TagsGetResponseTagResourcesVolumeSnapshots- Tags
GetResponse TagResources Volumes TagsGetResponseTagResourcesVolumes- Tags
GetTag Id TagsGetTagId- Tags
List Response TagsListResponse- Tags
List Response Links TagsListResponseLinks- Tags
List Response Links Pages TagsListResponseLinksPages- Tags
List Response Links Pages Subtype0 TagsListResponseLinksPagesSubtype0- Tags
List Response Links Pages Subtype1 TagsListResponseLinksPagesSubtype1- Tags
List Response Meta TagsListResponseMeta- Tags
List Response Tags Item - A tag is a label that can be applied to a resource (currently Droplets, Images, Volumes, Volume Snapshots, and Database clusters) in order to better organize or facilitate the lookups and actions on it.
Tags have two attributes: a user defined
nameattribute and an embeddedresourcesattribute with information about resources that have been tagged. - Tags
List Response Tags Item Name - The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag.
- Tags
List Response Tags Item Resources - An embedded object containing key value pairs of resource type and resource statistics.
It also includes a count of the total number of resources tagged with the current tag as well as a
last_tagged_uriattribute set to the last resource tagged with the current tag. - Tags
List Response Tags Item Resources Databases TagsListResponseTagsItemResourcesDatabases- Tags
List Response Tags Item Resources Droplets TagsListResponseTagsItemResourcesDroplets- Tags
List Response Tags Item Resources Imgages TagsListResponseTagsItemResourcesImgages- Tags
List Response Tags Item Resources Volume Snapshots TagsListResponseTagsItemResourcesVolumeSnapshots- Tags
List Response Tags Item Resources Volumes TagsListResponseTagsItemResourcesVolumes- Tags
Unassign Resources Body TagsUnassignResourcesBody- Tags
Unassign Resources Body Resources Item TagsUnassignResourcesBodyResourcesItem- Tags
Unassign Resources TagId TagsUnassignResourcesTagId- TheDedicated
Egress IpAddresses Associated With TheApp Item TheDedicatedEgressIpAddressesAssociatedWithTheAppItem- TheEgress
IpsAssociated With TheVpc Item TheEgressIpsAssociatedWithTheVpcItem- TheJob
Invocation Trigger TheJobInvocationTrigger- TheJob
Invocation Trigger Manual - Details about the manual trigger, if applicable
- TheJob
Invocation Trigger Manual User - The user who triggered the job
- TheJob
Invocation Trigger Scheduled - The schedule for the job
- TheJob
Invocation Trigger Scheduled Schedule TheJobInvocationTriggerScheduledSchedule- Uptime
Create Alert Body UptimeCreateAlertBody- Uptime
Create Alert Response UptimeCreateAlertResponse- Uptime
Create Alert Response Alert UptimeCreateAlertResponseAlert- Uptime
Create Check Body UptimeCreateCheckBody- Uptime
Create Check Response UptimeCreateCheckResponse- Uptime
Create Check Response Check UptimeCreateCheckResponseCheck- Uptime
GetAlert Response UptimeGetAlertResponse- Uptime
GetAlert Response Alert UptimeGetAlertResponseAlert- Uptime
GetCheck Response UptimeGetCheckResponse- Uptime
GetCheck Response Check UptimeGetCheckResponseCheck- Uptime
GetCheck State Response UptimeGetCheckStateResponse- Uptime
GetCheck State Response State UptimeGetCheckStateResponseState- Uptime
GetCheck State Response State Previous Outage UptimeGetCheckStateResponseStatePreviousOutage- Uptime
GetCheck State Response State Regions - A map of region to regional state
- Uptime
List Alerts Response UptimeListAlertsResponse- Uptime
List Alerts Response Alerts Item UptimeListAlertsResponseAlertsItem- Uptime
List Alerts Response Links UptimeListAlertsResponseLinks- Uptime
List Alerts Response Links Pages UptimeListAlertsResponseLinksPages- Uptime
List Alerts Response Links Pages Subtype0 UptimeListAlertsResponseLinksPagesSubtype0- Uptime
List Alerts Response Links Pages Subtype1 UptimeListAlertsResponseLinksPagesSubtype1- Uptime
List Alerts Response Meta UptimeListAlertsResponseMeta- Uptime
List Checks Response UptimeListChecksResponse- Uptime
List Checks Response Checks Item UptimeListChecksResponseChecksItem- Uptime
List Checks Response Links UptimeListChecksResponseLinks- Uptime
List Checks Response Links Pages UptimeListChecksResponseLinksPages- Uptime
List Checks Response Links Pages Subtype0 UptimeListChecksResponseLinksPagesSubtype0- Uptime
List Checks Response Links Pages Subtype1 UptimeListChecksResponseLinksPagesSubtype1- Uptime
List Checks Response Meta UptimeListChecksResponseMeta- Uptime
Update Alert Body UptimeUpdateAlertBody- Uptime
Update Alert Body Notifications - The notification settings for a trigger alert.
- Uptime
Update Alert Body Notifications Slack Item UptimeUpdateAlertBodyNotificationsSlackItem- Uptime
Update Alert Response UptimeUpdateAlertResponse- Uptime
Update Alert Response Alert UptimeUpdateAlertResponseAlert- Uptime
Update Check Body UptimeUpdateCheckBody- Uptime
Update Check Response UptimeUpdateCheckResponse- Uptime
Update Check Response Check UptimeUpdateCheckResponseCheck- Vector
Databases Create Body VectorDatabasesCreateBody- Vector
Databases Create Response VectorDatabasesCreateResponse- Vector
Databases Create Response Vector Db - VectorDB represents a provisioned vector database instance.
- Vector
Databases GetCredentials Response VectorDatabasesGetCredentialsResponse- Vector
Databases GetResponse VectorDatabasesGetResponse- Vector
Databases GetResponse Vector Db - VectorDB represents a provisioned vector database instance.
- Vector
Databases GetRestore Status Response VectorDatabasesGetRestoreStatusResponse- Vector
Databases List Backups Response VectorDatabasesListBackupsResponse- Vector
Databases List Backups Response Backups Item - Backup represents a single backup of a vector database.
- Vector
Databases List Response VectorDatabasesListResponse- Vector
Databases List Response Vector DbsItem - VectorDB represents a provisioned vector database instance.
- Vector
Databases Post Resize Body VectorDatabasesPostResizeBody- Vector
Databases Post Resize Response VectorDatabasesPostResizeResponse- Vector
Databases Post Resize Response Vector Db - VectorDB represents a provisioned vector database instance.
- Vector
Databases Post Restore Backup Body VectorDatabasesPostRestoreBackupBody- Vector
Databases Post Restore Backup Response VectorDatabasesPostRestoreBackupResponse- Vector
Databases Update Body VectorDatabasesUpdateBody- Vector
Databases Update Body Config - VectorDBConfig holds optional, advanced cluster settings.
- Vector
Databases Update Response VectorDatabasesUpdateResponse- Vector
Databases Update Response Vector Db - VectorDB represents a provisioned vector database instance.
- Vector
Databases Update Tags Body VectorDatabasesUpdateTagsBody- Vector
Databases Update Tags Response VectorDatabasesUpdateTagsResponse- Vector
Databases Update Tags Response Vector Db - VectorDB represents a provisioned vector database instance.
- Volume
Actions GetResponse VolumeActionsGetResponse- Volume
Actions GetResponse Action VolumeActionsGetResponseAction- Volume
Actions GetResponse Action Region VolumeActionsGetResponseActionRegion- Volume
Actions List Response VolumeActionsListResponse- Volume
Actions List Response Actions Item VolumeActionsListResponseActionsItem- Volume
Actions List Response Actions Item Region VolumeActionsListResponseActionsItemRegion- Volume
Actions List Response Links VolumeActionsListResponseLinks- Volume
Actions List Response Links Pages VolumeActionsListResponseLinksPages- Volume
Actions List Response Links Pages Subtype0 VolumeActionsListResponseLinksPagesSubtype0- Volume
Actions List Response Links Pages Subtype1 VolumeActionsListResponseLinksPagesSubtype1- Volume
Actions List Response Meta VolumeActionsListResponseMeta- Volume
Actions Post Body VolumeActionsPostBody- Volume
Actions Post Body Subtype0 VolumeActionsPostBodySubtype0- Volume
Actions Post Body Subtype1 VolumeActionsPostBodySubtype1- Volume
Actions Post ById Body VolumeActionsPostByIdBody- Volume
Actions Post ById Body Subtype0 VolumeActionsPostByIdBodySubtype0- Volume
Actions Post ById Body Subtype1 VolumeActionsPostByIdBodySubtype1- Volume
Actions Post ById Body Subtype2 VolumeActionsPostByIdBodySubtype2- Volume
Actions Post ById Response VolumeActionsPostByIdResponse- Volume
Actions Post ById Response Action VolumeActionsPostByIdResponseAction- Volume
Actions Post ById Response Action Region VolumeActionsPostByIdResponseActionRegion- Volume
Actions Post Response VolumeActionsPostResponse- Volume
Actions Post Response Action VolumeActionsPostResponseAction- Volume
Actions Post Response Action Region VolumeActionsPostResponseActionRegion- Volume
Snapshots Create Body VolumeSnapshotsCreateBody- Volume
Snapshots Create Response VolumeSnapshotsCreateResponse- Volume
Snapshots Create Response Snapshot VolumeSnapshotsCreateResponseSnapshot- Volume
Snapshots GetBy IdResponse VolumeSnapshotsGetByIdResponse- Volume
Snapshots GetBy IdResponse Snapshot VolumeSnapshotsGetByIdResponseSnapshot- Volume
Snapshots List Response VolumeSnapshotsListResponse- Volume
Snapshots List Response Links VolumeSnapshotsListResponseLinks- Volume
Snapshots List Response Links Pages VolumeSnapshotsListResponseLinksPages- Volume
Snapshots List Response Links Pages Subtype0 VolumeSnapshotsListResponseLinksPagesSubtype0- Volume
Snapshots List Response Links Pages Subtype1 VolumeSnapshotsListResponseLinksPagesSubtype1- Volume
Snapshots List Response Meta VolumeSnapshotsListResponseMeta- Volume
Snapshots List Response Snapshots Item VolumeSnapshotsListResponseSnapshotsItem- Volumes
Create Body VolumesCreateBody- Volumes
Create Body Subtype0 VolumesCreateBodySubtype0- Volumes
Create Body Subtype0 Filesystem Label VolumesCreateBodySubtype0FilesystemLabel- Volumes
Create Body Subtype1 VolumesCreateBodySubtype1- Volumes
Create Body Subtype1 Filesystem Label VolumesCreateBodySubtype1FilesystemLabel- Volumes
Create Response VolumesCreateResponse- Volumes
Create Response Volume VolumesCreateResponseVolume- Volumes
Create Response Volume Region VolumesCreateResponseVolumeRegion- Volumes
GetResponse VolumesGetResponse- Volumes
GetResponse Volume VolumesGetResponseVolume- Volumes
GetResponse Volume Region VolumesGetResponseVolumeRegion- Volumes
Item VolumesItem- Volumes
List Response VolumesListResponse- Volumes
List Response Links VolumesListResponseLinks- Volumes
List Response Links Pages VolumesListResponseLinksPages- Volumes
List Response Links Pages Subtype0 VolumesListResponseLinksPagesSubtype0- Volumes
List Response Links Pages Subtype1 VolumesListResponseLinksPagesSubtype1- Volumes
List Response Meta VolumesListResponseMeta- Volumes
List Response Volumes Item VolumesListResponseVolumesItem- Volumes
List Response Volumes Item Region VolumesListResponseVolumesItemRegion- VpcPeerings
Create Body VpcPeeringsCreateBody- VpcPeerings
Create Body Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- VpcPeerings
Create Response VpcPeeringsCreateResponse- VpcPeerings
Create Response VpcPeering VpcPeeringsCreateResponseVpcPeering- VpcPeerings
Create Response VpcPeering Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- VpcPeerings
Delete Response VpcPeeringsDeleteResponse- VpcPeerings
Delete Response VpcPeering VpcPeeringsDeleteResponseVpcPeering- VpcPeerings
Delete Response VpcPeering Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- VpcPeerings
GetResponse VpcPeeringsGetResponse- VpcPeerings
GetResponse VpcPeering VpcPeeringsGetResponseVpcPeering- VpcPeerings
GetResponse VpcPeering Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- VpcPeerings
List Response VpcPeeringsListResponse- VpcPeerings
List Response Links VpcPeeringsListResponseLinks- VpcPeerings
List Response Links Pages VpcPeeringsListResponseLinksPages- VpcPeerings
List Response Links Pages Subtype0 VpcPeeringsListResponseLinksPagesSubtype0- VpcPeerings
List Response Links Pages Subtype1 VpcPeeringsListResponseLinksPagesSubtype1- VpcPeerings
List Response Meta VpcPeeringsListResponseMeta- VpcPeerings
List Response VpcPeerings Item VpcPeeringsListResponseVpcPeeringsItem- VpcPeerings
List Response VpcPeerings Item Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- VpcPeerings
Patch Body VpcPeeringsPatchBody- VpcPeerings
Patch Body Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- VpcPeerings
Patch Response VpcPeeringsPatchResponse- VpcPeerings
Patch Response VpcPeering VpcPeeringsPatchResponseVpcPeering- VpcPeerings
Patch Response VpcPeering Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- Vpcnatgateways
Create Body VpcnatgatewaysCreateBody- Vpcnatgateways
Create Body Vpcs Item VpcnatgatewaysCreateBodyVpcsItem- Vpcnatgateways
Create Response VpcnatgatewaysCreateResponse- Vpcnatgateways
Create Response VpcNat Gateway VpcnatgatewaysCreateResponseVpcNatGateway- Vpcnatgateways
Create Response VpcNat Gateway Vpcs Item VpcnatgatewaysCreateResponseVpcNatGatewayVpcsItem- Vpcnatgateways
GetResponse VpcnatgatewaysGetResponse- Vpcnatgateways
GetResponse VpcNat Gateway VpcnatgatewaysGetResponseVpcNatGateway- Vpcnatgateways
GetResponse VpcNat Gateway Egresses - An object containing egress information for the VPC NAT gateway.
- Vpcnatgateways
GetResponse VpcNat Gateway Egresses Public Gateways Item VpcnatgatewaysGetResponseVpcNatGatewayEgressesPublicGatewaysItem- Vpcnatgateways
GetResponse VpcNat Gateway Vpcs Item VpcnatgatewaysGetResponseVpcNatGatewayVpcsItem- Vpcnatgateways
List Response VpcnatgatewaysListResponse- Vpcnatgateways
List Response Links VpcnatgatewaysListResponseLinks- Vpcnatgateways
List Response Links Pages VpcnatgatewaysListResponseLinksPages- Vpcnatgateways
List Response Links Pages Subtype0 VpcnatgatewaysListResponseLinksPagesSubtype0- Vpcnatgateways
List Response Links Pages Subtype1 VpcnatgatewaysListResponseLinksPagesSubtype1- Vpcnatgateways
List Response Meta VpcnatgatewaysListResponseMeta- Vpcnatgateways
List Response VpcNat Gateways Item VpcnatgatewaysListResponseVpcNatGatewaysItem- Vpcnatgateways
List Response VpcNat Gateways Item Egresses - An object containing egress information for the VPC NAT gateway.
- Vpcnatgateways
List Response VpcNat Gateways Item Egresses Public Gateways Item VpcnatgatewaysListResponseVpcNatGatewaysItemEgressesPublicGatewaysItem- Vpcnatgateways
List Response VpcNat Gateways Item Vpcs Item VpcnatgatewaysListResponseVpcNatGatewaysItemVpcsItem- Vpcnatgateways
Update Body VpcnatgatewaysUpdateBody- Vpcnatgateways
Update Body Vpcs Item VpcnatgatewaysUpdateBodyVpcsItem- Vpcnatgateways
Update Response VpcnatgatewaysUpdateResponse- Vpcnatgateways
Update Response VpcNat Gateway VpcnatgatewaysUpdateResponseVpcNatGateway- Vpcnatgateways
Update Response VpcNat Gateway Vpcs Item VpcnatgatewaysUpdateResponseVpcNatGatewayVpcsItem- Vpcs
Create Body VpcsCreateBody- Vpcs
Create Body Description - A free-form text field for describing the VPC’s purpose. It may be a maximum of 255 characters.
- Vpcs
Create Body Name - The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Vpcs
Create Peerings Body VpcsCreatePeeringsBody- Vpcs
Create Peerings Body Name - The name of the VPC peering. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Vpcs
Create Peerings Response VpcsCreatePeeringsResponse- Vpcs
Create Peerings Response Peering VpcsCreatePeeringsResponsePeering- Vpcs
Create Peerings Response Peering Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- Vpcs
Create Response VpcsCreateResponse- Vpcs
Create Response Vpc VpcsCreateResponseVpc- Vpcs
Create Response VpcDescription - A free-form text field for describing the VPC’s purpose. It may be a maximum of 255 characters.
- Vpcs
Create Response VpcName - The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Vpcs
GetResponse VpcsGetResponse- Vpcs
GetResponse Vpc VpcsGetResponseVpc- Vpcs
GetResponse VpcDescription - A free-form text field for describing the VPC’s purpose. It may be a maximum of 255 characters.
- Vpcs
GetResponse VpcName - The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Vpcs
List Members Response VpcsListMembersResponse- Vpcs
List Members Response Links VpcsListMembersResponseLinks- Vpcs
List Members Response Links Pages VpcsListMembersResponseLinksPages- Vpcs
List Members Response Links Pages Subtype0 VpcsListMembersResponseLinksPagesSubtype0- Vpcs
List Members Response Links Pages Subtype1 VpcsListMembersResponseLinksPagesSubtype1- Vpcs
List Members Response Members Item VpcsListMembersResponseMembersItem- Vpcs
List Members Response Members Item Urn - The uniform resource name (URN) for the resource in the format do:resource_type:resource_id.
- Vpcs
List Members Response Meta VpcsListMembersResponseMeta- Vpcs
List Peerings Response VpcsListPeeringsResponse- Vpcs
List Peerings Response Links VpcsListPeeringsResponseLinks- Vpcs
List Peerings Response Links Pages VpcsListPeeringsResponseLinksPages- Vpcs
List Peerings Response Links Pages Subtype0 VpcsListPeeringsResponseLinksPagesSubtype0- Vpcs
List Peerings Response Links Pages Subtype1 VpcsListPeeringsResponseLinksPagesSubtype1- Vpcs
List Peerings Response Meta VpcsListPeeringsResponseMeta- Vpcs
List Peerings Response Peerings Item VpcsListPeeringsResponsePeeringsItem- Vpcs
List Peerings Response Peerings Item Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- Vpcs
List Response VpcsListResponse- Vpcs
List Response Links VpcsListResponseLinks- Vpcs
List Response Links Pages VpcsListResponseLinksPages- Vpcs
List Response Links Pages Subtype0 VpcsListResponseLinksPagesSubtype0- Vpcs
List Response Links Pages Subtype1 VpcsListResponseLinksPagesSubtype1- Vpcs
List Response Meta VpcsListResponseMeta- Vpcs
List Response Vpcs Item VpcsListResponseVpcsItem- Vpcs
List Response Vpcs Item Description - A free-form text field for describing the VPC’s purpose. It may be a maximum of 255 characters.
- Vpcs
List Response Vpcs Item Name - The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Vpcs
Patch Body VpcsPatchBody- Vpcs
Patch Body Description - A free-form text field for describing the VPC’s purpose. It may be a maximum of 255 characters.
- Vpcs
Patch Body Name - The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Vpcs
Patch Peerings Body VpcsPatchPeeringsBody- Vpcs
Patch Peerings Body Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- Vpcs
Patch Peerings Response VpcsPatchPeeringsResponse- Vpcs
Patch Peerings Response Peering VpcsPatchPeeringsResponsePeering- Vpcs
Patch Peerings Response Peering Name - The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes.
- Vpcs
Patch Response VpcsPatchResponse- Vpcs
Patch Response Vpc VpcsPatchResponseVpc- Vpcs
Patch Response VpcDescription - A free-form text field for describing the VPC’s purpose. It may be a maximum of 255 characters.
- Vpcs
Patch Response VpcName - The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Vpcs
Update Body VpcsUpdateBody- Vpcs
Update Body Description - A free-form text field for describing the VPC’s purpose. It may be a maximum of 255 characters.
- Vpcs
Update Body Name - The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Vpcs
Update Response VpcsUpdateResponse- Vpcs
Update Response Vpc VpcsUpdateResponseVpc- Vpcs
Update Response VpcDescription - A free-form text field for describing the VPC’s purpose. It may be a maximum of 255 characters.
- Vpcs
Update Response VpcName - The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods.
- Worker
Components That ArePart OfThis Deployment Item WorkerComponentsThatArePartOfThisDeploymentItem
Enums§
- AList
OfApps Item Pending Deployment Phase AListOfAppsItemPendingDeploymentPhase- AList
OfApps Item Pinned Deployment Phase AListOfAppsItemPinnedDeploymentPhase- AList
OfEvents Item Autoscaling Phase - The current phase of the autoscaling event
- AList
OfEvents Item Type - The type of event
- AList
OfJob Invocations Item Phase - The phase of the job invocation
- AStep
That IsRun AsPart OfThe Deployments Lifecycle Status AStepThatIsRunAsPartOfTheDeploymentsLifecycleStatus- Account
GetResponse Account Status - This value is one of “active”, “warning” or “locked”.
- Actions
GetResponse Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Actions
List Response Actions Item Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Agent
Inference Create Chat Completion Body Messages Item Role - The role of the message author.
- Agent
Inference Create Chat Completion Body Messages Item Tool Calls Item Type - The type of the tool. Currently, only function is supported.
- Agent
Inference Create Chat Completion Body Reasoning Effort - Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
- Agent
Inference Create Chat Completion Body Stop - Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
- Agent
Inference Create Chat Completion Body Tool Choice - Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {“type”: “function”, “function”: {“name”: “my_function”}} forces the model to call that tool. none is the default when no tools are present. auto is the default if tools are present.
- Agent
Inference Create Chat Completion Body Tool Choice Variant0 AgentInferenceCreateChatCompletionBodyToolChoiceVariant0- Agent
Inference Create Chat Completion Body Tool Choice Variant1 Type AgentInferenceCreateChatCompletionBodyToolChoiceVariant1Type- Agent
Inference Create Chat Completion Body Tools Item Type - The type of the tool. Currently, only function is supported.
- Agent
Inference Create Chat Completion Response Choices Item Finish Reason - The reason the model stopped generating tokens. 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, tool_calls if the model called a tool.
- Agent
Inference Create Chat Completion Response Choices Item Message Role - The role of the author of this message.
- Agent
Inference Create Chat Completion Response Choices Item Message Tool Calls Item Type - The type of the tool.
- Agent
Inference Create Chat Completion Response Object - The object type, which is always chat.completion.
- AnApp
Deployment Phase AnAppDeploymentPhase- AppSpec
Databases Item Engine - MYSQL: MySQLPG: PostgreSQLREDIS: CachingMONGODB: MongoDBKAFKA: KafkaOPENSEARCH: OpenSearchVALKEY: ValKey
- AppSpec
Domains Item Minimum TlsVersion - The minimum version of TLS a client application can use to access resources for the domain. Must be one of the following values wrapped within quotations:
"1.2"or"1.3". - AppSpec
Domains Item Type - DEFAULT: The default
.ondigitalocean.appdomain assigned to this appPRIMARY: The primary domain for this app that is displayed as the default in the control panel, used in bindable environment variables, and any other places that reference an app’s live URL. Only one domain may be set as primary.ALIAS: A non-primary domain - AppSpec
Functions Item Alerts Item Operator AppSpecFunctionsItemAlertsItemOperator- AppSpec
Functions Item Alerts Item Rule AppSpecFunctionsItemAlertsItemRule- AppSpec
Functions Item Alerts Item Window AppSpecFunctionsItemAlertsItemWindow- AppSpec
Functions Item Envs Item Scope - RUN_TIME: Made available only at run-timeBUILD_TIME: Made available only at build-timeRUN_AND_BUILD_TIME: Made available at both build and run-time
- AppSpec
Functions Item Envs Item Type - GENERAL: A plain-text environment variableSECRET: A secret encrypted environment variable
- AppSpec
Jobs Item Envs Item Scope - RUN_TIME: Made available only at run-timeBUILD_TIME: Made available only at build-timeRUN_AND_BUILD_TIME: Made available at both build and run-time
- AppSpec
Jobs Item Envs Item Type - GENERAL: A plain-text environment variableSECRET: A secret encrypted environment variable
- AppSpec
Jobs Item Image Registry Type - DOCKER_HUB: The DockerHub container registry type.DOCR: The DigitalOcean container registry type.GHCR: The Github container registry type.
- AppSpec
Jobs Item Instance Size Slug - The instance size to use for this component. Default:
apps-s-1vcpu-0.5gb - AppSpec
Jobs Item Kind - UNSPECIFIED: Default job type, will auto-complete to POST_DEPLOY kind.PRE_DEPLOY: Indicates a job that runs before an app deployment.POST_DEPLOY: Indicates a job that runs after an app deployment.FAILED_DEPLOY: Indicates a job that runs after a component fails to deploy.
- AppSpec
Region - The slug form of the geographical origin of the app. Default:
nearest available - AppSpec
Services Item Envs Item Scope - RUN_TIME: Made available only at run-timeBUILD_TIME: Made available only at build-timeRUN_AND_BUILD_TIME: Made available at both build and run-time
- AppSpec
Services Item Envs Item Type - GENERAL: A plain-text environment variableSECRET: A secret encrypted environment variable
- AppSpec
Services Item Image Registry Type - DOCKER_HUB: The DockerHub container registry type.DOCR: The DigitalOcean container registry type.GHCR: The Github container registry type.
- AppSpec
Services Item Instance Size Slug - The instance size to use for this component. Default:
apps-s-1vcpu-0.5gb - AppSpec
Services Item Protocol - The protocol which the service uses to serve traffic on the http_port.
- AppSpec
Static Sites Item Envs Item Scope - RUN_TIME: Made available only at run-timeBUILD_TIME: Made available only at build-timeRUN_AND_BUILD_TIME: Made available at both build and run-time
- AppSpec
Static Sites Item Envs Item Type - GENERAL: A plain-text environment variableSECRET: A secret encrypted environment variable
- AppSpec
Static Sites Item Image Registry Type - DOCKER_HUB: The DockerHub container registry type.DOCR: The DigitalOcean container registry type.GHCR: The Github container registry type.
- AppSpec
Workers Item Envs Item Scope - RUN_TIME: Made available only at run-timeBUILD_TIME: Made available only at build-timeRUN_AND_BUILD_TIME: Made available at both build and run-time
- AppSpec
Workers Item Envs Item Type - GENERAL: A plain-text environment variableSECRET: A secret encrypted environment variable
- AppSpec
Workers Item Image Registry Type - DOCKER_HUB: The DockerHub container registry type.DOCR: The DigitalOcean container registry type.GHCR: The Github container registry type.
- AppSpec
Workers Item Instance Size Slug - The instance size to use for this component. Default:
apps-s-1vcpu-0.5gb - Apps
Assign Alert Destinations Response Alert Phase AppsAssignAlertDestinationsResponseAlertPhase- Apps
Assign Alert Destinations Response Alert Spec Operator AppsAssignAlertDestinationsResponseAlertSpecOperator- Apps
Assign Alert Destinations Response Alert Spec Rule AppsAssignAlertDestinationsResponseAlertSpecRule- Apps
Assign Alert Destinations Response Alert Spec Window AppsAssignAlertDestinationsResponseAlertSpecWindow- Apps
Cancel Event Response Event Autoscaling Phase - The current phase of the autoscaling event
- Apps
Cancel Event Response Event Type - The type of event
- Apps
Cancel JobInvocation Response Phase - The phase of the job invocation
- Apps
Create Accept AppsCreateAccept- Apps
Create Content Type AppsCreateContentType- Apps
Create Response AppPending Deployment Phase AppsCreateResponseAppPendingDeploymentPhase- Apps
Create Response AppPinned Deployment Phase AppsCreateResponseAppPinnedDeploymentPhase- Apps
GetEvent Logs Type AppsGetEventLogsType- Apps
GetEvent Response Event Autoscaling Phase - The current phase of the autoscaling event
- Apps
GetEvent Response Event Type - The type of event
- Apps
GetHealth Response AppHealth Components Item State AppsGetHealthResponseAppHealthComponentsItemState- Apps
GetInstances Response Instances Item Component Type - Supported compute component by DigitalOcean App Platform.
- Apps
GetJob Invocation Logs Type AppsGetJobInvocationLogsType- Apps
GetJob Invocation Response Phase - The phase of the job invocation
- Apps
GetLogs Active Deployment Aggregate Type AppsGetLogsActiveDeploymentAggregateType- Apps
GetLogs Active Deployment Type AppsGetLogsActiveDeploymentType- Apps
GetLogs Aggregate Type AppsGetLogsAggregateType- Apps
GetLogs Type AppsGetLogsType- Apps
GetResponse AppPending Deployment Phase AppsGetResponseAppPendingDeploymentPhase- Apps
GetResponse AppPinned Deployment Phase AppsGetResponseAppPinnedDeploymentPhase- Apps
List Alerts Response Alerts Item Phase AppsListAlertsResponseAlertsItemPhase- Apps
List Alerts Response Alerts Item Spec Operator AppsListAlertsResponseAlertsItemSpecOperator- Apps
List Alerts Response Alerts Item Spec Rule AppsListAlertsResponseAlertsItemSpecRule- Apps
List Alerts Response Alerts Item Spec Window AppsListAlertsResponseAlertsItemSpecWindow- Apps
List Deployments Deployment Types Item AppsListDeploymentsDeploymentTypesItem- Apps
List Events Event Types Item AppsListEventsEventTypesItem- Apps
Update Response AppPending Deployment Phase AppsUpdateResponseAppPendingDeploymentPhase- Apps
Update Response AppPinned Deployment Phase AppsUpdateResponseAppPinnedDeploymentPhase- Apps
Validate Rollback Response Error Code - A code identifier that represents the failing condition.
- Apps
Validate Rollback Response Warnings Item Code - A code identifier that represents the failing condition.
- Assign
Droplets ById Algorithm - This field has been deprecated. You can no longer specify an algorithm for load balancers.
- Assign
Droplets ById Forwarding Rules Item Entry Protocol - The protocol used for traffic to the load balancer. The possible values are:
http,https,http2,http3,tcp, orudp. If you set theentry_protocoltoudp, thetarget_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Assign
Droplets ById Forwarding Rules Item Target Protocol - The protocol used for traffic from the load balancer to the backend Droplets. The possible values are:
http,https,http2,tcp, orudp. If you set thetarget_protocoltoudp, theentry_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Assign
Droplets ById GlbSettings Target Protocol - The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are
http,httpsandhttp2. - Assign
Droplets ById Health Check Protocol - The protocol used for health checks sent to the backend Droplets. The possible values are
http,https, ortcp. - Assign
Droplets ById Network - A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer.
- Assign
Droplets ById Network Stack - A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer.
- Assign
Droplets ById Region - The slug identifier for the region where the resource will initially be available.
- Assign
Droplets ById Size - This field has been replaced by the
size_unitfield for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes. - Assign
Droplets ById Status - A status string indicating the current state of the load balancer. This can be
new,active, orerrored. - Assign
Droplets ById Sticky Sessions Type - An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookiesornone. - Assign
Droplets ById TlsCipher Policy - A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are
DEFAULTorSTRONG. The default value isDEFAULT. - Assign
Droplets ById Type - A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer.
- Assign
Droplets ByTag Algorithm - This field has been deprecated. You can no longer specify an algorithm for load balancers.
- Assign
Droplets ByTag Forwarding Rules Item Entry Protocol - The protocol used for traffic to the load balancer. The possible values are:
http,https,http2,http3,tcp, orudp. If you set theentry_protocoltoudp, thetarget_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Assign
Droplets ByTag Forwarding Rules Item Target Protocol - The protocol used for traffic from the load balancer to the backend Droplets. The possible values are:
http,https,http2,tcp, orudp. If you set thetarget_protocoltoudp, theentry_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Assign
Droplets ByTag GlbSettings Target Protocol - The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are
http,httpsandhttp2. - Assign
Droplets ByTag Health Check Protocol - The protocol used for health checks sent to the backend Droplets. The possible values are
http,https, ortcp. - Assign
Droplets ByTag Network - A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer.
- Assign
Droplets ByTag Network Stack - A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer.
- Assign
Droplets ByTag Region - The slug identifier for the region where the resource will initially be available.
- Assign
Droplets ByTag Size - This field has been replaced by the
size_unitfield for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes. - Assign
Droplets ByTag Status - A status string indicating the current state of the load balancer. This can be
new,active, orerrored. - Assign
Droplets ByTag Sticky Sessions Type - An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookiesornone. - Assign
Droplets ByTag TlsCipher Policy - A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are
DEFAULTorSTRONG. The default value isDEFAULT. - Assign
Droplets ByTag Type - A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer.
- Autoscalepools
Create Body Config - The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).
- Autoscalepools
Create Body Droplet Template Region - The datacenter in which all of the Droplets will be created.
- Autoscalepools
Create Response Autoscale Pool Config - The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).
- Autoscalepools
Create Response Autoscale Pool Droplet Template Region - The datacenter in which all of the Droplets will be created.
- Autoscalepools
Create Response Autoscale Pool Status - The current status of the autoscale pool.
- Autoscalepools
GetResponse Autoscale Pool Config - The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).
- Autoscalepools
GetResponse Autoscale Pool Droplet Template Region - The datacenter in which all of the Droplets will be created.
- Autoscalepools
GetResponse Autoscale Pool Status - The current status of the autoscale pool.
- Autoscalepools
List History Response History Item Reason - The reason for the scaling event.
- Autoscalepools
List History Response History Item Status - The status of the scaling event.
- Autoscalepools
List Members Response Droplets Item Health Status - The health status of the Droplet.
- Autoscalepools
List Members Response Droplets Item Status - The power status of the Droplet.
- Autoscalepools
List Response Autoscale Pools Item Config - The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).
- Autoscalepools
List Response Autoscale Pools Item Droplet Template Region - The datacenter in which all of the Droplets will be created.
- Autoscalepools
List Response Autoscale Pools Item Status - The current status of the autoscale pool.
- Autoscalepools
Update Body Config - The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).
- Autoscalepools
Update Body Droplet Template Region - The datacenter in which all of the Droplets will be created.
- Autoscalepools
Update Response Autoscale Pool Config - The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).
- Autoscalepools
Update Response Autoscale Pool Droplet Template Region - The datacenter in which all of the Droplets will be created.
- Autoscalepools
Update Response Autoscale Pool Status - The current status of the autoscale pool.
- Batch
List Response Data Item Completion Window BatchListResponseDataItemCompletionWindow- Batch
List Response Data Item Provider BatchListResponseDataItemProvider- Batch
List Response Data Item Status - Lifecycle status. Terminal states:
completed,failed,expired,cancelled. - Batch
List Response Object - The object type, always
list. - Billing
History List Response Billing History Item Type - Type of billing history entry.
- Certificates
Create Body CertificatesCreateBody- Certificates
Create Response Certificate State - A string representing the current state of the certificate. It may be
pending,verified, orerror. - Certificates
Create Response Certificate Type - A string representing the type of the certificate. The value will be
customfor a user-uploaded certificate orlets_encryptfor one automatically generated with Let’s Encrypt. - Certificates
GetResponse Certificate State - A string representing the current state of the certificate. It may be
pending,verified, orerror. - Certificates
GetResponse Certificate Type - A string representing the type of the certificate. The value will be
customfor a user-uploaded certificate orlets_encryptfor one automatically generated with Let’s Encrypt. - Certificates
List Response Certificates Item State - A string representing the current state of the certificate. It may be
pending,verified, orerror. - Certificates
List Response Certificates Item Type - A string representing the type of the certificate. The value will be
customfor a user-uploaded certificate orlets_encryptfor one automatically generated with Let’s Encrypt. - Contains
AllDomains ForThe AppItem Phase ContainsAllDomainsForTheAppItemPhase- Contains
AllDomains ForThe AppItem Spec Minimum TlsVersion - The minimum version of TLS a client application can use to access resources for the domain. Must be one of the following values wrapped within quotations:
"1.2"or"1.3". - Contains
AllDomains ForThe AppItem Spec Type - DEFAULT: The default
.ondigitalocean.appdomain assigned to this appPRIMARY: The primary domain for this app that is displayed as the default in the control panel, used in bindable environment variables, and any other places that reference an app’s live URL. Only one domain may be set as primary.ALIAS: A non-primary domain - Custom
Certificate Request Type - A string representing the type of the certificate. The value will be
customfor a user-uploaded certificate orlets_encryptfor one automatically generated with Let’s Encrypt. - Databases
AddUser Body Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
AddUser Body Role - A string representing the database user’s role. The value will be either “primary” or “normal”.
- Databases
AddUser Body Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
AddUser Body Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
AddUser Body Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Databases
AddUser Response User Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
AddUser Response User Role - A string representing the database user’s role. The value will be either “primary” or “normal”.
- Databases
AddUser Response User Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
AddUser Response User Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
AddUser Response User Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Databases
Create Cluster Body Engine - A slug representing the database engine used for the cluster. The possible values are: “pg” for PostgreSQL, “mysql” for MySQL, “redis” for Caching, “mongodb” for MongoDB, “kafka” for Kafka, “opensearch” for OpenSearch, “valkey” for Valkey, “advanced_pg” for PostgreSQL Advanced Edition, and “advanced_mysql” for MySQL Advanced Edition. Advanced Edition engines are currently in public preview.
- Databases
Create Cluster Body Rules Item Type - The type of resource that the firewall rule allows to access the database cluster.
- Databases
Create Cluster Body Status - A string representing the current status of the database cluster.
- Databases
Create Cluster Body Users Item Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
Create Cluster Body Users Item Role - A string representing the database user’s role. The value will be either “primary” or “normal”.
- Databases
Create Cluster Body Users Item Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
Create Cluster Body Users Item Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
Create Cluster Body Users Item Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Databases
Create Cluster Response Database Engine - A slug representing the database engine used for the cluster. The possible values are: “pg” for PostgreSQL, “mysql” for MySQL, “redis” for Caching, “mongodb” for MongoDB, “kafka” for Kafka, “opensearch” for OpenSearch, “valkey” for Valkey, “advanced_pg” for PostgreSQL Advanced Edition, and “advanced_mysql” for MySQL Advanced Edition. Advanced Edition engines are currently in public preview.
- Databases
Create Cluster Response Database Rules Item Type - The type of resource that the firewall rule allows to access the database cluster.
- Databases
Create Cluster Response Database Status - A string representing the current status of the database cluster.
- Databases
Create Cluster Response Database Users Item Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
Create Cluster Response Database Users Item Role - A string representing the database user’s role. The value will be either “primary” or “normal”.
- Databases
Create Cluster Response Database Users Item Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
Create Cluster Response Database Users Item Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
Create Cluster Response Database Users Item Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Databases
Create Kafka Schema Body Schema Type - The type of the schema.
- Databases
Create Kafka Schema Response Schema Type - The type of the schema.
- Databases
Create Kafka Topic Body Config Cleanup Policy - The cleanup_policy sets the retention policy to use on log segments. ‘delete’ will discard old segments when retention time/size limits are reached. ‘compact’ will enable log compaction, resulting in retention of the latest value for each key.
- Databases
Create Kafka Topic Body Config Compression Type - The compression_type specifies the compression type of the topic.
- Databases
Create Kafka Topic Body Config Message Format Version - The message_format_version specifies the message format version used by the broker to append messages to the logs. The value of this setting is assumed to be 3.0-IV1 if the broker protocol version is 3.0 or higher. By setting a particular message format version, all existing messages on disk must be smaller or equal to the specified version.
- Databases
Create Kafka Topic Body Config Message Timestamp Type - The message_timestamp_type specifies whether to use the message create time or log append time as the timestamp on a message.
- Databases
Create Kafka Topic Response Topic Config Cleanup Policy - The cleanup_policy sets the retention policy to use on log segments. ‘delete’ will discard old segments when retention time/size limits are reached. ‘compact’ will enable log compaction, resulting in retention of the latest value for each key.
- Databases
Create Kafka Topic Response Topic Config Compression Type - The compression_type specifies the compression type of the topic.
- Databases
Create Kafka Topic Response Topic Config Message Format Version - The message_format_version specifies the message format version used by the broker to append messages to the logs. The value of this setting is assumed to be 3.0-IV1 if the broker protocol version is 3.0 or higher. By setting a particular message format version, all existing messages on disk must be smaller or equal to the specified version.
- Databases
Create Kafka Topic Response Topic Config Message Timestamp Type - The message_timestamp_type specifies whether to use the message create time or log append time as the timestamp on a message.
- Databases
Create Kafka Topic Response Topic State - The state of the Kafka topic.
- Databases
Create Logsink Body Config Subtype0 Format - Message format used by the server, this can be either rfc3164 (the old BSD style message format),
rfc5424(current syslog message format) or custom - Databases
Create Logsink Body Sink Type - Type of logsink integration.
- Databases
Create Logsink Response Sink Config Subtype0 Format - Message format used by the server, this can be either rfc3164 (the old BSD style message format),
rfc5424(current syslog message format) or custom - Databases
Create Logsink Response Sink Sink Type DatabasesCreateLogsinkResponseSinkSinkType- Databases
Create Replica Body Status - A string representing the current status of the database cluster.
- Databases
Create Replica Response Replica Status - A string representing the current status of the database cluster.
- Databases
GetCluster Response Database Engine - A slug representing the database engine used for the cluster. The possible values are: “pg” for PostgreSQL, “mysql” for MySQL, “redis” for Caching, “mongodb” for MongoDB, “kafka” for Kafka, “opensearch” for OpenSearch, “valkey” for Valkey, “advanced_pg” for PostgreSQL Advanced Edition, and “advanced_mysql” for MySQL Advanced Edition. Advanced Edition engines are currently in public preview.
- Databases
GetCluster Response Database Rules Item Type - The type of resource that the firewall rule allows to access the database cluster.
- Databases
GetCluster Response Database Status - A string representing the current status of the database cluster.
- Databases
GetCluster Response Database Users Item Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
GetCluster Response Database Users Item Role - A string representing the database user’s role. The value will be either “primary” or “normal”.
- Databases
GetCluster Response Database Users Item Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
GetCluster Response Database Users Item Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
GetCluster Response Database Users Item Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Databases
GetConfig Response Config Subtype0 Internal TmpMem Storage Engine - The storage engine for in-memory internal temporary tables.
- Databases
GetConfig Response Config Subtype0 LogOutput - Defines the destination for logs. Can be
INSIGHTS,TABLE, or both (INSIGHTS,TABLE), orNONEto disable logs. To specify both destinations, useINSIGHTS,TABLE(order matters). Default is NONE. - Databases
GetConfig Response Config Subtype1 Default Toast Compression - Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
- Databases
GetConfig Response Config Subtype1 LogError Verbosity - Controls the amount of detail written in the server log for each message that is logged.
- Databases
GetConfig Response Config Subtype1 LogLine Prefix - Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc.
- Databases
GetConfig Response Config Subtype1 PgStat Statements Track - Controls which statements are counted. Specify ‘top’ to track top-level statements (those issued directly by clients), ‘all’ to also track nested statements (such as statements invoked within functions), or ‘none’ to disable statement statistics collection. The default value is top.
- Databases
GetConfig Response Config Subtype1 Pgbouncer Autodb Pool Mode - PGBouncer pool mode
- Databases
GetConfig Response Config Subtype1 Pgbouncer Ignore Startup Parameters Item - Enum of parameters to ignore when given in startup packet.
- Databases
GetConfig Response Config Subtype1 Synchronous Replication - Synchronous replication type. Note that the service plan also needs to support synchronous replication.
- Databases
GetConfig Response Config Subtype1 Track Commit Timestamp - Record commit time of transactions.
- Databases
GetConfig Response Config Subtype1 Track Functions - Enables tracking of function call counts and time used.
- Databases
GetConfig Response Config Subtype1 Track IoTiming - Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
- Databases
GetConfig Response Config Subtype2 Redis AclChannels Default - Determines default pub/sub channels’ ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn’t affect Caching configuration acl-pubsub-default.
- Databases
GetConfig Response Config Subtype2 Redis Maxmemory Policy - A string specifying the desired eviction policy for the Caching cluster.
- Databases
GetConfig Response Config Subtype2 Redis Persistence - Creates an RDB dump of the database every 10 minutes that can be used to recover data after a node crash. The database does not create the dump if no keys have changed since the last dump. When set to
off, the database cannot fork services, and data can be lost if a service is restarted or powered off. DigitalOcean Managed Caching databases do not support the Append Only File (AOF) persistence method. - Databases
GetConfig Response Config Subtype3 Valkey AclChannels Default - Determines default pub/sub channels’ ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn’t affect Valkey configuration acl-pubsub-default.
- Databases
GetConfig Response Config Subtype3 Valkey Maxmemory Policy - A string specifying the desired eviction policy for a Caching or Valkey cluster.
- Databases
GetConfig Response Config Subtype3 Valkey Persistence - When persistence is ‘rdb’, Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is ‘off’, no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can’t be forked.
- Databases
GetConfig Response Config Subtype4 Compression Type - Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (‘gzip’, ‘snappy’, ‘lz4’, ‘zstd’). It additionally accepts ‘uncompressed’ which is equivalent to no compression; and ‘producer’ which means retain the original compression codec set by the producer.
- Databases
GetConfig Response Config Subtype4 LogCleanup Policy - The default cleanup policy for segments beyond the retention window
- Databases
GetConfig Response Config Subtype4 LogMessage Timestamp Type - Define whether the timestamp in the message is message create time or log append time.
- Databases
GetConfig Response Config Subtype6 Default Read Concern - Specifies the default consistency behavior of reads from the database. Data that is returned from the query with may or may not have been acknowledged by all nodes in the replicaset depending on this value. Learn more here.
- Databases
GetEviction Policy Response Eviction Policy - A string specifying the desired eviction policy for a Caching or Valkey cluster.
- Databases
GetKafka Schema Config Response Compatibility Level - The compatibility level of the schema registry.
- Databases
GetKafka Schema Response Schema Type - The type of the schema.
- Databases
GetKafka Schema Subject Config Response Compatibility Level - The compatibility level of the schema registry.
- Databases
GetKafka Schema Version Response Schema Type - The type of the schema.
- Databases
GetKafka Topic Response Topic Config Cleanup Policy - The cleanup_policy sets the retention policy to use on log segments. ‘delete’ will discard old segments when retention time/size limits are reached. ‘compact’ will enable log compaction, resulting in retention of the latest value for each key.
- Databases
GetKafka Topic Response Topic Config Compression Type - The compression_type specifies the compression type of the topic.
- Databases
GetKafka Topic Response Topic Config Message Format Version - The message_format_version specifies the message format version used by the broker to append messages to the logs. The value of this setting is assumed to be 3.0-IV1 if the broker protocol version is 3.0 or higher. By setting a particular message format version, all existing messages on disk must be smaller or equal to the specified version.
- Databases
GetKafka Topic Response Topic Config Message Timestamp Type - The message_timestamp_type specifies whether to use the message create time or log append time as the timestamp on a message.
- Databases
GetKafka Topic Response Topic State - The state of the Kafka topic.
- Databases
GetLogsink Response Config Subtype0 Format - Message format used by the server, this can be either rfc3164 (the old BSD style message format),
rfc5424(current syslog message format) or custom - Databases
GetLogsink Response Sink Type DatabasesGetLogsinkResponseSinkType- Databases
GetMigration Status Response Status - The current status of the migration.
- Databases
GetReplica Response Replica Status - A string representing the current status of the database cluster.
- Databases
GetUser Response User Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
GetUser Response User Role - A string representing the database user’s role. The value will be either “primary” or “normal”.
- Databases
GetUser Response User Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
GetUser Response User Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
GetUser Response User Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Databases
List Clusters Response Databases Item Engine - A slug representing the database engine used for the cluster. The possible values are: “pg” for PostgreSQL, “mysql” for MySQL, “redis” for Caching, “mongodb” for MongoDB, “kafka” for Kafka, “opensearch” for OpenSearch, “valkey” for Valkey, “advanced_pg” for PostgreSQL Advanced Edition, and “advanced_mysql” for MySQL Advanced Edition. Advanced Edition engines are currently in public preview.
- Databases
List Clusters Response Databases Item Rules Item Type - The type of resource that the firewall rule allows to access the database cluster.
- Databases
List Clusters Response Databases Item Status - A string representing the current status of the database cluster.
- Databases
List Clusters Response Databases Item Users Item Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
List Clusters Response Databases Item Users Item Role - A string representing the database user’s role. The value will be either “primary” or “normal”.
- Databases
List Clusters Response Databases Item Users Item Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
List Clusters Response Databases Item Users Item Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
List Clusters Response Databases Item Users Item Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Databases
List Events Logs Response Events Item Event Type - Type of the event.
- Databases
List Firewall Rules Response Rules Item Type - The type of resource that the firewall rule allows to access the database cluster.
- Databases
List Kafka Schemas Response Subjects Item Schema Type - The type of the schema.
- Databases
List Kafka Topics Response Topics Item State - The state of the Kafka topic.
- Databases
List Logsink Response Sinks Item Config Subtype0 Format - Message format used by the server, this can be either rfc3164 (the old BSD style message format),
rfc5424(current syslog message format) or custom - Databases
List Logsink Response Sinks Item Sink Type DatabasesListLogsinkResponseSinksItemSinkType- Databases
List Opeasearch Indexes Response Indexes Item Health - The health of the OpenSearch index.
- Databases
List Opeasearch Indexes Response Indexes Item Status - The status of the OpenSearch index.
- Databases
List Replicas Response Replicas Item Status - A string representing the current status of the database cluster.
- Databases
List Users Response Users Item Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
List Users Response Users Item Role - A string representing the database user’s role. The value will be either “primary” or “normal”.
- Databases
List Users Response Users Item Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
List Users Response Users Item Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
List Users Response Users Item Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Databases
Patch Config Body Config Subtype0 Internal TmpMem Storage Engine - The storage engine for in-memory internal temporary tables.
- Databases
Patch Config Body Config Subtype0 LogOutput - Defines the destination for logs. Can be
INSIGHTS,TABLE, or both (INSIGHTS,TABLE), orNONEto disable logs. To specify both destinations, useINSIGHTS,TABLE(order matters). Default is NONE. - Databases
Patch Config Body Config Subtype1 Default Toast Compression - Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
- Databases
Patch Config Body Config Subtype1 LogError Verbosity - Controls the amount of detail written in the server log for each message that is logged.
- Databases
Patch Config Body Config Subtype1 LogLine Prefix - Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc.
- Databases
Patch Config Body Config Subtype1 PgStat Statements Track - Controls which statements are counted. Specify ‘top’ to track top-level statements (those issued directly by clients), ‘all’ to also track nested statements (such as statements invoked within functions), or ‘none’ to disable statement statistics collection. The default value is top.
- Databases
Patch Config Body Config Subtype1 Pgbouncer Autodb Pool Mode - PGBouncer pool mode
- Databases
Patch Config Body Config Subtype1 Pgbouncer Ignore Startup Parameters Item - Enum of parameters to ignore when given in startup packet.
- Databases
Patch Config Body Config Subtype1 Synchronous Replication - Synchronous replication type. Note that the service plan also needs to support synchronous replication.
- Databases
Patch Config Body Config Subtype1 Track Commit Timestamp - Record commit time of transactions.
- Databases
Patch Config Body Config Subtype1 Track Functions - Enables tracking of function call counts and time used.
- Databases
Patch Config Body Config Subtype1 Track IoTiming - Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
- Databases
Patch Config Body Config Subtype2 Redis AclChannels Default - Determines default pub/sub channels’ ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn’t affect Caching configuration acl-pubsub-default.
- Databases
Patch Config Body Config Subtype2 Redis Maxmemory Policy - A string specifying the desired eviction policy for the Caching cluster.
- Databases
Patch Config Body Config Subtype2 Redis Persistence - Creates an RDB dump of the database every 10 minutes that can be used to recover data after a node crash. The database does not create the dump if no keys have changed since the last dump. When set to
off, the database cannot fork services, and data can be lost if a service is restarted or powered off. DigitalOcean Managed Caching databases do not support the Append Only File (AOF) persistence method. - Databases
Patch Config Body Config Subtype3 Valkey AclChannels Default - Determines default pub/sub channels’ ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn’t affect Valkey configuration acl-pubsub-default.
- Databases
Patch Config Body Config Subtype3 Valkey Maxmemory Policy - A string specifying the desired eviction policy for a Caching or Valkey cluster.
- Databases
Patch Config Body Config Subtype3 Valkey Persistence - When persistence is ‘rdb’, Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is ‘off’, no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can’t be forked.
- Databases
Patch Config Body Config Subtype4 Default Read Concern - Specifies the default consistency behavior of reads from the database. Data that is returned from the query with may or may not have been acknowledged by all nodes in the replicaset depending on this value. Learn more here.
- Databases
Patch Config Body Config Subtype5 Compression Type - Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (‘gzip’, ‘snappy’, ‘lz4’, ‘zstd’). It additionally accepts ‘uncompressed’ which is equivalent to no compression; and ‘producer’ which means retain the original compression codec set by the producer.
- Databases
Patch Config Body Config Subtype5 LogCleanup Policy - The default cleanup policy for segments beyond the retention window
- Databases
Patch Config Body Config Subtype5 LogMessage Timestamp Type - Define whether the timestamp in the message is message create time or log append time.
- Databases
Reset Auth Body Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
Reset Auth Response User Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
Reset Auth Response User Role - A string representing the database user’s role. The value will be either “primary” or “normal”.
- Databases
Reset Auth Response User Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
Reset Auth Response User Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
Reset Auth Response User Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Databases
Update Eviction Policy Body Eviction Policy - A string specifying the desired eviction policy for a Caching or Valkey cluster.
- Databases
Update Firewall Rules Body Rules Item Type - The type of resource that the firewall rule allows to access the database cluster.
- Databases
Update Kafka Schema Config Body Compatibility Level - The compatibility level of the schema registry.
- Databases
Update Kafka Schema Config Response Compatibility Level - The compatibility level of the schema registry.
- Databases
Update Kafka Schema Subject Config Body Compatibility Level - The compatibility level of the schema registry.
- Databases
Update Kafka Schema Subject Config Response Compatibility Level - The compatibility level of the schema registry.
- Databases
Update Kafka Topic Body Config Cleanup Policy - The cleanup_policy sets the retention policy to use on log segments. ‘delete’ will discard old segments when retention time/size limits are reached. ‘compact’ will enable log compaction, resulting in retention of the latest value for each key.
- Databases
Update Kafka Topic Body Config Compression Type - The compression_type specifies the compression type of the topic.
- Databases
Update Kafka Topic Body Config Message Format Version - The message_format_version specifies the message format version used by the broker to append messages to the logs. The value of this setting is assumed to be 3.0-IV1 if the broker protocol version is 3.0 or higher. By setting a particular message format version, all existing messages on disk must be smaller or equal to the specified version.
- Databases
Update Kafka Topic Body Config Message Timestamp Type - The message_timestamp_type specifies whether to use the message create time or log append time as the timestamp on a message.
- Databases
Update Kafka Topic Response Topic Config Cleanup Policy - The cleanup_policy sets the retention policy to use on log segments. ‘delete’ will discard old segments when retention time/size limits are reached. ‘compact’ will enable log compaction, resulting in retention of the latest value for each key.
- Databases
Update Kafka Topic Response Topic Config Compression Type - The compression_type specifies the compression type of the topic.
- Databases
Update Kafka Topic Response Topic Config Message Format Version - The message_format_version specifies the message format version used by the broker to append messages to the logs. The value of this setting is assumed to be 3.0-IV1 if the broker protocol version is 3.0 or higher. By setting a particular message format version, all existing messages on disk must be smaller or equal to the specified version.
- Databases
Update Kafka Topic Response Topic Config Message Timestamp Type - The message_timestamp_type specifies whether to use the message create time or log append time as the timestamp on a message.
- Databases
Update Kafka Topic Response Topic State - The state of the Kafka topic.
- Databases
Update Logsink Body Config Subtype0 Format - Message format used by the server, this can be either rfc3164 (the old BSD style message format),
rfc5424(current syslog message format) or custom - Databases
Update Online Migration Response Status - The current status of the migration.
- Databases
Update User Body Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
Update User Body Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
Update User Body Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Databases
Update User Response User Mysql Settings Auth Plugin - A string specifying the authentication method to be used for connections
to the MySQL user account. The valid values are
mysql_native_passwordorcaching_sha2_password. If excluded when creating a new user, the default for the version of MySQL in use will be used. As of MySQL 8.0, the default iscaching_sha2_password. - Databases
Update User Response User Role - A string representing the database user’s role. The value will be either “primary” or “normal”.
- Databases
Update User Response User Settings AclItem Permission - Permission set applied to the ACL. ‘consume’ allows for messages to be consumed from the topic. ‘produce’ allows for messages to be published to the topic. ‘produceconsume’ allows for both ‘consume’ and ‘produce’ permission. ‘admin’ allows for ‘produceconsume’ as well as any operations to administer the topic (delete, update).
- Databases
Update User Response User Settings Mongo User Settings Role - The role to assign to the user with each role mapping to a MongoDB built-in role.
readOnlymaps to a read role.readWritemaps to a readWrite role.dbAdminmaps to a dbAdmin role. - Databases
Update User Response User Settings Opensearch AclItem Permission - Permission set applied to the ACL. ‘read’ allows user to read from the index. ‘write’ allows for user to write to the index. ‘readwrite’ allows for both ‘read’ and ‘write’ permission. ‘deny’(default) restricts user from performing any operation over an index. ‘admin’ allows for ‘readwrite’ as well as any operations to administer the index.
- Dedicated
Inferences Create Body Spec Model Deployments Item Model Provider - Model provider.
- Dedicated
Inferences Create Body Spec Region - DigitalOcean region where the Dedicated Inference is hosted.
- Dedicated
Inferences Create Response Dedicated Inference Pending Deployment Spec Status DedicatedInferencesCreateResponseDedicatedInferencePendingDeploymentSpecStatus- Dedicated
Inferences Create Response Dedicated Inference Spec Model Deployments Item Model Provider - Model provider.
- Dedicated
Inferences Create Response Dedicated Inference Spec Region - DigitalOcean region where the Dedicated Inference is hosted.
- Dedicated
Inferences Create Response Dedicated Inference Status - Current state of the Dedicated Inference.
- Dedicated
Inferences GetResponse Dedicated Inference Pending Deployment Spec Status DedicatedInferencesGetResponseDedicatedInferencePendingDeploymentSpecStatus- Dedicated
Inferences GetResponse Dedicated Inference Spec Model Deployments Item Model Provider - Model provider.
- Dedicated
Inferences GetResponse Dedicated Inference Spec Region - DigitalOcean region where the Dedicated Inference is hosted.
- Dedicated
Inferences GetResponse Dedicated Inference Status - Current state of the Dedicated Inference.
- Dedicated
Inferences List Region DedicatedInferencesListRegion- Dedicated
Inferences List Response Dedicated Inferences Item Pending Deployment Spec Status DedicatedInferencesListResponseDedicatedInferencesItemPendingDeploymentSpecStatus- Dedicated
Inferences List Response Dedicated Inferences Item Spec Model Deployments Item Model Provider - Model provider.
- Dedicated
Inferences List Response Dedicated Inferences Item Spec Region - DigitalOcean region where the Dedicated Inference is hosted.
- Dedicated
Inferences List Response Dedicated Inferences Item Status - Current state of the Dedicated Inference.
- Dedicated
Inferences Patch Body Spec Model Deployments Item Model Provider - Model provider.
- Dedicated
Inferences Patch Body Spec Region - DigitalOcean region where the Dedicated Inference is hosted.
- Dedicated
Inferences Patch Response Dedicated Inference Pending Deployment Spec Status DedicatedInferencesPatchResponseDedicatedInferencePendingDeploymentSpecStatus- Dedicated
Inferences Patch Response Dedicated Inference Spec Model Deployments Item Model Provider - Model provider.
- Dedicated
Inferences Patch Response Dedicated Inference Spec Region - DigitalOcean region where the Dedicated Inference is hosted.
- Dedicated
Inferences Patch Response Dedicated Inference Status - Current state of the Dedicated Inference.
- Domains
List Records Type DomainsListRecordsType- Droplet
Actions GetResponse Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Droplet
Actions List Response Actions Item Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Droplet
Actions Post Body Subtype0 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post Body Subtype1 Backup Policy Plan - The backup plan used for the Droplet. The plan can be either
dailyorweekly. - Droplet
Actions Post Body Subtype1 Backup Policy Weekday - The day of the week on which the backup will occur.
- Droplet
Actions Post Body Subtype1 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post Body Subtype2 Backup Policy Plan - The backup plan used for the Droplet. The plan can be either
dailyorweekly. - Droplet
Actions Post Body Subtype2 Backup Policy Weekday - The day of the week on which the backup will occur.
- Droplet
Actions Post Body Subtype2 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post Body Subtype3 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post Body Subtype4 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post Body Subtype5 Image - The image ID of a public or private image or the slug identifier for a public image. The Droplet will be rebuilt using this image as its base.
- Droplet
Actions Post Body Subtype5 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post Body Subtype6 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post Body Subtype7 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post Body Subtype8 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post ByTag Body DropletActionsPostByTagBody- Droplet
Actions Post ByTag Body Variant0 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post ByTag Body Variant1 Type - The type of action to initiate for the Droplet.
- Droplet
Actions Post ByTag Response Actions Item Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Droplet
Actions Post Response Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Droplets
Create Body DropletsCreateBody- Droplets
Create Response DropletsCreateResponse- Droplets
GetBackup Policy Response Policy Backup Policy Plan - The backup plan used for the Droplet. The plan can be either
dailyorweekly. - Droplets
GetBackup Policy Response Policy Backup Policy Weekday - The day of the week on which the backup will occur.
- Droplets
GetResponse Droplet Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Droplets
GetResponse Droplet Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Droplets
GetResponse Droplet Image Regions Item - The slug identifier for the region where the resource will initially be available.
- Droplets
GetResponse Droplet Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - Droplets
GetResponse Droplet Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - Droplets
GetResponse Droplet Networks V4Item Type - The type of the IPv4 network interface.
- Droplets
GetResponse Droplet Networks V6Item Type - The type of the IPv6 network interface.
- Droplets
GetResponse Droplet Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Droplets
GetResponse Droplet Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- Droplets
List Backup Policies Response Policies Value Backup Policy Plan - The backup plan used for the Droplet. The plan can be either
dailyorweekly. - Droplets
List Backup Policies Response Policies Value Backup Policy Weekday - The day of the week on which the backup will occur.
- Droplets
List Backups Response Backups Item Type - Describes the kind of image. It may be one of
snapshotorbackup. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup. - Droplets
List Firewalls Response Firewalls Item Inbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Droplets
List Firewalls Response Firewalls Item Outbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Droplets
List Firewalls Response Firewalls Item Status - A status string indicating the current state of the firewall. This can be “waiting”, “succeeded”, or “failed”.
- Droplets
List Neighbors Response Droplets Item Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Droplets
List Neighbors Response Droplets Item Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Droplets
List Neighbors Response Droplets Item Image Regions Item - The slug identifier for the region where the resource will initially be available.
- Droplets
List Neighbors Response Droplets Item Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - Droplets
List Neighbors Response Droplets Item Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - Droplets
List Neighbors Response Droplets Item Networks V4Item Type - The type of the IPv4 network interface.
- Droplets
List Neighbors Response Droplets Item Networks V6Item Type - The type of the IPv6 network interface.
- Droplets
List Neighbors Response Droplets Item Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Droplets
List Neighbors Response Droplets Item Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- Droplets
List Response Droplets Item Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Droplets
List Response Droplets Item Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Droplets
List Response Droplets Item Image Regions Item - The slug identifier for the region where the resource will initially be available.
- Droplets
List Response Droplets Item Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - Droplets
List Response Droplets Item Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - Droplets
List Response Droplets Item Networks V4Item Type - The type of the IPv4 network interface.
- Droplets
List Response Droplets Item Networks V6Item Type - The type of the IPv6 network interface.
- Droplets
List Response Droplets Item Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Droplets
List Response Droplets Item Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- Droplets
List Snapshots Response Snapshots Item Type - Describes the kind of image. It may be one of
snapshotorbackup. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup. - Droplets
List Type DropletsListType- Error
- Error produced by generated client methods.
- Features
Item Value - Value of the feature, which can vary based on the type.
- Firewalls
AddRules Body FirewallsAddRulesBody- Firewalls
AddRules Body Variant0 Inbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
AddRules Body Variant1 Outbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
Create Body FirewallsCreateBody- Firewalls
Create Body Variant0 Inbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
Create Body Variant0 Status - A status string indicating the current state of the firewall. This can be “waiting”, “succeeded”, or “failed”.
- Firewalls
Create Body Variant1 Outbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
Create Body Variant1 Status - A status string indicating the current state of the firewall. This can be “waiting”, “succeeded”, or “failed”.
- Firewalls
Create Response Firewall Inbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
Create Response Firewall Outbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
Create Response Firewall Status - A status string indicating the current state of the firewall. This can be “waiting”, “succeeded”, or “failed”.
- Firewalls
Delete Rules Body FirewallsDeleteRulesBody- Firewalls
Delete Rules Body Variant0 Inbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
Delete Rules Body Variant1 Outbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
GetResponse Firewall Inbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
GetResponse Firewall Outbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
GetResponse Firewall Status - A status string indicating the current state of the firewall. This can be “waiting”, “succeeded”, or “failed”.
- Firewalls
List Response Firewalls Item Inbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
List Response Firewalls Item Outbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
List Response Firewalls Item Status - A status string indicating the current state of the firewall. This can be “waiting”, “succeeded”, or “failed”.
- Firewalls
Update Body FirewallsUpdateBody- Firewalls
Update Body Variant0 Inbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
Update Body Variant0 Status - A status string indicating the current state of the firewall. This can be “waiting”, “succeeded”, or “failed”.
- Firewalls
Update Body Variant1 Outbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
Update Body Variant1 Status - A status string indicating the current state of the firewall. This can be “waiting”, “succeeded”, or “failed”.
- Firewalls
Update Response Firewall Inbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
Update Response Firewall Outbound Rules Item Protocol - The type of traffic to be allowed. This may be one of
tcp,udp, oricmp. - Firewalls
Update Response Firewall Status - A status string indicating the current state of the firewall. This can be “waiting”, “succeeded”, or “failed”.
- FloatingI
PsAction GetResponse Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- FloatingI
PsAction List Response Actions Item Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- FloatingI
PsAction Post Body FloatingIPsActionPostBody- FloatingI
PsAction Post Body Variant0 Type - The type of action to initiate for the floating IP.
- FloatingI
PsAction Post Body Variant1 Type - The type of action to initiate for the floating IP.
- FloatingI
PsAction Post Response Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- FloatingI
PsCreate Body FloatingIPsCreateBody- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - FloatingI
PsCreate Response Floating IpDroplet Subtype1 Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - FloatingI
PsCreate Response Floating IpDroplet Subtype1 Image Regions Item - The slug identifier for the region where the resource will initially be available.
- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - FloatingI
PsCreate Response Floating IpDroplet Subtype1 Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - FloatingI
PsCreate Response Floating IpDroplet Subtype1 Networks V4Item Type - The type of the IPv4 network interface.
- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Networks V6Item Type - The type of the IPv6 network interface.
- FloatingI
PsCreate Response Floating IpDroplet Subtype1 Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - FloatingI
PsCreate Response Floating IpDroplet Subtype1 Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- FloatingI
PsGet Response Floating IpDroplet Subtype1 Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - FloatingI
PsGet Response Floating IpDroplet Subtype1 Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - FloatingI
PsGet Response Floating IpDroplet Subtype1 Image Regions Item - The slug identifier for the region where the resource will initially be available.
- FloatingI
PsGet Response Floating IpDroplet Subtype1 Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - FloatingI
PsGet Response Floating IpDroplet Subtype1 Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - FloatingI
PsGet Response Floating IpDroplet Subtype1 Networks V4Item Type - The type of the IPv4 network interface.
- FloatingI
PsGet Response Floating IpDroplet Subtype1 Networks V6Item Type - The type of the IPv6 network interface.
- FloatingI
PsGet Response Floating IpDroplet Subtype1 Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - FloatingI
PsGet Response Floating IpDroplet Subtype1 Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Image Regions Item - The slug identifier for the region where the resource will initially be available.
- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Networks V4Item Type - The type of the IPv4 network interface.
- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Networks V6Item Type - The type of the IPv6 network interface.
- FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - FloatingI
PsList Response Floating IpsItem Droplet Subtype1 Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- Genai
Create Evaluation Dataset Body Dataset Type GenaiCreateEvaluationDatasetBodyDatasetType- Genai
Create Knowledge Base Body Size GenaiCreateKnowledgeBaseBodySize- Genai
Create Knowledge Base Data Source Body Chunking Algorithm GenaiCreateKnowledgeBaseDataSourceBodyChunkingAlgorithm- Genai
Create Model Evaluation RunBody Candidate Model Source - Whether inference runs against the serverless platform, a dedicated deployment, or a model router.
- Genai
Create Model Evaluation RunBody Preset Save Sections Item - Sections of an inline evaluation config that can be persisted as a reusable preset. Each value names a self-contained group of fields; selecting a section saves exactly the fields it owns and leaves the rest of the preset empty so it can be merged with inline values on a future run.
- Genai
Delete Custom Model Response Status - Status of delete operation
- Genai
Delete Model Evaluation RunResponse Status - Status of delete operation
- Genai
GetKnowledge Base Response Database Status GenaiGetKnowledgeBaseResponseDatabaseStatus- Genai
Import Custom Model Body Source Type - Source from which the model was imported
- Genai
List Custom Models Status GenaiListCustomModelsStatus- Genai
List Evaluation Datasets Dataset Type GenaiListEvaluationDatasetsDatasetType- Genai
List Model Evaluation Runs Candidate Types Item GenaiListModelEvaluationRunsCandidateTypesItem- Genai
List Model Evaluation Runs Response Available Candidate Types Item - Whether inference runs against the serverless platform, a dedicated deployment, or a model router.
- Genai
List Model Evaluation Runs Response Available Statuses Item - Model Evaluation Run Statuses
- Genai
List Model Evaluation Runs Sort By GenaiListModelEvaluationRunsSortBy- Genai
List Model Evaluation Runs Sort Direction GenaiListModelEvaluationRunsSortDirection- Genai
List Model Evaluation Runs Status GenaiListModelEvaluationRunsStatus- Genai
List Model Evaluation Runs Statuses Item GenaiListModelEvaluationRunsStatusesItem- Genai
List Models Usecases Item GenaiListModelsUsecasesItem- Genai
Update Agent Body Retrieval Method - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknownRETRIEVAL_METHOD_REWRITE: The retrieval method is rewriteRETRIEVAL_METHOD_STEP_BACK: The retrieval method is step backRETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queriesRETRIEVAL_METHOD_NONE: The retrieval method is none
- Genai
Update Agent Deployment Visibility Body Visibility - VISIBILITY_UNKNOWN: The status of the deployment is unknownVISIBILITY_DISABLED: The deployment is disabled and will no longer service requestsVISIBILITY_PLAYGROUND: Deprecated: No longer a valid stateVISIBILITY_PUBLIC: The deployment is public and will service requests from the public internetVISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys
- Genai
Update Knowledge Base Data Source Body Chunking Algorithm GenaiUpdateKnowledgeBaseDataSourceBodyChunkingAlgorithm- Image
Actions GetResponse Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Image
Actions List Response Actions Item Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Image
Actions Post Body ImageActionsPostBody- Image
Actions Post Body Variant0 Type - The action to be taken on the image. Can be either
convertortransfer. - Image
Actions Post Body Variant1 Region - The slug identifier for the region where the resource will initially be available.
- Image
Actions Post Body Variant1 Type - The action to be taken on the image. Can be either
convertortransfer. - Image
Actions Post Response Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Images
Create Custom Body Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Images
Create Custom Body Region - The slug identifier for the region where the resource will initially be available.
- Images
Create Custom Response Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Images
Create Custom Response Image Regions Item - The slug identifier for the region where the resource will initially be available.
- Images
Create Custom Response Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - Images
Create Custom Response Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - Images
GetImage Id ImagesGetImageId- Images
GetResponse Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Images
GetResponse Image Regions Item - The slug identifier for the region where the resource will initially be available.
- Images
GetResponse Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - Images
GetResponse Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - Images
List Response Images Item Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Images
List Response Images Item Regions Item - The slug identifier for the region where the resource will initially be available.
- Images
List Response Images Item Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - Images
List Response Images Item Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - Images
List Type ImagesListType- Images
Post Account Transfer Create Body ImagesPostAccountTransferCreateBody- Images
Update Body Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Images
Update Response Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Images
Update Response Image Regions Item - The slug identifier for the region where the resource will initially be available.
- Images
Update Response Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - Images
Update Response Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - Inference
Cancel Batch Response Completion Window InferenceCancelBatchResponseCompletionWindow- Inference
Cancel Batch Response Provider InferenceCancelBatchResponseProvider- Inference
Cancel Batch Response Status - Lifecycle status. Terminal states:
completed,failed,expired,cancelled. - Inference
Create Async Invoke Response Status - The current status of the async invocation.
- Inference
Create Batch Body Completion Window - Time window in which the job must complete. Jobs that do not finish in time transition to
expired. - Inference
Create Batch Body Endpoint - Inference endpoint each request is dispatched to. Required when
providerisopenaiand must match theurlon every JSONL line. Must be omitted whenproviderisanthropic. - Inference
Create Batch Body Provider - The inference provider whose JSONL schema the input file conforms to.
openaifollows the OpenAI Batch API input schema (custom_id,method,url,body);anthropicfollows the Anthropic Message Batches JSONL conventions. - Inference
Create Batch Response Completion Window InferenceCreateBatchResponseCompletionWindow- Inference
Create Batch Response Provider InferenceCreateBatchResponseProvider- Inference
Create Batch Response Status - Lifecycle status. Terminal states:
completed,failed,expired,cancelled. - Inference
Create Chat Completion Body Messages Item Role - The role of the message author.
- Inference
Create Chat Completion Body Messages Item Tool Calls Item Type - The type of the tool. Currently, only function is supported.
- Inference
Create Chat Completion Body Reasoning Effort - Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
- Inference
Create Chat Completion Body Stop - Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
- Inference
Create Chat Completion Body Tool Choice - Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {“type”: “function”, “function”: {“name”: “my_function”}} forces the model to call that tool. none is the default when no tools are present. auto is the default if tools are present.
- Inference
Create Chat Completion Body Tool Choice Variant0 InferenceCreateChatCompletionBodyToolChoiceVariant0- Inference
Create Chat Completion Body Tool Choice Variant1 Type InferenceCreateChatCompletionBodyToolChoiceVariant1Type- Inference
Create Chat Completion Body Tools Item Type - The type of the tool. Currently, only function is supported.
- Inference
Create Chat Completion Response Choices Item Finish Reason - The reason the model stopped generating tokens. 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, tool_calls if the model called a tool.
- Inference
Create Chat Completion Response Choices Item Message Role - The role of the author of this message.
- Inference
Create Chat Completion Response Choices Item Message Tool Calls Item Type - The type of the tool.
- Inference
Create Chat Completion Response Object - The object type, which is always chat.completion.
- Inference
Create Embedding Body Encoding Format - How embedding values are returned in each
data[].embeddingfield. - Inference
Create Embedding Body Input - A single string or 1–2048 strings; each string produces one row in
data, in order. - Inference
Create Embedding Response Data Item Embedding - The embedding vector, or a base64-encoded string when the request set encoding_format to base64.
- Inference
Create Embedding Response Data Item Object - The object type, which is always
embedding. - Inference
Create Embedding Response Object - The object type, which is always the string
list. - Inference
Create Image Body Size - The size of the generated images. GPT-IMAGE-1 supports: auto (automatically select best size), 1536x1024 (landscape), 1024x1536 (portrait).
- Inference
Create Messages Body Messages Item Content - Message body as plain text or structured blocks.
- Inference
Create Messages Body Messages Item Content Variant1 Item - Structured message content. Block
typeis one oftext,image,tool_use, ortool_result. Some tool definitions may be rejected by server policy even when valid here. - Inference
Create Messages Body Messages Item Content Variant1 Item Content - Tool output as plain text or structured objects.
- Inference
Create Messages Body Messages Item Role - Speaker role for this message.
- Inference
Create Messages Body Reasoning Effort - DigitalOcean extension for reasoning-capable models. Ignored by executors that do not support it.
- Inference
Create Messages Body Speed - DigitalOcean extension for preferred inference speed. Ignored when not supported.
- Inference
Create Messages Body System - System prompt as plain text or as an array of text blocks.
- Inference
Create Messages Body System Variant1 Item Type - Block type identifier.
- Inference
Create Messages Body Tool Choice - Controls how the model uses tools: automatic selection, require any tool, force a specific tool, or a string form accepted by the service.
- Inference
Create Messages Body Tool Choice Variant1 Type - Tool selection mode.
- Inference
Create Messages Response Content Item - Assistant output block (text and tool calls).
- Inference
Create Messages Response Role - Always
assistantfor this response. - Inference
Create Messages Response Stop Reason - Why generation stopped.
- Inference
Create Messages Response Type - Object type discriminator.
- Inference
Create Messages Response Usage Speed - Inference speed tier reflected in billing or routing.
- Inference
Create Response Body Input - The prompt or input content you want the model to respond to. Can be a simple text string or an array of message objects for conversation context.
- Inference
Create Response Body Input Variant1 Item Role - The role of the message author.
- Inference
Create Response Body Stop InferenceCreateResponseBodyStop- Inference
Create Response Body Tool Choice - Controls which (if any) tool is called by the model.
- Inference
Create Response Body Tool Choice Variant0 InferenceCreateResponseBodyToolChoiceVariant0- Inference
Create Response Body Tool Choice Variant1 Type InferenceCreateResponseBodyToolChoiceVariant1Type- Inference
Create Response Body Tools Item Type - The type of the tool.
- Inference
Create Response Response Object - The object type, which is always
response. - Inference
Create Response Response Output Item Content Item Type - The type of content part.
reasoning_textfor reasoning content,output_textfor final output text. - Inference
Create Response Response Output Item Type - The type of output item. One of
reasoning,message, orfunction_call. - Inference
Create Response Response Tools Item Type - The type of the tool.
- Inference
GetBatch Response Completion Window InferenceGetBatchResponseCompletionWindow- Inference
GetBatch Response Provider InferenceGetBatchResponseProvider- Inference
GetBatch Response Status - Lifecycle status. Terminal states:
completed,failed,expired,cancelled. - Inference
List Batches Status InferenceListBatchesStatus- Inference
List Models Response Data Item Object - The object type, which is always “model”.
- Inference
List Models Response Object - The object type, which is always “list”.
- Kubernetes
AddNode Pool Body Taints Item Effect - The taint effect
- Kubernetes
AddNode Pool Response Node Pool Taints Item Effect - The taint effect
- Kubernetes
Create Cluster Body Cluster Autoscaler Configuration Expanders Item KubernetesCreateClusterBodyClusterAutoscalerConfigurationExpandersItem- Kubernetes
Create Cluster Body Maintenance Policy Day - The day of the maintenance window policy. May be one of
mondaythroughsunday, oranyto indicate an arbitrary week day. - Kubernetes
Create Cluster Body Node Pools Item Taints Item Effect - The taint effect
- Kubernetes
Create Cluster Body Status State - A string indicating the current status of the cluster.
- Kubernetes
Create Cluster Response Kubernetes Cluster Cluster Autoscaler Configuration Expanders Item KubernetesCreateClusterResponseKubernetesClusterClusterAutoscalerConfigurationExpandersItem- Kubernetes
Create Cluster Response Kubernetes Cluster Maintenance Policy Day - The day of the maintenance window policy. May be one of
mondaythroughsunday, oranyto indicate an arbitrary week day. - Kubernetes
Create Cluster Response Kubernetes Cluster Node Pools Item Taints Item Effect - The taint effect
- Kubernetes
Create Cluster Response Kubernetes Cluster Status State - A string indicating the current status of the cluster.
- Kubernetes
GetCluster Response Kubernetes Cluster Cluster Autoscaler Configuration Expanders Item KubernetesGetClusterResponseKubernetesClusterClusterAutoscalerConfigurationExpandersItem- Kubernetes
GetCluster Response Kubernetes Cluster Maintenance Policy Day - The day of the maintenance window policy. May be one of
mondaythroughsunday, oranyto indicate an arbitrary week day. - Kubernetes
GetCluster Response Kubernetes Cluster Node Pools Item Taints Item Effect - The taint effect
- Kubernetes
GetCluster Response Kubernetes Cluster Status State - A string indicating the current status of the cluster.
- Kubernetes
GetKubeconfig Type KubernetesGetKubeconfigType- Kubernetes
GetNode Pool Response Node Pool Taints Item Effect - The taint effect
- Kubernetes
List Clusters Response Kubernetes Clusters Item Cluster Autoscaler Configuration Expanders Item KubernetesListClustersResponseKubernetesClustersItemClusterAutoscalerConfigurationExpandersItem- Kubernetes
List Clusters Response Kubernetes Clusters Item Maintenance Policy Day - The day of the maintenance window policy. May be one of
mondaythroughsunday, oranyto indicate an arbitrary week day. - Kubernetes
List Clusters Response Kubernetes Clusters Item Node Pools Item Taints Item Effect - The taint effect
- Kubernetes
List Clusters Response Kubernetes Clusters Item Status State - A string indicating the current status of the cluster.
- Kubernetes
List Node Pools Response Node Pools Item Taints Item Effect - The taint effect
- Kubernetes
Update Cluster Body Cluster Autoscaler Configuration Expanders Item KubernetesUpdateClusterBodyClusterAutoscalerConfigurationExpandersItem- Kubernetes
Update Cluster Body Maintenance Policy Day - The day of the maintenance window policy. May be one of
mondaythroughsunday, oranyto indicate an arbitrary week day. - Kubernetes
Update Cluster Response Kubernetes Cluster Cluster Autoscaler Configuration Expanders Item KubernetesUpdateClusterResponseKubernetesClusterClusterAutoscalerConfigurationExpandersItem- Kubernetes
Update Cluster Response Kubernetes Cluster Maintenance Policy Day - The day of the maintenance window policy. May be one of
mondaythroughsunday, oranyto indicate an arbitrary week day. - Kubernetes
Update Cluster Response Kubernetes Cluster Node Pools Item Taints Item Effect - The taint effect
- Kubernetes
Update Cluster Response Kubernetes Cluster Status State - A string indicating the current status of the cluster.
- Kubernetes
Update Node Pool Body Taints Item Effect - The taint effect
- Kubernetes
Update Node Pool Response Node Pool Taints Item Effect - The taint effect
- Lets
Encrypt Certificate Request Type - A string representing the type of the certificate. The value will be
customfor a user-uploaded certificate orlets_encryptfor one automatically generated with Let’s Encrypt. - Load
Balancers AddForwarding Rules Body Forwarding Rules Item Entry Protocol - The protocol used for traffic to the load balancer. The possible values are:
http,https,http2,http3,tcp, orudp. If you set theentry_protocoltoudp, thetarget_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers AddForwarding Rules Body Forwarding Rules Item Target Protocol - The protocol used for traffic from the load balancer to the backend Droplets. The possible values are:
http,https,http2,tcp, orudp. If you set thetarget_protocoltoudp, theentry_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers Create Body LoadBalancersCreateBody- Load
Balancers Create Response Load Balancer Algorithm - This field has been deprecated. You can no longer specify an algorithm for load balancers.
- Load
Balancers Create Response Load Balancer Forwarding Rules Item Entry Protocol - The protocol used for traffic to the load balancer. The possible values are:
http,https,http2,http3,tcp, orudp. If you set theentry_protocoltoudp, thetarget_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers Create Response Load Balancer Forwarding Rules Item Target Protocol - The protocol used for traffic from the load balancer to the backend Droplets. The possible values are:
http,https,http2,tcp, orudp. If you set thetarget_protocoltoudp, theentry_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers Create Response Load Balancer GlbSettings Target Protocol - The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are
http,httpsandhttp2. - Load
Balancers Create Response Load Balancer Health Check Protocol - The protocol used for health checks sent to the backend Droplets. The possible values are
http,https, ortcp. - Load
Balancers Create Response Load Balancer Network - A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer.
- Load
Balancers Create Response Load Balancer Network Stack - A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer.
- Load
Balancers Create Response Load Balancer Size - This field has been replaced by the
size_unitfield for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes. - Load
Balancers Create Response Load Balancer Status - A status string indicating the current state of the load balancer. This can be
new,active, orerrored. - Load
Balancers Create Response Load Balancer Sticky Sessions Type - An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookiesornone. - Load
Balancers Create Response Load Balancer TlsCipher Policy - A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are
DEFAULTorSTRONG. The default value isDEFAULT. - Load
Balancers Create Response Load Balancer Type - A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer.
- Load
Balancers GetResponse Load Balancer Algorithm - This field has been deprecated. You can no longer specify an algorithm for load balancers.
- Load
Balancers GetResponse Load Balancer Forwarding Rules Item Entry Protocol - The protocol used for traffic to the load balancer. The possible values are:
http,https,http2,http3,tcp, orudp. If you set theentry_protocoltoudp, thetarget_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers GetResponse Load Balancer Forwarding Rules Item Target Protocol - The protocol used for traffic from the load balancer to the backend Droplets. The possible values are:
http,https,http2,tcp, orudp. If you set thetarget_protocoltoudp, theentry_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers GetResponse Load Balancer GlbSettings Target Protocol - The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are
http,httpsandhttp2. - Load
Balancers GetResponse Load Balancer Health Check Protocol - The protocol used for health checks sent to the backend Droplets. The possible values are
http,https, ortcp. - Load
Balancers GetResponse Load Balancer Network - A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer.
- Load
Balancers GetResponse Load Balancer Network Stack - A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer.
- Load
Balancers GetResponse Load Balancer Size - This field has been replaced by the
size_unitfield for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes. - Load
Balancers GetResponse Load Balancer Status - A status string indicating the current state of the load balancer. This can be
new,active, orerrored. - Load
Balancers GetResponse Load Balancer Sticky Sessions Type - An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookiesornone. - Load
Balancers GetResponse Load Balancer TlsCipher Policy - A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are
DEFAULTorSTRONG. The default value isDEFAULT. - Load
Balancers GetResponse Load Balancer Type - A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer.
- Load
Balancers List Response Load Balancers Item Algorithm - This field has been deprecated. You can no longer specify an algorithm for load balancers.
- Load
Balancers List Response Load Balancers Item Forwarding Rules Item Entry Protocol - The protocol used for traffic to the load balancer. The possible values are:
http,https,http2,http3,tcp, orudp. If you set theentry_protocoltoudp, thetarget_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers List Response Load Balancers Item Forwarding Rules Item Target Protocol - The protocol used for traffic from the load balancer to the backend Droplets. The possible values are:
http,https,http2,tcp, orudp. If you set thetarget_protocoltoudp, theentry_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers List Response Load Balancers Item GlbSettings Target Protocol - The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are
http,httpsandhttp2. - Load
Balancers List Response Load Balancers Item Health Check Protocol - The protocol used for health checks sent to the backend Droplets. The possible values are
http,https, ortcp. - Load
Balancers List Response Load Balancers Item Network - A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer.
- Load
Balancers List Response Load Balancers Item Network Stack - A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer.
- Load
Balancers List Response Load Balancers Item Size - This field has been replaced by the
size_unitfield for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes. - Load
Balancers List Response Load Balancers Item Status - A status string indicating the current state of the load balancer. This can be
new,active, orerrored. - Load
Balancers List Response Load Balancers Item Sticky Sessions Type - An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookiesornone. - Load
Balancers List Response Load Balancers Item TlsCipher Policy - A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are
DEFAULTorSTRONG. The default value isDEFAULT. - Load
Balancers List Response Load Balancers Item Type - A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer.
- Load
Balancers Remove Forwarding Rules Body Forwarding Rules Item Entry Protocol - The protocol used for traffic to the load balancer. The possible values are:
http,https,http2,http3,tcp, orudp. If you set theentry_protocoltoudp, thetarget_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers Remove Forwarding Rules Body Forwarding Rules Item Target Protocol - The protocol used for traffic from the load balancer to the backend Droplets. The possible values are:
http,https,http2,tcp, orudp. If you set thetarget_protocoltoudp, theentry_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers Update Body LoadBalancersUpdateBody- Load
Balancers Update Response Load Balancer Algorithm - This field has been deprecated. You can no longer specify an algorithm for load balancers.
- Load
Balancers Update Response Load Balancer Forwarding Rules Item Entry Protocol - The protocol used for traffic to the load balancer. The possible values are:
http,https,http2,http3,tcp, orudp. If you set theentry_protocoltoudp, thetarget_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers Update Response Load Balancer Forwarding Rules Item Target Protocol - The protocol used for traffic from the load balancer to the backend Droplets. The possible values are:
http,https,http2,tcp, orudp. If you set thetarget_protocoltoudp, theentry_protocolmust be set toudp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly. - Load
Balancers Update Response Load Balancer GlbSettings Target Protocol - The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are
http,httpsandhttp2. - Load
Balancers Update Response Load Balancer Health Check Protocol - The protocol used for health checks sent to the backend Droplets. The possible values are
http,https, ortcp. - Load
Balancers Update Response Load Balancer Network - A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer.
- Load
Balancers Update Response Load Balancer Network Stack - A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer.
- Load
Balancers Update Response Load Balancer Size - This field has been replaced by the
size_unitfield for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes. - Load
Balancers Update Response Load Balancer Status - A status string indicating the current state of the load balancer. This can be
new,active, orerrored. - Load
Balancers Update Response Load Balancer Sticky Sessions Type - An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are
cookiesornone. - Load
Balancers Update Response Load Balancer TlsCipher Policy - A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are
DEFAULTorSTRONG. The default value isDEFAULT. - Load
Balancers Update Response Load Balancer Type - A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer.
- Metadata
Item Value - The value to be set for the metadata item, which can be a string or boolean.
- Monitoring
Create Alert Policy Body Compare MonitoringCreateAlertPolicyBodyCompare- Monitoring
Create Alert Policy Body Type MonitoringCreateAlertPolicyBodyType- Monitoring
Create Alert Policy Body Window MonitoringCreateAlertPolicyBodyWindow- Monitoring
Create Alert Policy Response Policy Compare MonitoringCreateAlertPolicyResponsePolicyCompare- Monitoring
Create Alert Policy Response Policy Type MonitoringCreateAlertPolicyResponsePolicyType- Monitoring
Create Alert Policy Response Policy Window MonitoringCreateAlertPolicyResponsePolicyWindow- Monitoring
Create Destination Body Type - The destination type.
opensearch_dbaasfor a DigitalOcean managed OpenSearch cluster oropensearch_extfor an externally managed one. - Monitoring
Create Destination Response Destination Type - The destination type.
opensearch_dbaasfor a DigitalOcean managed OpenSearch cluster oropensearch_extfor an externally managed one. - Monitoring
GetAlert Policy Response Policy Compare MonitoringGetAlertPolicyResponsePolicyCompare- Monitoring
GetAlert Policy Response Policy Type MonitoringGetAlertPolicyResponsePolicyType- Monitoring
GetAlert Policy Response Policy Window MonitoringGetAlertPolicyResponsePolicyWindow- Monitoring
GetApp CpuPercentage Metrics Response Data Result Item Values Item Item MonitoringGetAppCpuPercentageMetricsResponseDataResultItemValuesItemItem- Monitoring
GetApp CpuPercentage Metrics Response Data Result Type MonitoringGetAppCpuPercentageMetricsResponseDataResultType- Monitoring
GetApp CpuPercentage Metrics Response Status MonitoringGetAppCpuPercentageMetricsResponseStatus- Monitoring
GetApp Memory Percentage Metrics Response Data Result Item Values Item Item MonitoringGetAppMemoryPercentageMetricsResponseDataResultItemValuesItemItem- Monitoring
GetApp Memory Percentage Metrics Response Data Result Type MonitoringGetAppMemoryPercentageMetricsResponseDataResultType- Monitoring
GetApp Memory Percentage Metrics Response Status MonitoringGetAppMemoryPercentageMetricsResponseStatus- Monitoring
GetApp Restart Count Metrics YmlResponse Data Result Item Values Item Item MonitoringGetAppRestartCountMetricsYmlResponseDataResultItemValuesItemItem- Monitoring
GetApp Restart Count Metrics YmlResponse Data Result Type MonitoringGetAppRestartCountMetricsYmlResponseDataResultType- Monitoring
GetApp Restart Count Metrics YmlResponse Status MonitoringGetAppRestartCountMetricsYmlResponseStatus- Monitoring
GetDatabase Mysql CpuUsage Aggregate MonitoringGetDatabaseMysqlCpuUsageAggregate- Monitoring
GetDatabase Mysql CpuUsage Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlCpuUsageResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql CpuUsage Response Data Result Type MonitoringGetDatabaseMysqlCpuUsageResponseDataResultType- Monitoring
GetDatabase Mysql CpuUsage Response Status MonitoringGetDatabaseMysqlCpuUsageResponseStatus- Monitoring
GetDatabase Mysql Disk Usage Aggregate MonitoringGetDatabaseMysqlDiskUsageAggregate- Monitoring
GetDatabase Mysql Disk Usage Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlDiskUsageResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql Disk Usage Response Data Result Type MonitoringGetDatabaseMysqlDiskUsageResponseDataResultType- Monitoring
GetDatabase Mysql Disk Usage Response Status MonitoringGetDatabaseMysqlDiskUsageResponseStatus- Monitoring
GetDatabase Mysql Index VsSequential Reads Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlIndexVsSequentialReadsResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql Index VsSequential Reads Response Data Result Type MonitoringGetDatabaseMysqlIndexVsSequentialReadsResponseDataResultType- Monitoring
GetDatabase Mysql Index VsSequential Reads Response Status MonitoringGetDatabaseMysqlIndexVsSequentialReadsResponseStatus- Monitoring
GetDatabase Mysql Load Aggregate MonitoringGetDatabaseMysqlLoadAggregate- Monitoring
GetDatabase Mysql Load Metric MonitoringGetDatabaseMysqlLoadMetric- Monitoring
GetDatabase Mysql Load Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlLoadResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql Load Response Data Result Type MonitoringGetDatabaseMysqlLoadResponseDataResultType- Monitoring
GetDatabase Mysql Load Response Status MonitoringGetDatabaseMysqlLoadResponseStatus- Monitoring
GetDatabase Mysql Memory Usage Aggregate MonitoringGetDatabaseMysqlMemoryUsageAggregate- Monitoring
GetDatabase Mysql Memory Usage Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlMemoryUsageResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql Memory Usage Response Data Result Type MonitoringGetDatabaseMysqlMemoryUsageResponseDataResultType- Monitoring
GetDatabase Mysql Memory Usage Response Status MonitoringGetDatabaseMysqlMemoryUsageResponseStatus- Monitoring
GetDatabase Mysql OpRates Metric MonitoringGetDatabaseMysqlOpRatesMetric- Monitoring
GetDatabase Mysql OpRates Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlOpRatesResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql OpRates Response Data Result Type MonitoringGetDatabaseMysqlOpRatesResponseDataResultType- Monitoring
GetDatabase Mysql OpRates Response Status MonitoringGetDatabaseMysqlOpRatesResponseStatus- Monitoring
GetDatabase Mysql Schema Latency Metric MonitoringGetDatabaseMysqlSchemaLatencyMetric- Monitoring
GetDatabase Mysql Schema Latency Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlSchemaLatencyResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql Schema Latency Response Data Result Type MonitoringGetDatabaseMysqlSchemaLatencyResponseDataResultType- Monitoring
GetDatabase Mysql Schema Latency Response Status MonitoringGetDatabaseMysqlSchemaLatencyResponseStatus- Monitoring
GetDatabase Mysql Schema Throughput Metric MonitoringGetDatabaseMysqlSchemaThroughputMetric- Monitoring
GetDatabase Mysql Schema Throughput Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlSchemaThroughputResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql Schema Throughput Response Data Result Type MonitoringGetDatabaseMysqlSchemaThroughputResponseDataResultType- Monitoring
GetDatabase Mysql Schema Throughput Response Status MonitoringGetDatabaseMysqlSchemaThroughputResponseStatus- Monitoring
GetDatabase Mysql Threads Active Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlThreadsActiveResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql Threads Active Response Data Result Type MonitoringGetDatabaseMysqlThreadsActiveResponseDataResultType- Monitoring
GetDatabase Mysql Threads Active Response Status MonitoringGetDatabaseMysqlThreadsActiveResponseStatus- Monitoring
GetDatabase Mysql Threads Connected Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlThreadsConnectedResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql Threads Connected Response Data Result Type MonitoringGetDatabaseMysqlThreadsConnectedResponseDataResultType- Monitoring
GetDatabase Mysql Threads Connected Response Status MonitoringGetDatabaseMysqlThreadsConnectedResponseStatus- Monitoring
GetDatabase Mysql Threads Created Rate Response Data Result Item Values Item Item MonitoringGetDatabaseMysqlThreadsCreatedRateResponseDataResultItemValuesItemItem- Monitoring
GetDatabase Mysql Threads Created Rate Response Data Result Type MonitoringGetDatabaseMysqlThreadsCreatedRateResponseDataResultType- Monitoring
GetDatabase Mysql Threads Created Rate Response Status MonitoringGetDatabaseMysqlThreadsCreatedRateResponseStatus- Monitoring
GetDestination Response Destination Type - The destination type.
opensearch_dbaasfor a DigitalOcean managed OpenSearch cluster oropensearch_extfor an externally managed one. - Monitoring
GetDroplet Autoscale Current CpuUtilization YmlResponse Data Result Item Values Item Item MonitoringGetDropletAutoscaleCurrentCpuUtilizationYmlResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Autoscale Current CpuUtilization YmlResponse Data Result Type MonitoringGetDropletAutoscaleCurrentCpuUtilizationYmlResponseDataResultType- Monitoring
GetDroplet Autoscale Current CpuUtilization YmlResponse Status MonitoringGetDropletAutoscaleCurrentCpuUtilizationYmlResponseStatus- Monitoring
GetDroplet Autoscale Current Instances Response Data Result Item Values Item Item MonitoringGetDropletAutoscaleCurrentInstancesResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Autoscale Current Instances Response Data Result Type MonitoringGetDropletAutoscaleCurrentInstancesResponseDataResultType- Monitoring
GetDroplet Autoscale Current Instances Response Status MonitoringGetDropletAutoscaleCurrentInstancesResponseStatus- Monitoring
GetDroplet Autoscale Current Memory Utilization Response Data Result Item Values Item Item MonitoringGetDropletAutoscaleCurrentMemoryUtilizationResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Autoscale Current Memory Utilization Response Data Result Type MonitoringGetDropletAutoscaleCurrentMemoryUtilizationResponseDataResultType- Monitoring
GetDroplet Autoscale Current Memory Utilization Response Status MonitoringGetDropletAutoscaleCurrentMemoryUtilizationResponseStatus- Monitoring
GetDroplet Autoscale Target CpuUtilization Response Data Result Item Values Item Item MonitoringGetDropletAutoscaleTargetCpuUtilizationResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Autoscale Target CpuUtilization Response Data Result Type MonitoringGetDropletAutoscaleTargetCpuUtilizationResponseDataResultType- Monitoring
GetDroplet Autoscale Target CpuUtilization Response Status MonitoringGetDropletAutoscaleTargetCpuUtilizationResponseStatus- Monitoring
GetDroplet Autoscale Target Instances Response Data Result Item Values Item Item MonitoringGetDropletAutoscaleTargetInstancesResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Autoscale Target Instances Response Data Result Type MonitoringGetDropletAutoscaleTargetInstancesResponseDataResultType- Monitoring
GetDroplet Autoscale Target Instances Response Status MonitoringGetDropletAutoscaleTargetInstancesResponseStatus- Monitoring
GetDroplet Autoscale Target Memory Utilization Response Data Result Item Values Item Item MonitoringGetDropletAutoscaleTargetMemoryUtilizationResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Autoscale Target Memory Utilization Response Data Result Type MonitoringGetDropletAutoscaleTargetMemoryUtilizationResponseDataResultType- Monitoring
GetDroplet Autoscale Target Memory Utilization Response Status MonitoringGetDropletAutoscaleTargetMemoryUtilizationResponseStatus- Monitoring
GetDroplet Bandwidth Metrics Direction MonitoringGetDropletBandwidthMetricsDirection- Monitoring
GetDroplet Bandwidth Metrics Interface MonitoringGetDropletBandwidthMetricsInterface- Monitoring
GetDroplet Bandwidth Metrics Response Data Result Item Values Item Item MonitoringGetDropletBandwidthMetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Bandwidth Metrics Response Data Result Type MonitoringGetDropletBandwidthMetricsResponseDataResultType- Monitoring
GetDroplet Bandwidth Metrics Response Status MonitoringGetDropletBandwidthMetricsResponseStatus- Monitoring
GetDroplet CpuMetrics Response Data Result Item Values Item Item MonitoringGetDropletCpuMetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet CpuMetrics Response Data Result Type MonitoringGetDropletCpuMetricsResponseDataResultType- Monitoring
GetDroplet CpuMetrics Response Status MonitoringGetDropletCpuMetricsResponseStatus- Monitoring
GetDroplet Filesystem Free Metrics Response Data Result Item Values Item Item MonitoringGetDropletFilesystemFreeMetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Filesystem Free Metrics Response Data Result Type MonitoringGetDropletFilesystemFreeMetricsResponseDataResultType- Monitoring
GetDroplet Filesystem Free Metrics Response Status MonitoringGetDropletFilesystemFreeMetricsResponseStatus- Monitoring
GetDroplet Filesystem Size Metrics Response Data Result Item Values Item Item MonitoringGetDropletFilesystemSizeMetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Filesystem Size Metrics Response Data Result Type MonitoringGetDropletFilesystemSizeMetricsResponseDataResultType- Monitoring
GetDroplet Filesystem Size Metrics Response Status MonitoringGetDropletFilesystemSizeMetricsResponseStatus- Monitoring
GetDroplet Load1 Metrics Response Data Result Item Values Item Item MonitoringGetDropletLoad1MetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Load1 Metrics Response Data Result Type MonitoringGetDropletLoad1MetricsResponseDataResultType- Monitoring
GetDroplet Load1 Metrics Response Status MonitoringGetDropletLoad1MetricsResponseStatus- Monitoring
GetDroplet Load5 Metrics Response Data Result Item Values Item Item MonitoringGetDropletLoad5MetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Load5 Metrics Response Data Result Type MonitoringGetDropletLoad5MetricsResponseDataResultType- Monitoring
GetDroplet Load5 Metrics Response Status MonitoringGetDropletLoad5MetricsResponseStatus- Monitoring
GetDroplet Load15 Metrics Response Data Result Item Values Item Item MonitoringGetDropletLoad15MetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Load15 Metrics Response Data Result Type MonitoringGetDropletLoad15MetricsResponseDataResultType- Monitoring
GetDroplet Load15 Metrics Response Status MonitoringGetDropletLoad15MetricsResponseStatus- Monitoring
GetDroplet Memory Available Metrics Response Data Result Item Values Item Item MonitoringGetDropletMemoryAvailableMetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Memory Available Metrics Response Data Result Type MonitoringGetDropletMemoryAvailableMetricsResponseDataResultType- Monitoring
GetDroplet Memory Available Metrics Response Status MonitoringGetDropletMemoryAvailableMetricsResponseStatus- Monitoring
GetDroplet Memory Cached Metrics Response Data Result Item Values Item Item MonitoringGetDropletMemoryCachedMetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Memory Cached Metrics Response Data Result Type MonitoringGetDropletMemoryCachedMetricsResponseDataResultType- Monitoring
GetDroplet Memory Cached Metrics Response Status MonitoringGetDropletMemoryCachedMetricsResponseStatus- Monitoring
GetDroplet Memory Free Metrics Response Data Result Item Values Item Item MonitoringGetDropletMemoryFreeMetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Memory Free Metrics Response Data Result Type MonitoringGetDropletMemoryFreeMetricsResponseDataResultType- Monitoring
GetDroplet Memory Free Metrics Response Status MonitoringGetDropletMemoryFreeMetricsResponseStatus- Monitoring
GetDroplet Memory Total Metrics Response Data Result Item Values Item Item MonitoringGetDropletMemoryTotalMetricsResponseDataResultItemValuesItemItem- Monitoring
GetDroplet Memory Total Metrics Response Data Result Type MonitoringGetDropletMemoryTotalMetricsResponseDataResultType- Monitoring
GetDroplet Memory Total Metrics Response Status MonitoringGetDropletMemoryTotalMetricsResponseStatus- Monitoring
GetLb Droplets Connections Response Data Result Item Values Item Item MonitoringGetLbDropletsConnectionsResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Connections Response Data Result Type MonitoringGetLbDropletsConnectionsResponseDataResultType- Monitoring
GetLb Droplets Connections Response Status MonitoringGetLbDropletsConnectionsResponseStatus- Monitoring
GetLb Droplets Downtime Response Data Result Item Values Item Item MonitoringGetLbDropletsDowntimeResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Downtime Response Data Result Type MonitoringGetLbDropletsDowntimeResponseDataResultType- Monitoring
GetLb Droplets Downtime Response Status MonitoringGetLbDropletsDowntimeResponseStatus- Monitoring
GetLb Droplets Health Checks Response Data Result Item Values Item Item MonitoringGetLbDropletsHealthChecksResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Health Checks Response Data Result Type MonitoringGetLbDropletsHealthChecksResponseDataResultType- Monitoring
GetLb Droplets Health Checks Response Status MonitoringGetLbDropletsHealthChecksResponseStatus- Monitoring
GetLb Droplets Http Response Time50p Response Data Result Item Values Item Item MonitoringGetLbDropletsHttpResponseTime50pResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Http Response Time50p Response Data Result Type MonitoringGetLbDropletsHttpResponseTime50pResponseDataResultType- Monitoring
GetLb Droplets Http Response Time50p Response Status MonitoringGetLbDropletsHttpResponseTime50pResponseStatus- Monitoring
GetLb Droplets Http Response Time95p Response Data Result Item Values Item Item MonitoringGetLbDropletsHttpResponseTime95pResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Http Response Time95p Response Data Result Type MonitoringGetLbDropletsHttpResponseTime95pResponseDataResultType- Monitoring
GetLb Droplets Http Response Time95p Response Status MonitoringGetLbDropletsHttpResponseTime95pResponseStatus- Monitoring
GetLb Droplets Http Response Time99p Response Data Result Item Values Item Item MonitoringGetLbDropletsHttpResponseTime99pResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Http Response Time99p Response Data Result Type MonitoringGetLbDropletsHttpResponseTime99pResponseDataResultType- Monitoring
GetLb Droplets Http Response Time99p Response Status MonitoringGetLbDropletsHttpResponseTime99pResponseStatus- Monitoring
GetLb Droplets Http Response Time AvgResponse Data Result Item Values Item Item MonitoringGetLbDropletsHttpResponseTimeAvgResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Http Response Time AvgResponse Data Result Type MonitoringGetLbDropletsHttpResponseTimeAvgResponseDataResultType- Monitoring
GetLb Droplets Http Response Time AvgResponse Status MonitoringGetLbDropletsHttpResponseTimeAvgResponseStatus- Monitoring
GetLb Droplets Http Responses Response Data Result Item Values Item Item MonitoringGetLbDropletsHttpResponsesResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Http Responses Response Data Result Type MonitoringGetLbDropletsHttpResponsesResponseDataResultType- Monitoring
GetLb Droplets Http Responses Response Status MonitoringGetLbDropletsHttpResponsesResponseStatus- Monitoring
GetLb Droplets Http Session Duration50p Response Data Result Item Values Item Item MonitoringGetLbDropletsHttpSessionDuration50pResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Http Session Duration50p Response Data Result Type MonitoringGetLbDropletsHttpSessionDuration50pResponseDataResultType- Monitoring
GetLb Droplets Http Session Duration50p Response Status MonitoringGetLbDropletsHttpSessionDuration50pResponseStatus- Monitoring
GetLb Droplets Http Session Duration95p Response Data Result Item Values Item Item MonitoringGetLbDropletsHttpSessionDuration95pResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Http Session Duration95p Response Data Result Type MonitoringGetLbDropletsHttpSessionDuration95pResponseDataResultType- Monitoring
GetLb Droplets Http Session Duration95p Response Status MonitoringGetLbDropletsHttpSessionDuration95pResponseStatus- Monitoring
GetLb Droplets Http Session Duration AvgResponse Data Result Item Values Item Item MonitoringGetLbDropletsHttpSessionDurationAvgResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Http Session Duration AvgResponse Data Result Type MonitoringGetLbDropletsHttpSessionDurationAvgResponseDataResultType- Monitoring
GetLb Droplets Http Session Duration AvgResponse Status MonitoringGetLbDropletsHttpSessionDurationAvgResponseStatus- Monitoring
GetLb Droplets Queue Size Response Data Result Item Values Item Item MonitoringGetLbDropletsQueueSizeResponseDataResultItemValuesItemItem- Monitoring
GetLb Droplets Queue Size Response Data Result Type MonitoringGetLbDropletsQueueSizeResponseDataResultType- Monitoring
GetLb Droplets Queue Size Response Status MonitoringGetLbDropletsQueueSizeResponseStatus- Monitoring
GetLb Frontend Connections Current Response Data Result Item Values Item Item MonitoringGetLbFrontendConnectionsCurrentResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend Connections Current Response Data Result Type MonitoringGetLbFrontendConnectionsCurrentResponseDataResultType- Monitoring
GetLb Frontend Connections Current Response Status MonitoringGetLbFrontendConnectionsCurrentResponseStatus- Monitoring
GetLb Frontend Connections Limit Response Data Result Item Values Item Item MonitoringGetLbFrontendConnectionsLimitResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend Connections Limit Response Data Result Type MonitoringGetLbFrontendConnectionsLimitResponseDataResultType- Monitoring
GetLb Frontend Connections Limit Response Status MonitoringGetLbFrontendConnectionsLimitResponseStatus- Monitoring
GetLb Frontend CpuUtilization Response Data Result Item Values Item Item MonitoringGetLbFrontendCpuUtilizationResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend CpuUtilization Response Data Result Type MonitoringGetLbFrontendCpuUtilizationResponseDataResultType- Monitoring
GetLb Frontend CpuUtilization Response Status MonitoringGetLbFrontendCpuUtilizationResponseStatus- Monitoring
GetLb Frontend Firewall Dropped Bytes Response Data Result Item Values Item Item MonitoringGetLbFrontendFirewallDroppedBytesResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend Firewall Dropped Bytes Response Data Result Type MonitoringGetLbFrontendFirewallDroppedBytesResponseDataResultType- Monitoring
GetLb Frontend Firewall Dropped Bytes Response Status MonitoringGetLbFrontendFirewallDroppedBytesResponseStatus- Monitoring
GetLb Frontend Firewall Dropped Packets Response Data Result Item Values Item Item MonitoringGetLbFrontendFirewallDroppedPacketsResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend Firewall Dropped Packets Response Data Result Type MonitoringGetLbFrontendFirewallDroppedPacketsResponseDataResultType- Monitoring
GetLb Frontend Firewall Dropped Packets Response Status MonitoringGetLbFrontendFirewallDroppedPacketsResponseStatus- Monitoring
GetLb Frontend Http Requests PerSecond Response Data Result Item Values Item Item MonitoringGetLbFrontendHttpRequestsPerSecondResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend Http Requests PerSecond Response Data Result Type MonitoringGetLbFrontendHttpRequestsPerSecondResponseDataResultType- Monitoring
GetLb Frontend Http Requests PerSecond Response Status MonitoringGetLbFrontendHttpRequestsPerSecondResponseStatus- Monitoring
GetLb Frontend Http Responses Response Data Result Item Values Item Item MonitoringGetLbFrontendHttpResponsesResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend Http Responses Response Data Result Type MonitoringGetLbFrontendHttpResponsesResponseDataResultType- Monitoring
GetLb Frontend Http Responses Response Status MonitoringGetLbFrontendHttpResponsesResponseStatus- Monitoring
GetLb Frontend Network Throughput Http Response Data Result Item Values Item Item MonitoringGetLbFrontendNetworkThroughputHttpResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend Network Throughput Http Response Data Result Type MonitoringGetLbFrontendNetworkThroughputHttpResponseDataResultType- Monitoring
GetLb Frontend Network Throughput Http Response Status MonitoringGetLbFrontendNetworkThroughputHttpResponseStatus- Monitoring
GetLb Frontend Network Throughput TcpResponse Data Result Item Values Item Item MonitoringGetLbFrontendNetworkThroughputTcpResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend Network Throughput TcpResponse Data Result Type MonitoringGetLbFrontendNetworkThroughputTcpResponseDataResultType- Monitoring
GetLb Frontend Network Throughput TcpResponse Status MonitoringGetLbFrontendNetworkThroughputTcpResponseStatus- Monitoring
GetLb Frontend Network Throughput UdpResponse Data Result Item Values Item Item MonitoringGetLbFrontendNetworkThroughputUdpResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend Network Throughput UdpResponse Data Result Type MonitoringGetLbFrontendNetworkThroughputUdpResponseDataResultType- Monitoring
GetLb Frontend Network Throughput UdpResponse Status MonitoringGetLbFrontendNetworkThroughputUdpResponseStatus- Monitoring
GetLb Frontend NlbTcp Network Throughput Response Data Result Item Values Item Item MonitoringGetLbFrontendNlbTcpNetworkThroughputResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend NlbTcp Network Throughput Response Data Result Type MonitoringGetLbFrontendNlbTcpNetworkThroughputResponseDataResultType- Monitoring
GetLb Frontend NlbTcp Network Throughput Response Status MonitoringGetLbFrontendNlbTcpNetworkThroughputResponseStatus- Monitoring
GetLb Frontend NlbUdp Network Throughput Response Data Result Item Values Item Item MonitoringGetLbFrontendNlbUdpNetworkThroughputResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend NlbUdp Network Throughput Response Data Result Type MonitoringGetLbFrontendNlbUdpNetworkThroughputResponseDataResultType- Monitoring
GetLb Frontend NlbUdp Network Throughput Response Status MonitoringGetLbFrontendNlbUdpNetworkThroughputResponseStatus- Monitoring
GetLb Frontend TlsConnections Current Response Data Result Item Values Item Item MonitoringGetLbFrontendTlsConnectionsCurrentResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend TlsConnections Current Response Data Result Type MonitoringGetLbFrontendTlsConnectionsCurrentResponseDataResultType- Monitoring
GetLb Frontend TlsConnections Current Response Status MonitoringGetLbFrontendTlsConnectionsCurrentResponseStatus- Monitoring
GetLb Frontend TlsConnections Exceeding Rate Limit Response Data Result Item Values Item Item MonitoringGetLbFrontendTlsConnectionsExceedingRateLimitResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend TlsConnections Exceeding Rate Limit Response Data Result Type MonitoringGetLbFrontendTlsConnectionsExceedingRateLimitResponseDataResultType- Monitoring
GetLb Frontend TlsConnections Exceeding Rate Limit Response Status MonitoringGetLbFrontendTlsConnectionsExceedingRateLimitResponseStatus- Monitoring
GetLb Frontend TlsConnections Limit Response Data Result Item Values Item Item MonitoringGetLbFrontendTlsConnectionsLimitResponseDataResultItemValuesItemItem- Monitoring
GetLb Frontend TlsConnections Limit Response Data Result Type MonitoringGetLbFrontendTlsConnectionsLimitResponseDataResultType- Monitoring
GetLb Frontend TlsConnections Limit Response Status MonitoringGetLbFrontendTlsConnectionsLimitResponseStatus- Monitoring
GetSink Response Sink Destination Type - The destination type.
opensearch_dbaasfor a DigitalOcean managed OpenSearch cluster oropensearch_extfor an externally managed one. - Monitoring
List Alert Policy Response Policies Item Compare MonitoringListAlertPolicyResponsePoliciesItemCompare- Monitoring
List Alert Policy Response Policies Item Type MonitoringListAlertPolicyResponsePoliciesItemType- Monitoring
List Alert Policy Response Policies Item Window MonitoringListAlertPolicyResponsePoliciesItemWindow- Monitoring
List Destinations Response Destinations Item Type - The destination type.
opensearch_dbaasfor a DigitalOcean managed OpenSearch cluster oropensearch_extfor an externally managed one. - Monitoring
List Sinks Response Sinks Item Destination Type - The destination type.
opensearch_dbaasfor a DigitalOcean managed OpenSearch cluster oropensearch_extfor an externally managed one. - Monitoring
Update Alert Policy Body Compare MonitoringUpdateAlertPolicyBodyCompare- Monitoring
Update Alert Policy Body Type MonitoringUpdateAlertPolicyBodyType- Monitoring
Update Alert Policy Body Window MonitoringUpdateAlertPolicyBodyWindow- Monitoring
Update Alert Policy Response Policy Compare MonitoringUpdateAlertPolicyResponsePolicyCompare- Monitoring
Update Alert Policy Response Policy Type MonitoringUpdateAlertPolicyResponsePolicyType- Monitoring
Update Alert Policy Response Policy Window MonitoringUpdateAlertPolicyResponsePolicyWindow- Monitoring
Update Destination Body Type - The destination type.
opensearch_dbaasfor a DigitalOcean managed OpenSearch cluster oropensearch_extfor an externally managed one. - Multiple
Droplet Request Backup Policy Plan - The backup plan used for the Droplet. The plan can be either
dailyorweekly. - Multiple
Droplet Request Backup Policy Weekday - The day of the week on which the backup will occur.
- Multiple
Droplet Request Image - The image ID of a public or private image or the slug identifier for a public image. This image will be the base image for your Droplet.
Requiresimage:readscope. - Multiple
Droplet Request SshKeys Item MultipleDropletRequestSshKeysItem- Multiple
Droplet Response Droplets Item Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Multiple
Droplet Response Droplets Item Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Multiple
Droplet Response Droplets Item Image Regions Item - The slug identifier for the region where the resource will initially be available.
- Multiple
Droplet Response Droplets Item Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - Multiple
Droplet Response Droplets Item Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - Multiple
Droplet Response Droplets Item Networks V4Item Type - The type of the IPv4 network interface.
- Multiple
Droplet Response Droplets Item Networks V6Item Type - The type of the IPv6 network interface.
- Multiple
Droplet Response Droplets Item Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Multiple
Droplet Response Droplets Item Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- NfsCreate
Access Point Body Access Policy Protocols Item NfsCreateAccessPointBodyAccessPolicyProtocolsItem- NfsCreate
Access Point Body Access Policy Squash Config - The squash mode applied to the access point export.
- NfsCreate
Access Point Response Access Point Access Policy Protocols Item NfsCreateAccessPointResponseAccessPointAccessPolicyProtocolsItem- NfsCreate
Access Point Response Access Point Access Policy Squash Config - The squash mode applied to the access point export.
- NfsCreate
Access Point Response Access Point Status - The current lifecycle status of an access point. There is no ACCESS_POINT_DELETING state: DELETE soft-deletes the access point synchronously (mirroring share deletion); the response of a delete request returns the access point already in ACCESS_POINT_DELETED.
- NfsCreate
Access Point Response Action Resource Type - The type of resource on which the action is being performed. Access point
mutations return
SHAREwithresource_idset to the access point UUID. - NfsCreate
Access Point Response Action Status - The current status of the action.
- NfsCreate
Action Body NfsCreateActionBody- NfsCreate
Action Body Variant0 Type - The type of action to initiate for the NFS share (such as resize or snapshot).
- NfsCreate
Action Body Variant1 Type - The type of action to initiate for the NFS share (such as resize or snapshot).
- NfsCreate
Action Body Variant2 Type - The type of action to initiate for the NFS share (such as resize or snapshot).
- NfsCreate
Action Body Variant3 Type - The type of action to initiate for the NFS share (such as resize or snapshot).
- NfsCreate
Action Body Variant4 Type - The type of action to initiate for the NFS share (such as resize or snapshot).
- NfsCreate
Action Body Variant5 Type - The type of action to initiate for the NFS share (such as resize or snapshot).
- NfsCreate
Action Response Action Resource Type - The type of resource on which the action is being performed. Access point
mutations return
SHAREwithresource_idset to the access point UUID. - NfsCreate
Action Response Action Status - The current status of the action.
- NfsCreate
Response Share Access Points Item Access Policy Protocols Item NfsCreateResponseShareAccessPointsItemAccessPolicyProtocolsItem- NfsCreate
Response Share Access Points Item Access Policy Squash Config - The squash mode applied to the access point export.
- NfsCreate
Response Share Access Points Item Status - The current lifecycle status of an access point. There is no ACCESS_POINT_DELETING state: DELETE soft-deletes the access point synchronously (mirroring share deletion); the response of a delete request returns the access point already in ACCESS_POINT_DELETED.
- NfsCreate
Response Share Status - The current status of the share.
INACTIVEmeans the share exists but is not attached to any VPC. - NfsDelete
Access Point Response Access Point Access Policy Protocols Item NfsDeleteAccessPointResponseAccessPointAccessPolicyProtocolsItem- NfsDelete
Access Point Response Access Point Access Policy Squash Config - The squash mode applied to the access point export.
- NfsDelete
Access Point Response Access Point Status - The current lifecycle status of an access point. There is no ACCESS_POINT_DELETING state: DELETE soft-deletes the access point synchronously (mirroring share deletion); the response of a delete request returns the access point already in ACCESS_POINT_DELETED.
- NfsDelete
Access Point Response Action Resource Type - The type of resource on which the action is being performed. Access point
mutations return
SHAREwithresource_idset to the access point UUID. - NfsDelete
Access Point Response Action Status - The current status of the action.
- NfsGet
Access Point Response Access Point Access Policy Protocols Item NfsGetAccessPointResponseAccessPointAccessPolicyProtocolsItem- NfsGet
Access Point Response Access Point Access Policy Squash Config - The squash mode applied to the access point export.
- NfsGet
Access Point Response Access Point Status - The current lifecycle status of an access point. There is no ACCESS_POINT_DELETING state: DELETE soft-deletes the access point synchronously (mirroring share deletion); the response of a delete request returns the access point already in ACCESS_POINT_DELETED.
- NfsGet
Response Share Access Points Item Access Policy Protocols Item NfsGetResponseShareAccessPointsItemAccessPolicyProtocolsItem- NfsGet
Response Share Access Points Item Access Policy Squash Config - The squash mode applied to the access point export.
- NfsGet
Response Share Access Points Item Status - The current lifecycle status of an access point. There is no ACCESS_POINT_DELETING state: DELETE soft-deletes the access point synchronously (mirroring share deletion); the response of a delete request returns the access point already in ACCESS_POINT_DELETED.
- NfsGet
Response Share Status - The current status of the share.
INACTIVEmeans the share exists but is not attached to any VPC. - NfsGet
Snapshot Response Snapshot Status - The current status of the snapshot.
- NfsList
Access Points Response Access Points Item Access Policy Protocols Item NfsListAccessPointsResponseAccessPointsItemAccessPolicyProtocolsItem- NfsList
Access Points Response Access Points Item Access Policy Squash Config - The squash mode applied to the access point export.
- NfsList
Access Points Response Access Points Item Status - The current lifecycle status of an access point. There is no ACCESS_POINT_DELETING state: DELETE soft-deletes the access point synchronously (mirroring share deletion); the response of a delete request returns the access point already in ACCESS_POINT_DELETED.
- NfsList
Access Points Status NfsListAccessPointsStatus- NfsList
Response Shares Item Access Points Item Access Policy Protocols Item NfsListResponseSharesItemAccessPointsItemAccessPolicyProtocolsItem- NfsList
Response Shares Item Access Points Item Access Policy Squash Config - The squash mode applied to the access point export.
- NfsList
Response Shares Item Access Points Item Status - The current lifecycle status of an access point. There is no ACCESS_POINT_DELETING state: DELETE soft-deletes the access point synchronously (mirroring share deletion); the response of a delete request returns the access point already in ACCESS_POINT_DELETED.
- NfsList
Response Shares Item Status - The current status of the share.
INACTIVEmeans the share exists but is not attached to any VPC. - NfsList
Snapshot Response Snapshots Item Status - The current status of the snapshot.
- OneClicks
List Type OneClicksListType- Organizations
Create Team Body Invitations Item Role - The role to assign to the invited user. The
ownerrole cannot be assigned via invitation. - Organizations
Create Team Response Invitations Value Status - The invitation delivery status for the email address.
- Organizations
List Teams Response Teams Item Status - The team’s membership status within the organization.
- Partner
Attachments Create Body Redundancy Zone - Optional redundancy zone for the partner attachment.
- Partner
Attachments Create Body Region - The region to create the partner attachment.
- Partner
Attachments Patch Body PartnerAttachmentsPatchBody- Projects
Assign Resources Default Response Resources Item Status - The status of assigning and fetching the resources.
- Projects
Assign Resources Response Resources Item Status - The status of assigning and fetching the resources.
- Projects
Create Body Environment - The environment of the project’s resources.
- Projects
Create Response Project Environment - The environment of the project’s resources.
- Projects
GetDefault Response Project Environment - The environment of the project’s resources.
- Projects
GetResponse Project Environment - The environment of the project’s resources.
- Projects
List Resources Default Response Resources Item Status - The status of assigning and fetching the resources.
- Projects
List Resources Response Resources Item Status - The status of assigning and fetching the resources.
- Projects
List Response Projects Item Environment - The environment of the project’s resources.
- Projects
Patch Body Environment - The environment of the project’s resources.
- Projects
Patch Default Body Environment - The environment of the project’s resources.
- Projects
Patch Default Response Project Environment - The environment of the project’s resources.
- Projects
Patch Response Project Environment - The environment of the project’s resources.
- Projects
Update Body Environment - The environment of the project’s resources.
- Projects
Update Default Body Environment - The environment of the project’s resources.
- Projects
Update Default Response Project Environment - The environment of the project’s resources.
- Projects
Update Response Project Environment - The environment of the project’s resources.
- Registries
Create Body Region - Slug of the region where registry data is stored. When not provided, a region will be selected.
- Registries
Create Body Subscription Tier Slug - The slug of the subscription tier to sign up for. Valid values can be retrieved using the options endpoint.
- Registries
GetGarbage Collection Response Garbage Collection Status - The current status of this garbage collection.
- Registries
GetOptions Response Options Subscription Tiers Item Eligibility Reasons Item RegistriesGetOptionsResponseOptionsSubscriptionTiersItemEligibilityReasonsItem- Registries
List Garbage Collections Response Garbage Collections Item Status - The current status of this garbage collection.
- Registries
RunGarbage Collection Response Garbage Collection Status - The current status of this garbage collection.
- Registries
Update Garbage Collection Response Garbage Collection Status - The current status of this garbage collection.
- Registries
Update Subscription Body Tier Slug - The slug of the subscription tier to sign up for.
- Registry
Create Body Region - Slug of the region where registry data is stored. When not provided, a region will be selected.
- Registry
Create Body Subscription Tier Slug - The slug of the subscription tier to sign up for. Valid values can be retrieved using the options endpoint.
- Registry
GetGarbage Collection Response Garbage Collection Status - The current status of this garbage collection.
- Registry
GetOptions Response Options Subscription Tiers Item Eligibility Reasons Item RegistryGetOptionsResponseOptionsSubscriptionTiersItemEligibilityReasonsItem- Registry
List Garbage Collections Response Garbage Collections Item Status - The current status of this garbage collection.
- Registry
RunGarbage Collection Body Type - Type of the garbage collection to run against this registry
- Registry
RunGarbage Collection Response Garbage Collection Status - The current status of this garbage collection.
- Registry
Update Garbage Collection Response Garbage Collection Status - The current status of this garbage collection.
- Registry
Update Subscription Body Tier Slug - The slug of the subscription tier to sign up for.
- ReservedI
PsActions GetResponse Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- ReservedI
PsActions List Response Actions Item Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- ReservedI
PsActions Post Body ReservedIPsActionsPostBody- ReservedI
PsActions Post Body Variant0 Type - The type of action to initiate for the reserved IP.
- ReservedI
PsActions Post Body Variant1 Type - The type of action to initiate for the reserved IP.
- ReservedI
PsActions Post Response Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- ReservedI
PsCreate Body ReservedIPsCreateBody- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Image Regions Item - The slug identifier for the region where the resource will initially be available.
- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Networks V4Item Type - The type of the IPv4 network interface.
- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Networks V6Item Type - The type of the IPv6 network interface.
- ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - ReservedI
PsCreate Response Reserved IpDroplet Subtype1 Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - ReservedI
PsGet Response Reserved IpDroplet Subtype1 Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - ReservedI
PsGet Response Reserved IpDroplet Subtype1 Image Regions Item - The slug identifier for the region where the resource will initially be available.
- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - ReservedI
PsGet Response Reserved IpDroplet Subtype1 Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - ReservedI
PsGet Response Reserved IpDroplet Subtype1 Networks V4Item Type - The type of the IPv4 network interface.
- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Networks V6Item Type - The type of the IPv6 network interface.
- ReservedI
PsGet Response Reserved IpDroplet Subtype1 Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - ReservedI
PsGet Response Reserved IpDroplet Subtype1 Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Image Regions Item - The slug identifier for the region where the resource will initially be available.
- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Networks V4Item Type - The type of the IPv4 network interface.
- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Networks V6Item Type - The type of the IPv6 network interface.
- ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - ReservedI
PsList Response Reserved IpsItem Droplet Subtype1 Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- ReservedI
Pv6Actions Post Body ReservedIPv6ActionsPostBody- ReservedI
Pv6Actions Post Body Variant0 Type - The type of action to initiate for the reserved IPv6.
- ReservedI
Pv6Actions Post Body Variant1 Type - The type of action to initiate for the reserved IPv6.
- ReservedI
Pv6Actions Post Response Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Image Regions Item - The slug identifier for the region where the resource will initially be available.
- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Networks V4Item Type - The type of the IPv4 network interface.
- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Networks V6Item Type - The type of the IPv6 network interface.
- ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - ReservedI
Pv6Get Response Reserved Ipv6 Droplet Subtype1 Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Image Regions Item - The slug identifier for the region where the resource will initially be available.
- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Networks V4Item Type - The type of the IPv4 network interface.
- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Networks V6Item Type - The type of the IPv6 network interface.
- ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - ReservedI
Pv6List Response Reserved Ipv6s Item Droplet Subtype1 Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- Security
GetLatest Scan Severity SecurityGetLatestScanSeverity- Security
GetScan Severity SecurityGetScanSeverity- Severity
- The severity of the finding.
- Shared
SharedV CpuCores Dedicated DedicatedV CpuCores SharedSharedVCpuCoresDedicatedDedicatedVCpuCores- Single
Droplet Request Backup Policy Plan - The backup plan used for the Droplet. The plan can be either
dailyorweekly. - Single
Droplet Request Backup Policy Weekday - The day of the week on which the backup will occur.
- Single
Droplet Request Image - The image ID of a public or private image or the slug identifier for a public image. This image will be the base image for your Droplet.
Requiresimage:readscope. - Single
Droplet Request SshKeys Item SingleDropletRequestSshKeysItem- Single
Droplet Response Droplet Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Single
Droplet Response Droplet Image Distribution - 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, andUnknown. Any other value will be accepted but ignored, andUnknownwill be used in its place. - Single
Droplet Response Droplet Image Regions Item - The slug identifier for the region where the resource will initially be available.
- Single
Droplet Response Droplet Image Status - A status string indicating the state of a custom image. This may be
NEW,available,pending,deleted, orretired. - Single
Droplet Response Droplet Image Type - Describes the kind of image. It may be one of
base,snapshot,backup,custom, oradmin. 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). - Single
Droplet Response Droplet Networks V4Item Type - The type of the IPv4 network interface.
- Single
Droplet Response Droplet Networks V6Item Type - The type of the IPv6 network interface.
- Single
Droplet Response Droplet Size Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Single
Droplet Response Droplet Status - A status string indicating the state of the Droplet instance. This may be “new”, “active”, “off”, or “archive”.
- Sizes
List Response Sizes Item Disk Info Item Type - The type of disk. All Droplets contain a
localorbootdisk. Additionally, GPU Droplets can also have ascratchdisk for non-persistent data. - Snapshots
Delete Snapshot Id SnapshotsDeleteSnapshotId- Snapshots
GetResponse Snapshot Resource Type - The type of resource that the snapshot originated from.
- Snapshots
GetSnapshot Id SnapshotsGetSnapshotId- Snapshots
List Resource Type SnapshotsListResourceType- Snapshots
List Response Snapshots Item Resource Type - The type of resource that the snapshot originated from.
- SshKeys
Delete SshKey Identifier SshKeysDeleteSshKeyIdentifier- SshKeys
GetSsh KeyIdentifier SshKeysGetSshKeyIdentifier- SshKeys
Update SshKey Identifier SshKeysUpdateSshKeyIdentifier- State
- Current state of the plan.
- Status
- The status of the scan.
- Steps
OfAn Alerts Progress Item Status StepsOfAnAlertsProgressItemStatus- Tags
Assign Resources Body Resources Item Resource Type - The type of the resource.
- Tags
Unassign Resources Body Resources Item Resource Type - The type of the resource.
- TheApp
Egress Type TheAppEgressType- TheJob
Invocation Trigger Type - The type of trigger that initiated the job invocation.
- TheStatus
OfThe Dedicated Egress Ip TheStatusOfTheDedicatedEgressIp- Type
- Feature type, indicating the kind of data it holds.
- Unit
- Unit of measurement for the feature, if applicable. Units apply to allowance features.
- Uptime
Create Alert Body Comparison - The comparison operator used against the alert’s threshold.
- Uptime
Create Alert Body Period - Period of time the threshold must be exceeded to trigger the alert.
- Uptime
Create Alert Body Type - The type of alert.
- Uptime
Create Alert Response Alert Comparison - The comparison operator used against the alert’s threshold.
- Uptime
Create Alert Response Alert Period - Period of time the threshold must be exceeded to trigger the alert.
- Uptime
Create Alert Response Alert Type - The type of alert.
- Uptime
Create Check Body Regions Item UptimeCreateCheckBodyRegionsItem- Uptime
Create Check Body Type - The type of health check to perform.
- Uptime
Create Check Response Check Regions Item UptimeCreateCheckResponseCheckRegionsItem- Uptime
Create Check Response Check Type - The type of health check to perform.
- Uptime
GetAlert Response Alert Comparison - The comparison operator used against the alert’s threshold.
- Uptime
GetAlert Response Alert Period - Period of time the threshold must be exceeded to trigger the alert.
- Uptime
GetAlert Response Alert Type - The type of alert.
- Uptime
GetCheck Response Check Regions Item UptimeGetCheckResponseCheckRegionsItem- Uptime
GetCheck Response Check Type - The type of health check to perform.
- Uptime
GetCheck State Response State Regions EuWest - The availability state of the region
- Uptime
GetCheck State Response State Regions UsEast - The availability state of the region
- Uptime
List Alerts Response Alerts Item Comparison - The comparison operator used against the alert’s threshold.
- Uptime
List Alerts Response Alerts Item Period - Period of time the threshold must be exceeded to trigger the alert.
- Uptime
List Alerts Response Alerts Item Type - The type of alert.
- Uptime
List Checks Response Checks Item Regions Item UptimeListChecksResponseChecksItemRegionsItem- Uptime
List Checks Response Checks Item Type - The type of health check to perform.
- Uptime
Update Alert Body Comparison - The comparison operator used against the alert’s threshold.
- Uptime
Update Alert Body Period - Period of time the threshold must be exceeded to trigger the alert.
- Uptime
Update Alert Body Type - The type of alert.
- Uptime
Update Alert Response Alert Comparison - The comparison operator used against the alert’s threshold.
- Uptime
Update Alert Response Alert Period - Period of time the threshold must be exceeded to trigger the alert.
- Uptime
Update Alert Response Alert Type - The type of alert.
- Uptime
Update Check Body Regions Item UptimeUpdateCheckBodyRegionsItem- Uptime
Update Check Body Type - The type of health check to perform.
- Uptime
Update Check Response Check Regions Item UptimeUpdateCheckResponseCheckRegionsItem- Uptime
Update Check Response Check Type - The type of health check to perform.
- Volume
Actions GetResponse Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Volume
Actions List Response Actions Item Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Volume
Actions Post Body Subtype0 Region - The slug identifier for the region where the resource will initially be available.
- Volume
Actions Post Body Subtype0 Type - The volume action to initiate.
- Volume
Actions Post Body Subtype1 Region - The slug identifier for the region where the resource will initially be available.
- Volume
Actions Post Body Subtype1 Type - The volume action to initiate.
- Volume
Actions Post ById Body Subtype0 Region - The slug identifier for the region where the resource will initially be available.
- Volume
Actions Post ById Body Subtype0 Type - The volume action to initiate.
- Volume
Actions Post ById Body Subtype1 Region - The slug identifier for the region where the resource will initially be available.
- Volume
Actions Post ById Body Subtype1 Type - The volume action to initiate.
- Volume
Actions Post ById Body Subtype2 Region - The slug identifier for the region where the resource will initially be available.
- Volume
Actions Post ById Body Subtype2 Type - The volume action to initiate.
- Volume
Actions Post ById Response Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Volume
Actions Post Response Action Status - The current status of the action. This can be “in-progress”, “completed”, or “errored”.
- Volume
Snapshots Create Response Snapshot Resource Type - The type of resource that the snapshot originated from.
- Volume
Snapshots GetBy IdResponse Snapshot Resource Type - The type of resource that the snapshot originated from.
- Volume
Snapshots List Response Snapshots Item Resource Type - The type of resource that the snapshot originated from.
- Volumes
Create Body Subtype0 Region - The slug identifier for the region where the resource will initially be available.
- Volumes
Create Body Subtype1 Region - The slug identifier for the region where the resource will initially be available.
- Volumes
Delete ByName Region - The slug identifier for the region where the resource will initially be available.
- Volumes
List Region - The slug identifier for the region where the resource will initially be available.
- VpcPeerings
Create Response VpcPeering Status - The current status of the VPC peering.
- VpcPeerings
Delete Response VpcPeering Status - The current status of the VPC peering.
- VpcPeerings
GetResponse VpcPeering Status - The current status of the VPC peering.
- VpcPeerings
List Region - The slug identifier for the region where the resource will initially be available.
- VpcPeerings
List Response VpcPeerings Item Status - The current status of the VPC peering.
- VpcPeerings
Patch Response VpcPeering Status - The current status of the VPC peering.
- Vpcnatgateways
Create Body Region - The region in which the VPC NAT gateway is created.
- Vpcnatgateways
Create Body Type - The type of the VPC NAT gateway.
- Vpcnatgateways
Create Response VpcNat Gateway Region - The region in which the VPC NAT gateway is created.
- Vpcnatgateways
Create Response VpcNat Gateway Type - The type of the VPC NAT gateway.
- Vpcnatgateways
GetResponse VpcNat Gateway Region - The region in which the VPC NAT gateway is created.
- Vpcnatgateways
GetResponse VpcNat Gateway State - The current state of the VPC NAT gateway.
- Vpcnatgateways
GetResponse VpcNat Gateway Type - The type of the VPC NAT gateway.
- Vpcnatgateways
List Region VpcnatgatewaysListRegion- Vpcnatgateways
List Response VpcNat Gateways Item Region - The region in which the VPC NAT gateway is created.
- Vpcnatgateways
List Response VpcNat Gateways Item State - The current state of the VPC NAT gateway.
- Vpcnatgateways
List Response VpcNat Gateways Item Type - The type of the VPC NAT gateway.
- Vpcnatgateways
List State VpcnatgatewaysListState- Vpcnatgateways
List Type VpcnatgatewaysListType- Vpcs
Create Peerings Response Peering Status - The current status of the VPC peering.
- Vpcs
List Peerings Response Peerings Item Status - The current status of the VPC peering.
- Vpcs
Patch Peerings Response Peering Status - The current status of the VPC peering.
Traits§
- Client
Info - Interface for which an implementation is generated for all clients.