DigitalOcean
Visão geral
Seção intitulada “Visão geral”DigitalOcean é um provedor de infraestrutura em nuvem que oferece plataformas de computação escaláveis com uma interface amigável. Com a integração DigitalOcean no SquadOS, seus agentes podem provisionar e gerenciar toda a sua infraestrutura cloud — criando droplets, clusters de banco de dados, balanceadores de carga, firewalls, domínios DNS, volumes de armazenamento e redes privadas (VPCs) — diretamente a partir de conversas.
- Site oficial: https://www.digitalocean.com/
- Documentação na Composio: docs.composio.dev/toolkits/digital_ocean
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza chave de API (API_KEY) ou OAuth 2.0 (OAUTH2) para conectar.
Você vai precisar dos seguintes campos (para conexão via chave de API):
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Token de acesso pessoal gerado no painel do DigitalOcean em API → Tokens. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse cloud.digitalocean.com e faça login na sua conta.
- No menu lateral, clique em API.
- Na aba Tokens, clique em Generate New Token.
- Dê um nome ao token (ex.:
squados-agent), escolha o escopo Read & Write e clique em Generate Token. - Copie o token exibido — ele não será mostrado novamente.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
DigitalOcean. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima (ou autoriza via OAuth 2.0).
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Criar imagem personalizada
Seção intitulada “Criar imagem personalizada”DIGITAL_OCEAN_CREATE_CUSTOM_IMAGE
Cria uma imagem personalizada no DigitalOcean importando uma imagem de disco de VM Linux a partir de uma URL publicamente acessível. Use esta ação para fazer upload de imagens de SO personalizadas (Ubuntu, Debian, CentOS, Fedora, etc.) que podem ser usadas posteriormente para criar Droplets. A imagem será processada de forma assíncrona e seu status pode ser monitorado pelo ID de imagem retornado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
url | string | Sim | URL publicamente acessível (HTTP/HTTPS) apontando para uma imagem de disco de VM Linux. Formatos suportados: Raw (.img), qcow2, VHDX, VDI, VMDK. Pode ser comprimida com gzip ou bzip2. |
name | string | Sim | Nome legível para a imagem personalizada (ex.: ‘ubuntu-20.04-webserver’). |
tags | array | Não | Lista opcional de tags para organizar e categorizar a imagem. |
region | string | Sim | Slug de região do DigitalOcean onde a imagem será armazenada inicialmente (ex.: ‘nyc1’, ‘nyc3’, ‘sfo2’, ‘sfo3’, ‘lon1’, ‘ams3’). |
description | string | Não | Descrição detalhada opcional da finalidade, conteúdo ou configuração da imagem. |
distribution | string | Sim | Nome da distribuição do sistema operacional. Opções válidas: ‘Ubuntu’, ‘Debian’, ‘CentOS’, ‘Fedora’, ‘Arch Linux’ ou ‘Unknown’. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar cluster de banco de dados
Seção intitulada “Criar cluster de banco de dados”DIGITAL_OCEAN_CREATE_DATABASE_CLUSTER
Cria um novo cluster de banco de dados gerenciado no DigitalOcean. Provisiona um banco de dados com o engine especificado (PostgreSQL, MySQL, Valkey, MongoDB, Kafka ou OpenSearch), versão, região, tamanho e quantidade de nós. Retorna credenciais de conexão e detalhes do cluster. O cluster estará com status ‘creating’ inicialmente e levará alguns minutos para ficar totalmente operacional.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome para o cluster de banco de dados. |
size | string | Sim | Slug de tamanho para os nós do banco de dados. Exemplos: db-s-1vcpu-1gb, db-s-2vcpu-4gb, gd-2vcpu-8gb. |
tags | array | Não | Tags a atribuir ao cluster. |
engine | string (“pg” | “mysql” | “valkey” | “mongodb” | “kafka” | “opensearch”) | Sim | Tipo de engine do banco de dados: ‘pg’ (PostgreSQL), ‘mysql’ (MySQL), ‘valkey’ (compatível com Redis), ‘mongodb’ (MongoDB), ‘kafka’ (Apache Kafka), ‘opensearch’ (OpenSearch). |
region | string | Sim | Slug de região onde o cluster será criado. Exemplos: nyc1, nyc3, sfo3, lon1, fra1, ams3, sgp1, tor1, blr1. |
version | string | Sim | Versão do engine do banco de dados. Exemplos: ‘16’ para PostgreSQL, ‘8’ para MySQL/Valkey, ‘8.0’ para MongoDB, ‘3.8’ para Kafka, ‘2’ para OpenSearch. |
db_names | array | Não | Nomes dos bancos de dados a criar no cluster. |
sql_mode | string | Não | Modo SQL para clusters MySQL. |
num_nodes | integer | Sim | Número de nós no cluster. Valores típicos: 1 (nó único), 2 (primário + standby), 3 (alta disponibilidade). |
user_names | array | Não | Nomes de usuário a criar no cluster. |
backup_restore | object | Não | Configuração para restaurar um cluster a partir de um backup. |
eviction_policy | string | Não | Política de evicção para clusters Redis. |
storage_size_gb | integer | Não | Tamanho de armazenamento adicional em GiB para o cluster. |
maintenance_window | object | Não | Configuração da janela de manutenção para o cluster. |
private_network_uuid | string | Não | UUID da rede VPC para redes privadas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar novo volume de armazenamento em bloco
Seção intitulada “Criar novo volume de armazenamento em bloco”DIGITAL_OCEAN_CREATE_NEW_BLOCK_STORAGE_VOLUME
Cria um novo volume de armazenamento em bloco. Use quando precisar provisionar armazenamento persistente em bloco após confirmar que a região de destino suporta volumes. Exemplo: “Criar um volume ext4 de 100 GiB chamado ‘db-backup’ em nyc1.”
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome legível para o volume de armazenamento em bloco. |
tags | array | Não | Lista de tags a aplicar ao volume. |
region | string | Sim | Identificador de slug da região onde o volume será criado (ex.: ‘nyc1’). |
description | string | Não | Descrição textual livre do volume. |
snapshot_id | string | Não | Identificador único de um snapshot para criar o volume a partir dele. |
size_gigabytes | integer | Sim | Tamanho do volume de armazenamento em bloco em GiB (mínimo 1). |
filesystem_type | string | Não | Tipo de sistema de arquivos a inicializar no volume (ex.: ‘ext4’). |
filesystem_label | string | Não | Rótulo a aplicar ao sistema de arquivos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar novo domínio
Seção intitulada “Criar novo domínio”DIGITAL_OCEAN_CREATE_NEW_DOMAIN
Cria um novo domínio no sistema de gerenciamento de DNS do DigitalOcean. Isso adiciona o domínio à sua conta e permite gerenciar seus registros DNS. Use esta ação quando precisar adicionar um domínio ao DNS do DigitalOcean para hospedagem e gerenciamento, configurar um novo domínio com um registro A inicial apontando para um endereço IP, ou transferir o gerenciamento de DNS de um domínio existente para o DigitalOcean.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do domínio a adicionar ao gerenciamento de DNS do DigitalOcean (ex.: ‘example.com’). Deve ser um domínio válido com TLD reconhecido, único na conta. |
ip_address | string | Não | Endereço IPv4 opcional para criar um registro A inicial apontando o apex do domínio para este IP. Se não fornecido, o domínio será criado sem nenhum registro DNS. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar registro de domínio
Seção intitulada “Criar registro de domínio”DIGITAL_OCEAN_CREATE_NEW_DOMAIN_RECORD
Cria um novo registro DNS para um domínio. Use após confirmar que o domínio existe e os detalhes do registro.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tag | string | Não | Tag para registros CAA (issue, issuewild, iodef); obrigatório se o tipo for CAA. |
ttl | integer | Não | Tempo de vida do registro em segundos. |
data | string | Sim | Valor do registro DNS. O formato depende do tipo de registro. Para registros CAA com tags issue/issuewild, use FQDN com ponto final (ex.: ‘letsencrypt.org.’). |
name | string | Não | Nome do host para o registro (ex.: ‘www’). Use ’@’ para o domínio raiz. |
port | integer | Não | Porta para registros SRV; obrigatório se o tipo for SRV. |
type | string (“A” | “AAAA” | “CNAME” | “MX” | “TXT” | “NS” | “SRV” | “CAA”) | Sim | Tipo de registro DNS a criar. |
flags | integer | Não | Flags para registros CAA; obrigatório se o tipo for CAA. |
weight | integer | Não | Peso para registros SRV; obrigatório se o tipo for SRV. |
priority | integer | Não | Prioridade para registros MX e SRV; obrigatório se o tipo for MX ou SRV. |
domain_name | string | Sim | Nome do domínio ao qual adicionar o registro, ex.: ‘example.com’. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar novo Droplet
Seção intitulada “Criar novo Droplet”DIGITAL_OCEAN_CREATE_NEW_DROPLET
Cria um novo Droplet. Use quando precisar provisionar uma VM com nome, região, tamanho e imagem. O image, region e size devem ser mutuamente compatíveis — a região escolhida deve estar listada nas regiões disponíveis da imagem.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ipv6 | boolean | Não | Se o IPv6 está habilitado. |
name | string | Sim | Nome legível para o Droplet. |
size | string | Sim | Slug de tamanho para o Droplet. |
tags | array | Não | Lista de tags a aplicar ao Droplet. |
image | string | Sim | Slug ou ID de imagem a usar para o Droplet. |
region | string | Sim | Slug de região onde o Droplet será criado. |
backups | boolean | Não | Se os backups automáticos estão habilitados. |
volumes | array | Não | IDs de volumes a anexar ao Droplet. |
ssh_keys | array | Não | Lista de IDs ou fingerprints de chaves SSH a incorporar. |
vpc_uuid | string | Não | UUID da VPC a atribuir ao Droplet. |
user_data | string | Não | Script de user data (cloud-init) para configurar o Droplet. |
monitoring | boolean | Não | Se o monitoramento está habilitado. |
private_networking | boolean | Não | Obsoleto: use ‘vpc_uuid’ em vez disso. |
with_droplet_agent | boolean | Não | Se o agente do Droplet para métricas deve ser instalado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar novo firewall
Seção intitulada “Criar novo firewall”DIGITAL_OCEAN_CREATE_NEW_FIREWALL
Cria um novo firewall cloud com regras de entrada e saída personalizadas. Use esta ação para configurar regras de segurança de rede que controlam o tráfego de e para seus Droplets. Você pode especificar regras usando endereços IP (notação CIDR), IDs de Droplet, tags, UUIDs de Load Balancer ou IDs de cluster Kubernetes. Requer pelo menos uma regra de entrada e uma de saída. Suporta os protocolos tcp, udp e icmp.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do novo firewall. |
tags | array | Não | Lista opcional de tags de Droplet para aplicar o firewall aos droplets correspondentes. |
vpc_uuid | string | Não | UUID de VPC opcional para limitar este firewall a uma VPC. |
droplet_ids | array | Não | Lista opcional de IDs de Droplet para aplicar o firewall. |
inbound_rules | array | Sim | Lista de regras de entrada; deve conter pelo menos uma. |
outbound_rules | array | Sim | Lista de regras de saída; deve conter pelo menos uma. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar novo cluster Kubernetes
Seção intitulada “Criar novo cluster Kubernetes”DIGITAL_OCEAN_CREATE_NEW_KUBERNETES_CLUSTER
Cria um novo cluster Kubernetes do DigitalOcean (DOKS) com plano de controle gerenciado. Obrigatório: nome do cluster, slug de região, slug de versão do Kubernetes e pelo menos uma configuração de pool de nós. Opcional: tags, configurações de auto-upgrade, política de manutenção, labels/taints de nós e auto-scaling. O cluster será criado com status ‘provisioning’ e pode levar alguns minutos para ficar ‘running’.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome legível para o cluster Kubernetes. |
tags | array | Não | Lista de tags a aplicar ao cluster. |
region | string | Sim | Slug de região onde o cluster será criado. Regiões comuns: nyc1, nyc3, sfo3, lon1, fra1, tor1, blr1, sgp1, ams3, syd1. |
version | string | Sim | Slug de versão do Kubernetes a implantar (ex.: ‘1.34.1-do.3’, ‘1.33.6-do.3’). Use /v2/kubernetes/options para obter as versões disponíveis atuais. |
node_pools | array | Sim | Lista de pools de nós; pelo menos um é obrigatório. |
auto_upgrade | boolean | Não | Se deve fazer upgrade automático para novas versões de patch. |
maintenance_policy | object | Não | Política de manutenção agendada para o cluster. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar novo balanceador de carga
Seção intitulada “Criar novo balanceador de carga”DIGITAL_OCEAN_CREATE_NEW_LOAD_BALANCER
Cria um novo balanceador de carga. Use após especificar região, regras de encaminhamento e alvos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tag | string | Não | Tag para selecionar droplets (mutuamente exclusivo com droplet_ids). |
name | string | Sim | Nome único para o novo balanceador de carga. |
region | string | Sim | Slug de região onde o balanceador de carga será criado (ex.: ‘nyc1’). |
vpc_uuid | string | Não | UUID da VPC a atribuir ao balanceador de carga. |
algorithm | string (“round_robin” | “least_connections”) | Não | Algoritmo de balanceamento de carga; padrão ‘round_robin’. |
droplet_ids | array | Não | Lista de IDs de droplet a anexar (mutuamente exclusivo com tag). |
health_check | object | Não | Configuração opcional de verificação de saúde. |
firewall_policy | string | Não | ID de uma política de firewall personalizada a aplicar. |
sticky_sessions | object | Não | Configuração opcional de persistência de sessão. |
forwarding_rules | array | Sim | Lista de regras de encaminhamento mapeando protocolos e portas de entrada para saída. |
enable_proxy_protocol | boolean | Não | Habilitar protocolo PROXY para conexões de backend. |
redirect_http_to_https | boolean | Não | Redirecionar tráfego HTTP para HTTPS. |
enable_backend_keepalive | boolean | Não | Habilitar conexões keepalive para droplets de backend. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar nova chave SSH
Seção intitulada “Criar nova chave SSH”DIGITAL_OCEAN_CREATE_NEW_SSH_KEY
Registra uma nova chave pública SSH na sua conta do DigitalOcean. A chave registrada pode ser adicionada automaticamente a novos Droplets durante a criação, habilitando acesso SSH seguro. A chave deve ser fornecida no formato OpenSSH (ssh-rsa, ssh-ed25519, etc.) e não deve já existir na conta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome legível para identificar a chave SSH (ex.: ‘laptop-key’, ‘production-server’). |
public_key | string | Sim | String completa da chave pública SSH no formato OpenSSH. Deve começar com o tipo de chave (ssh-rsa, ssh-ed25519, ecdsa-sha2-nistp256, etc.) seguido pelos dados de chave codificados em base64 e um comentário opcional. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar nova tag
Seção intitulada “Criar nova tag”DIGITAL_OCEAN_CREATE_NEW_TAG
Cria uma nova tag no DigitalOcean para organizar e agrupar recursos. As tags podem ser aplicadas a droplets, imagens, volumes, snapshots de volume e bancos de dados. Se uma tag com o mesmo nome já existir, a API retorna a tag existente (operação idempotente). Nomes de tag devem ter 1–255 caracteres contendo apenas letras, números, hifens ou sublinhados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da nova tag. Deve ter 1–255 caracteres e conter apenas caracteres alfanuméricos, hifens (-) ou sublinhados (_). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar nova VPC
Seção intitulada “Criar nova VPC”DIGITAL_OCEAN_CREATE_NEW_VPC
Cria uma nova Rede Privada Virtual (VPC) em uma região especificada do DigitalOcean. VPCs são redes privadas para isolar seus recursos. O tráfego dentro de uma VPC é gratuito e não conta para os limites de banda. A primeira VPC criada em uma região se torna automaticamente a VPC padrão dessa região.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da VPC. Deve ser único na sua conta. |
tags | array | Não | Lista de nomes de tags a aplicar à VPC após a criação. |
region | string | Sim | Identificador de slug da região onde a VPC será criada. Regiões comuns incluem nyc3 (Nova York), sfo3 (San Francisco), lon1 (Londres), fra1 (Frankfurt), sgp1 (Singapura), tor1 (Toronto). |
ip_range | string | Não | Faixa de IP em notação CIDR para a VPC. O tamanho da rede deve estar entre /16 e /28. Se não especificado, o DigitalOcean atribui uma faixa padrão automaticamente. Não deve sobrepor faixas de IP de VPC existentes na sua conta. |
description | string | Não | Descrição textual livre da VPC. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir volume de armazenamento em bloco
Seção intitulada “Excluir volume de armazenamento em bloco”DIGITAL_OCEAN_DELETE_BLOCK_STORAGE_VOLUME
Exclui permanentemente um volume de armazenamento em bloco pelo seu ID único. Use quando precisar remover um volume existente. O volume não deve estar anexado a nenhum Droplet antes da exclusão. Esta operação não pode ser desfeita. Retorna HTTP 204 No Content em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
volume_id | string | Sim | Identificador único (UUID) do volume de armazenamento em bloco a excluir. O volume não deve estar anexado a nenhum Droplet. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir cluster de banco de dados
Seção intitulada “Excluir cluster de banco de dados”DIGITAL_OCEAN_DELETE_DATABASE_CLUSTER
Exclui um cluster de banco de dados pelo UUID. Use quando confirmar que o cluster não é mais necessário. Retorna HTTP 204 No Content em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
database_cluster_uuid | string | Sim | UUID do cluster de banco de dados a destruir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir domínio
Seção intitulada “Excluir domínio”DIGITAL_OCEAN_DELETE_DOMAIN
Exclui um domínio do DNS do DigitalOcean. Esta ação é permanente e não pode ser desfeita. Nota: se o domínio estiver associado a um certificado Let’s Encrypt, exclua o certificado primeiro e reconfigure quaisquer recursos que o utilizem. Retorna 204 No Content em caso de exclusão bem-sucedida.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome de domínio totalmente qualificado a excluir, ex.: ‘example.com’. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir registro de domínio
Seção intitulada “Excluir registro de domínio”DIGITAL_OCEAN_DELETE_DOMAIN_RECORD
Exclui um registro DNS pelo seu ID de registro para um domínio. Use quando precisar remover um registro DNS existente e tiver o nome do domínio e o ID do registro. Retorna HTTP 204 No Content em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do domínio (ex.: ‘example.com’). |
record_id | integer | Sim | Identificador único do registro DNS a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir Droplet existente
Seção intitulada “Excluir Droplet existente”DIGITAL_OCEAN_DELETE_EXISTING_DROPLET
Exclui um Droplet pelo ID. A exclusão é irreversível — todos os dados são perdidos permanentemente. Confirme o droplet_id com o usuário e verifique se existe um backup ou snapshot antes de prosseguir.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
droplet_id | integer | Sim | Identificador único do Droplet a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir firewall
Seção intitulada “Excluir firewall”DIGITAL_OCEAN_DELETE_FIREWALL
Exclui um firewall pelo ID. Use quando confirmar que o firewall não é mais necessário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
firewall_id | string | Sim | Identificador único do firewall a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir imagem
Seção intitulada “Excluir imagem”DIGITAL_OCEAN_DELETE_IMAGE
Exclui uma imagem personalizada criada pelo usuário ou snapshot da sua conta do DigitalOcean pelo seu ID numérico. Esta ação remove permanentemente a imagem e não pode ser desfeita. Apenas imagens personalizadas e snapshots de sua propriedade podem ser excluídos — tentar excluir imagens de distribuição ou aplicações de marketplace falhará com erro 403 Forbidden.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
image_id | integer | Sim | ID numérico único da imagem personalizada ou snapshot a excluir. Nota: apenas imagens personalizadas criadas pelo usuário e snapshots podem ser excluídos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir balanceador de carga
Seção intitulada “Excluir balanceador de carga”DIGITAL_OCEAN_DELETE_LOAD_BALANCER
Exclui uma instância de balanceador de carga pelo ID. Use quando precisar remover permanentemente um balanceador de carga existente após confirmar seu ID. Retorna 204 No Content em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
load_balancer_id | string | Sim | Identificador único do balanceador de carga a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir chave SSH
Seção intitulada “Excluir chave SSH”DIGITAL_OCEAN_DELETE_SSH_KEY
Exclui uma chave SSH pública. Use quando precisar remover uma chave SSH da sua conta pelo seu ID ou fingerprint após confirmar sua propriedade. Retorna 204 No Content em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
key_id_or_fingerprint | string | Sim | Identificador da chave SSH (ID numérico ou fingerprint). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir tag
Seção intitulada “Excluir tag”DIGITAL_OCEAN_DELETE_TAG
Exclui uma tag da sua conta do DigitalOcean. Quando uma tag é excluída, ela é automaticamente removida de todos os recursos que possuíam essa tag. Esta operação é idempotente — excluir uma tag inexistente também retornará sucesso (204 No Content).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da tag a excluir; todos os recursos com esta tag serão destagueados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir VPC
Seção intitulada “Excluir VPC”DIGITAL_OCEAN_DELETE_VPC
Exclui uma VPC (Rede Privada Virtual) pelo seu identificador único. Use quando precisar remover permanentemente uma VPC da sua conta do DigitalOcean. A exclusão é irreversível. Restrições importantes: não é possível excluir uma VPC que seja a VPC padrão da sua região, nem uma VPC que possua recursos membros (droplets, bancos de dados, balanceadores de carga, etc.) — todos os recursos devem ser desvinculados ou migrados primeiro.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
vpc_id | string | Sim | Identificador único da VPC a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os bancos de dados
Seção intitulada “Listar todos os bancos de dados”DIGITAL_OCEAN_LIST_ALL_DATABASES
Lista todos os clusters de banco de dados gerenciados na sua conta. Suporta paginação e filtragem por tag. Uma única requisição retorna apenas uma página; itere usando page e per_page para recuperar todos os clusters.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página a recuperar (a partir de 1). |
per_page | integer | Não | Número de itens a retornar por página. Deve estar entre 1 e 200. |
tag_name | string | Não | Filtrar para retornar apenas clusters de banco de dados com este nome de tag. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os domínios
Seção intitulada “Listar todos os domínios”DIGITAL_OCEAN_LIST_ALL_DOMAINS
Lista todos os domínios DNS configurados na sua conta do DigitalOcean. Retorna nomes de domínio, valores de TTL e arquivos de zona DNS completos. Suporta paginação para grandes listas de domínios. Use esta ação para descobrir domínios disponíveis, verificar configurações de domínio, ou como pré-requisito para operações específicas de domínio. Sem parâmetros, retorna os primeiros 20 domínios (tamanho de página padrão).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página a recuperar (a partir de 1). |
per_page | integer | Não | Número de domínios a retornar por página (1–200). Padrão é 20 se omitido. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os Droplets
Seção intitulada “Listar todos os Droplets”DIGITAL_OCEAN_LIST_ALL_DROPLETS
Lista todos os Droplets (máquinas virtuais) na sua conta do DigitalOcean com suporte a paginação. Retorna informações detalhadas incluindo: ID, nome, especificações (memória, vCPUs, disco), status, rede (endereços IP), região, imagem, tamanho, tags e VPC. Suporta filtragem por tag. O tamanho de página padrão é 20; contas com mais droplets requerem paginação explícita (incrementar page, até per_page=200) para evitar resultados incompletos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Página de resultados a retornar. Deve ser maior ou igual a 1. Padrão é 1. |
per_page | integer | Não | Número de itens por página. Deve estar entre 1 e 200. Padrão é 20. |
tag_name | string | Não | Filtrar droplets pelo nome da tag. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os firewalls
Seção intitulada “Listar todos os firewalls”DIGITAL_OCEAN_LIST_ALL_FIREWALLS
Lista todos os firewalls cloud configurados na sua conta do DigitalOcean. Retorna detalhes abrangentes do firewall incluindo regras de entrada/saída, droplets associados, tags e status. Suporta paginação para contas com muitos firewalls. Use para auditar a segurança de rede, descobrir configurações de firewall existentes ou recuperar IDs de firewall para operações subsequentes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página a recuperar (a partir de 1). |
per_page | integer | Não | Número de firewalls a retornar por página (1–200). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todas as imagens
Seção intitulada “Listar todas as imagens”DIGITAL_OCEAN_LIST_ALL_IMAGES
Lista todas as imagens disponíveis na sua conta. Use após obter um token de API válido para recuperar imagens opcionalmente filtradas por tipo, visibilidade privada ou tag_name.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página a retornar. Padrão: 1. Mínimo: 1. |
type | string (“distribution” | “application” | “private”) | Não | Filtrar imagens por tipo. Valores válidos: ‘distribution’, ‘application’, ‘private’. |
private | boolean | Não | Se verdadeiro, retorna apenas imagens privadas. Padrão falso. |
per_page | integer | Não | Número de resultados por página. Padrão: 20. Intervalo: 1–200. |
tag_name | string | Não | Retornar apenas imagens tagueadas com esta tag. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os clusters Kubernetes
Seção intitulada “Listar todos os clusters Kubernetes”DIGITAL_OCEAN_LIST_ALL_KUBERNETES_CLUSTERS
Lista todos os clusters Kubernetes da sua conta. Use quando precisar enumerar cada cluster e lidar com paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página dos resultados paginados (a partir de 1). |
per_page | integer | Não | Número de clusters por página. Deve estar entre 1 e 200. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os balanceadores de carga
Seção intitulada “Listar todos os balanceadores de carga”DIGITAL_OCEAN_LIST_ALL_LOAD_BALANCERS
Lista todos os balanceadores de carga na sua conta do DigitalOcean com suporte a paginação. Retorna detalhes incluindo IDs, nomes, endereços IP, regras de encaminhamento, verificações de saúde, sessões sticky, Droplets atribuídos e informações de região.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Página de resultados a retornar. Deve ser maior ou igual a 1. Padrão é 1. |
per_page | integer | Não | Número de itens por página. Deve estar entre 1 e 200. Padrão é 20. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os snapshots
Seção intitulada “Listar todos os snapshots”DIGITAL_OCEAN_LIST_ALL_SNAPSHOTS
Lista todos os snapshots disponíveis na sua conta do DigitalOcean. Use quando precisar buscar e opcionalmente filtrar snapshots por tipo de recurso (droplet ou volume) e lidar com paginação para fluxos de inventário ou backup.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página a recuperar (a partir de 1). |
per_page | integer | Não | Número de snapshots a retornar por página (1–200). |
resource_type | string (“droplet” | “volume”) | Não | Filtrar snapshots por tipo de recurso; ‘droplet’ ou ‘volume’. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todas as chaves SSH
Seção intitulada “Listar todas as chaves SSH”DIGITAL_OCEAN_LIST_ALL_SSH_KEYS
Lista todas as chaves SSH associadas à sua conta do DigitalOcean. Retorna detalhes incluindo ID, nome, conteúdo da chave pública e fingerprint. Suporta paginação para contas com muitas chaves SSH. Use quando precisar visualizar chaves SSH disponíveis ou recuperar um ID de chave SSH para uso com outras operações como criação de droplets.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página a recuperar (a partir de 1). Use com per_page para navegar por resultados paginados. |
per_page | integer | Não | Número de chaves SSH a retornar por página (1–200). Use 200 para recuperar o máximo de resultados por requisição. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todas as tags
Seção intitulada “Listar todas as tags”DIGITAL_OCEAN_LIST_ALL_TAGS
Lista todas as tags da sua conta. Use quando precisar recuperar as tags disponíveis e informações de paginação. Uma única requisição retorna apenas uma página; itere usando page e per_page para recuperar todas as tags.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página a recuperar (a partir de 1). |
per_page | integer | Não | Número de itens retornados por página. Deve estar entre 1 e 200. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os volumes
Seção intitulada “Listar todos os volumes”DIGITAL_OCEAN_LIST_ALL_VOLUMES
Lista todos os volumes de armazenamento em bloco disponíveis na sua conta. Use quando precisar recuperar volumes e opcionalmente filtrar por nome e região.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Filtrar para retornar apenas volumes com este nome exato. |
page | integer | Não | Número da página a recuperar (a partir de 1). |
region | string | Não | Filtrar para retornar apenas volumes nesta região (slug de região). |
per_page | integer | Não | Número de itens retornados por página. Deve estar entre 1 e 200. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todas as VPCs
Seção intitulada “Listar todas as VPCs”DIGITAL_OCEAN_LIST_ALL_VPCS
Lista todas as VPCs da sua conta. Use quando precisar de um inventário dos seus recursos de VPC. Uma única requisição retorna apenas uma página; itere por todas as páginas usando page e per_page (máx. 200) para recuperar o conjunto completo.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Número da página a recuperar (padrão: 1). |
per_page | integer | Não | Número de VPCs a retornar por página (padrão: 20, máx.: 200). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar apps
Seção intitulada “Listar apps”DIGITAL_OCEAN_LIST_APPS
Lista todos os apps da Plataforma App do DigitalOcean na sua conta. Use quando precisar descobrir IDs de app por nome, recuperar metadados de app ou enumerar todos os apps com suporte a paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Qual página de resultados paginados retornar. Deve ser maior ou igual a 1. Padrão é 1. |
per_page | integer | Não | Número de itens retornados por página. Deve estar entre 1 e 200. Padrão é 20. |
with_projects | boolean | Não | Se o project_id dos apps listados deve ser buscado e incluído na resposta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar opções de banco de dados
Seção intitulada “Listar opções de banco de dados”DIGITAL_OCEAN_LIST_DATABASE_OPTIONS
Lista todas as opções de configuração disponíveis para clusters de banco de dados gerenciados do DigitalOcean, incluindo engines suportados (PostgreSQL, MySQL, MongoDB, Valkey, Kafka, OpenSearch), versões, regiões e tamanhos/layouts de cluster. Use para descobrir valores de parâmetros válidos ao criar um novo cluster de banco de dados.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar registros de domínio
Seção intitulada “Listar registros de domínio”DIGITAL_OCEAN_LIST_DOMAIN_RECORDS
Lista todos os registros DNS para um domínio. Use quando precisar inspecionar ou filtrar a configuração de DNS de um domínio.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | integer | Não | Página de resultados a retornar (maior ou igual a 1). |
type | string (“A” | “AAAA” | “CNAME” | “MX” | “NS” | “TXT” | “SRV” | “LOC” | “CAA”) | Não | Filtrar registros por tipo de registro DNS. |
per_page | integer | Não | Número de resultados por página (1–200). |
domain_name | string | Sim | Nome do domínio cujos registros serão listados (ex.: ‘example.com’). |
record_name | string | Não | Filtrar registros pelo nome do registro (ex.: ‘www’, ’@’ para o domínio raiz). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar domínio
Seção intitulada “Recuperar domínio”DIGITAL_OCEAN_RETRIEVE_DOMAIN
Recupera detalhes completos sobre um domínio específico incluindo seu TTL e configuração do arquivo de zona DNS. Use quando precisar verificar configurações de domínio, confirmar a configuração DNS ou obter o conteúdo completo do arquivo de zona para um domínio na sua conta do DigitalOcean.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | O nome de domínio totalmente qualificado (ex.: ‘example.com’). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar registro de domínio
Seção intitulada “Recuperar registro de domínio”DIGITAL_OCEAN_RETRIEVE_DOMAIN_RECORD
Recupera um registro DNS específico para um domínio pelo seu ID de registro. Use quando tiver o nome do domínio e o ID do registro para buscar os detalhes do registro.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do domínio (ex.: ‘example.com’). |
record_id | integer | Sim | Identificador único do registro DNS. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar Droplet existente
Seção intitulada “Recuperar Droplet existente”DIGITAL_OCEAN_RETRIEVE_EXISTING_DROPLET
Recupera informações detalhadas sobre um Droplet específico do DigitalOcean pelo seu ID numérico único. Retorna detalhes abrangentes incluindo: status atual, especificações (memória, CPU, disco), configuração de rede (endereços IPv4/IPv6), informações de imagem, região, VPC, configurações de backup, volumes anexados e tags.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
droplet_id | integer | Sim | Identificador numérico único do Droplet sobre o qual você deseja recuperar informações. Você pode obter IDs de droplet a partir da ação Listar todos os Droplets. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar imagem existente
Seção intitulada “Recuperar imagem existente”DIGITAL_OCEAN_RETRIEVE_EXISTING_IMAGE
Recupera informações sobre uma imagem pelo ID ou slug. Use quando precisar de metadados detalhados para uma imagem conhecida.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
image_id | string | Sim | ID numérico único ou slug da imagem a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar tag
Seção intitulada “Recuperar tag”DIGITAL_OCEAN_RETRIEVE_TAG
Recupera uma tag individual pelo nome. Use quando precisar inspecionar os recursos agrupados sob uma tag específica.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da tag a recuperar (diferencia maiúsculas de minúsculas). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar VPC
Seção intitulada “Recuperar VPC”DIGITAL_OCEAN_RETRIEVE_VPC
Recupera detalhes sobre uma VPC específica pelo seu ID. Use quando precisar inspecionar as propriedades da VPC para configuração ou auditoria.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
vpc_uuid | string | Sim | Identificador único da VPC. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Taguear recurso
Seção intitulada “Taguear recurso”DIGITAL_OCEAN_TAG_RESOURCE
Tagueia recursos pelo nome. Use quando precisar atribuir uma tag existente a um ou mais recursos. Retorna 204 No Content em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tag_name | string | Sim | Nome da tag à qual os recursos serão atribuídos. |
resources | array | Sim | Lista de recursos a atribuir a tag (cada um com id e type). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Remover tag de recurso
Seção intitulada “Remover tag de recurso”DIGITAL_OCEAN_UNTAG_RESOURCE
Remove a tag de recursos pelo nome da tag. Use quando precisar remover uma tag existente de múltiplos recursos em uma única operação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tag_name | string | Sim | Nome da tag a remover dos recursos especificados. |
resources | array | Sim | Lista de objetos de recurso para remover a tag, cada um com id, type e região opcional. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar registro de domínio
Seção intitulada “Atualizar registro de domínio”DIGITAL_OCEAN_UPDATE_DOMAIN_RECORD
Atualiza um registro DNS existente para um domínio. Use quando precisar modificar qualquer atributo válido de um registro após confirmar seu ID de registro.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tag | string | Não | Tag para registros CAA. |
ttl | integer | Não | Tempo de vida do registro em segundos. |
data | string | Não | Valor do registro DNS (ex.: endereço IP para registro A/AAAA). |
name | string | Não | Nome do host para o registro (ex.: ‘www’, ’@’). |
port | integer | Não | Porta para registros SRV. |
type | string | Não | Tipo de registro DNS (ex.: ‘A’, ‘CNAME’, ‘TXT’, ‘MX’, ‘SRV’, ‘CAA’). |
flags | integer | Não | Flags para registros CAA. |
weight | integer | Não | Peso para registros SRV. |
priority | integer | Não | Prioridade para registros MX. |
record_id | integer | Sim | Identificador único do registro DNS. |
domain_name | string | Sim | Nome do domínio (ex.: ‘example.com’). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar VPC
Seção intitulada “Atualizar VPC”DIGITAL_OCEAN_UPDATE_VPC
Atualiza informações sobre uma VPC. Use quando precisar modificar o nome, a descrição ou o status padrão de uma VPC existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Novo nome para a VPC. |
vpc_id | string | Sim | Identificador único da VPC a atualizar. |
default | boolean | Não | Se esta VPC deve ser definida como padrão para sua região. |
description | string | Não | Descrição textual livre para a VPC. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |