dots

digital ocean api wrapper


installing

`` bash
npm install --save dots-wrapper@latest
`

using

$3

` typescript
import { createApiClient } from 'dots-wrapper';
const myApiToken = 'my-long-token';
const dots = createApiClient({token: myApiToken});

const main = async () => {
const {data:{account}} = await dots.account.getAccount();
console.log(account);
};

main();
`

$3


` javascript
const {createApiClient} = require('dots-wrapper');
const myApiToken = 'my-long-token';
const dots = createApiClient({token: myApiToken});

const main = async () => {
const {data:{account}} = await dots.account.getAccount();
console.log(account);
};

main();
`

$3

index.html
` html

`
js.js
` javascript
const {createApiClient} = window.dots;
const myApiToken = 'my-long-token';
const dots = createApiClient({token: myApiToken});

const main = async () => {
const {data:{account}} = await dots.account.getAccount();
console.log(account);
};

main();
``

docs

1. account
1. get-account
1. action
1. get-action
1. list-actions
1. app
1. cancel-app-deployment
1. create-app-deployment
1. create-app
1. delete-app
1. get-active-deployment-logs
1. get-aggregated-app-deployment-logs
1. get-app-deployment-logs
1. get-app-deployment
1. get-app
1. list-app-deployments
1. list-apps
1. run-app-detection
1. update-app
1. cdn-endpoint
1. create-cdn-endpoint
1. delete-cdn-endpoint
1. get-cdn-endpoint
1. list-cdn-endpoints
1. purge-cache
1. update-cdn-endpoint
1. certificate
1. create-certificate
1. delete-certificate
1. get-certificate
1. list-certificates
1. container-registry
1. configure-registry
1. delete-registry
1. get-docker-credentials
1. get-registry
1. customer
1. download-invoice
1. get-balance
1. get-invoice-summary
1. list-billing-history
1. list-invoice-items
1. list-invoices
1. database
1. configure-database-cluster-eviction-policy
1. configure-database-cluster-maintenance-window
1. configure-database-cluster-sql-modes
1. create-connection-pool
1. create-database-cluster-db
1. create-database-cluster-user
1. create-database-cluster
1. create-read-only-replica
1. delete-connection-pool
1. delete-database-cluster-db
1. destroy-database-cluster
1. destroy-read-only-replica
1. get-connection-pool
1. get-database-cluster-db
1. get-database-cluster-eviction-policy
1. get-database-cluster-sql-mode
1. get-database-cluster-user
1. get-database-cluster
1. get-read-only-replica
1. list-connection-pools
1. list-database-cluster-backups
1. list-database-cluster-dbs
1. list-database-cluster-firewall-rules
1. list-database-cluster-users
1. list-database-clusters
1. list-database-options
1. list-read-only-replicas
1. migrate-database-cluster
1. remove-database-cluster-user
1. resize-database-cluster
1. restore-database-cluster-backup
1. update-database-cluster-firewall-rules
1. domain
1. create-domain
1. create-domain-record
1. delete-domain
1. delete-domain-record
1. get-domain
1. get-domain-record
1. list-domain-records
1. list-domains
1. update-domain-record
1. droplet
1. change-droplet-kernel
1. create-droplet
1. create-droplets
1. delete-droplet
1. delete-droplets-by-tag
1. destroy-droplet-and-all-associated-resources
1. destroy-droplet-and-associated-resources
1. disable-droplet-backups
1. do-action-by-droplet-tag
1. enable-droplet-backups
1. enable-droplet-ipv6
1. enable-droplet-private-networking
1. get-droplet-action
1. get-droplet-destroy-status
1. get-droplet
1. list-droplet-actions
1. list-droplet-associated-resources
1. list-droplet-backups
1. list-droplet-kernels
1. list-droplet-neighborhoods
1. list-droplet-neighbors
1. list-droplet-snapshots
1. list-droplets
1. power-cycle-droplet
1. power-off-droplet
1. power-on-droplet
1. reboot-droplet
1. rebuild-droplet
1. rename-droplet
1. reset-droplet-password
1. resize-droplet
1. restore-droplet
1. retry-droplet-destroy
1. shutdown-droplet
1. snapshot-droplet
1. firewall
1. add-droplets-to-firewall
1. add-rules-to-firewall
1. add-tags-to-firewall
1. create-firewall
1. delete-firewall
1. get-firewall
1. list-firewalls
1. remove-droplets-from-firewall
1. remove-rules-from-firewall
1. remove-tags-from-firewall
1. update-firewall
1. floating-ip
1. assign-ip-to-droplet
1. create-floating-ip
1. delete-floating-ip
1. get-floating-ip
1. get-floating-ip-action
1. list-floating-ip-actions
1. list-floating-ips
1. unassign-ip-from-droplet
1. gen-ai
1. list-models
1. list-regions
1. list-agents
1. create-agent
1. get-agent
1. update-agent
1. delete-agent
1. update-agent-visibility
1. list-agent-keys
1. create-agent-key
1. update-agent-key
1. delete-agent-key
1. regenerate-agent-key
1. list-agent-routes
1. attach-agent-route
1. update-agent-route
1. detach-agent-route
1. attach-function-route
1. update-function-route
1. detach-function-route
1. attach-knowledge-base
1. attach-knowledge-bases
1. detach-knowledge-base
1. list-agent-versions
1. rollback-agent-version
The agent versioning methods above are experimental and may change without notice.
1. list-openai-keys
1. create-openai-key
1. get-openai-key
1. update-openai-key
1. delete-openai-key
1. list-agents-by-openai-key
1. list-anthropic-keys
1. create-anthropic-key
1. get-anthropic-key
1. update-anthropic-key
1. delete-anthropic-key
1. list-agents-by-anthropic-key
1. list-knowledge-bases
1. create-knowledge-base
1. get-knowledge-base
1. update-knowledge-base
1. delete-knowledge-base
1. list-knowledge-base-data-sources
1. add-knowledge-base-data-source
1. delete-knowledge-base-data-source
1. list-indexing-jobs
1. create-indexing-job
1. list-indexing-job-data-sources
1. get-indexing-job
1. cancel-indexing-job
1. image
1. convert-image-to-snapshot
1. create-custom-image
1. delete-image
1. get-image
1. get-image-action
1. list-image-actions
1. list-images
1. transfer-image
1. update-image
1. kubernetes
1. add-container-registry
1. create-kubernetes-cluster
1. create-node-pool
1. delete-kubernetes-cluster
1. delete-node-pool
1. delete-node
1. get-clusterlint-diagnostics
1. get-kubernetes-cluster-credentials
1. get-kubernetes-cluster-kubeconfig
1. get-kubernetes-cluster
1. get-node-pool
1. list-available-options-of-kubernetes
1. list-kubernetes-cluster-available-upgrades
1. list-kubernetes-clusters
1. list-node-pools
1. remove-container-registry
1. run-clusterlint-on-kubernetes-cluster
1. update-kubernetes-cluster
1. update-node-pool
1. upgrade-kubernetes-cluster
1. load-balancer
1. add-droplets-to-load-balancer
1. add-rules-to-load-balancer
1. create-load-balancer
1. delete-load-balancer
1. get-load-balancer
1. list-load-balancers
1. remove-droplets-from-load-balancer
1. remove-rules-from-load-balancer
1. update-load-balancer
1. monitoring
1. get-droplet-available-memory-metrics
1. get-droplet-bandwidth-metrics
1. get-droplet-cpu-metrics
1. get-droplet-free-memory-metrics
1. get-droplet-total-memory-metrics
1. project
1. assign-resources-to-default-project
1. assign-resources-to-project
1. create-project
1. delete-project
1. get-default-project
1. get-project
1. list-default-project-resources
1. list-project-resources
1. list-projects
1. patch-default-project
1. patch-project
1. update-default-project
1. update-project
1. region
1. list-regions
1. size
1. list-sizes
1. snapshot
1. delete-snapshot
1. get-snapshot
1. list-snapshots
1. ssh-key
1. create-ssh-key
1. destroy-ssh-key
1. get-ssh-key
1. list-ssh-keys
1. update-ssh-key
1. tag
1. create-tag
1. delete-tag
1. get-tag
1. list-tags
1. tag-resources
1. untag-resources
1. volume
1. attach-volume-to-droplet
1. create-volume
1. create-volume-snapshot
1. delete-volume-by-name
1. delete-volume
1. detach-volume-from-droplet
1. get-volume
1. get-volume-action
1. list-volume-actions
1. list-volumes
1. list-volume-snapshots
1. resize-volume
1. vpc
1. create-vpc
1. get-vpc
1. list-vpcs
1. update-vpc
1. list-vpc-resources
1. delete-vpc

contributors

license: mit