id
stringlengths 53
86
| api_name
stringlengths 2
76
| api_description
stringlengths 1
500
⌀ | api_score
float64 0
10
⌀ | endpoint_name
stringlengths 1
190
| endpoint_description
stringlengths 0
500
| response_status_code
int64 100
505
| response_summary
stringlengths 1
68
⌀ | response_json
stringlengths 6
50k
| response_json_schema
stringlengths 14
150k
|
|---|---|---|---|---|---|---|---|---|---|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/af291d18-366e-43ac-a4aa-c51182c4490c/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_destroy_cluster
|
To destroy a specific database, send a DELETE request to /v2/databases/$DATABASE_ID.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/af291d18-366e-43ac-a4aa-c51182c4490c/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_destroy_cluster
|
To destroy a specific database, send a DELETE request to /v2/databases/$DATABASE_ID.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/af291d18-366e-43ac-a4aa-c51182c4490c/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_destroy_cluster
|
To destroy a specific database, send a DELETE request to /v2/databases/$DATABASE_ID.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/af291d18-366e-43ac-a4aa-c51182c4490c/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_destroy_cluster
|
To destroy a specific database, send a DELETE request to /v2/databases/$DATABASE_ID.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/871bae20-97c9-43c2-b610-abbead4b7c4f/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_config
|
Shows configuration parameters for an existing database cluster by sending a GET request to
/v2/databases/$DATABASE_ID/config.
The response is a JSON object with a config key, which is set to an object
containing any database configuration parameters.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/871bae20-97c9-43c2-b610-abbead4b7c4f/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_config
|
Shows configuration parameters for an existing database cluster by sending a GET request to
/v2/databases/$DATABASE_ID/config.
The response is a JSON object with a config key, which is set to an object
containing any database configuration parameters.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/871bae20-97c9-43c2-b610-abbead4b7c4f/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_config
|
Shows configuration parameters for an existing database cluster by sending a GET request to
/v2/databases/$DATABASE_ID/config.
The response is a JSON object with a config key, which is set to an object
containing any database configuration parameters.
| 200 | null |
{"config": {"backup_hour": 3, "backup_minute": 30, "sql_mode": "ANSI,TRADITIONAL", "connect_timeout": 10, "default_time_zone": "+03:00", "group_concat_max_len": 1024, "information_schema_stats_expiry": 86400, "innodb_ft_min_token_size": 3, "innodb_ft_server_stopword_table": "db_name/table_name", "innodb_lock_wait_timeout": 50, "innodb_log_buffer_size": 16777216, "innodb_online_alter_log_max_size": 134217728, "innodb_print_all_deadlocks": true, "innodb_rollback_on_timeout": true, "interactive_timeout": 3600, "internal_tmp_mem_storage_engine": "TempTable", "net_read_timeout": 30, "net_write_timeout": 30, "sql_require_primary_key": true, "wait_timeout": 28800, "max_allowed_packet": 67108864, "max_heap_table_size": 16777216, "sort_buffer_size": 262144, "tmp_table_size": 16777216, "slow_query_log": true, "long_query_time": 10, "binlog_retention_period": 600, "autovacuum_freeze_max_age": 200000000, "autovacuum_max_workers": 5, "autovacuum_naptime": 43200, "autovacuum_vacuum_threshold": 50, "autovacuum_analyze_threshold": 50, "autovacuum_vacuum_scale_factor": 0.2, "autovacuum_analyze_scale_factor": 0.2, "autovacuum_vacuum_cost_delay": 20, "autovacuum_vacuum_cost_limit": -1, "bgwriter_delay": 200, "bgwriter_flush_after": 512, "bgwriter_lru_maxpages": 100, "bgwriter_lru_multiplier": 2, "deadlock_timeout": 1000, "default_toast_compression": "lz4", "idle_in_transaction_session_timeout": 10000, "jit": true, "log_autovacuum_min_duration": -1, "log_error_verbosity": "TERSE", "log_line_prefix": "pid=%p,user=%u,db=%d,app=%a,client=%h", "log_min_duration_statement": -1, "max_files_per_process": 2048, "max_prepared_transactions": 20, "max_pred_locks_per_transaction": 128, "max_locks_per_transaction": 128, "max_stack_depth": 2097152, "max_standby_archive_delay": 43200, "max_standby_streaming_delay": 43200, "max_replication_slots": 16, "max_logical_replication_workers": 16, "max_parallel_workers": 12, "max_parallel_workers_per_gather": 16, "max_worker_processes": 16, "pg_partman_bgw.role": "myrolename", "pg_partman_bgw.interval": 3600, "pg_stat_statements.track": "all", "temp_file_limit": 5000000, "timezone": "Europe/Helsinki", "track_activity_query_size": 1024, "track_commit_timestamp": "off", "track_functions": "all", "track_io_timing": "off", "max_wal_senders": 32, "wal_sender_timeout": 60000, "wal_writer_delay": 50, "shared_buffers_percentage": 41.5, "pgbouncer": {"server_reset_query_always": true, "ignore_startup_parameters": ["extra_float_digits"], "min_pool_size": 1, "server_lifetime": 3600, "server_idle_timeout": 600, "autodb_pool_size": 1, "autodb_pool_mode": "session", "autodb_max_db_connections": 1, "autodb_idle_timeout": 3600}, "work_mem": 4, "timescaledb": {"max_background_workers": 8}, "synchronous_replication": "off", "stat_monitor_enable": true, "redis_maxmemory_policy": "noeviction", "redis_pubsub_client_output_buffer_limit": 64, "redis_number_of_databases": 16, "redis_io_threads": 1, "redis_lfu_log_factor": 10, "redis_lfu_decay_time": 1, "redis_ssl": true, "redis_timeout": 300, "redis_notify_keyspace_events": "K", "redis_persistence": "off", "redis_acl_channels_default": "allchannels"}}
|
{"type": "object", "properties": {"config": {"anyOf": [{"type": "object", "properties": {"backup_hour": {"description": "The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.", "minimum": 0, "maximum": 23, "type": "integer"}, "backup_minute": {"description": "The minute of the backup hour when backup for the service starts. New backup only starts if previous backup has already completed.", "minimum": 0, "maximum": 59, "type": "integer"}, "sql_mode": {"description": "Global SQL mode. If empty, uses MySQL server defaults. Must only include uppercase alphabetic characters, underscores, and commas.", "type": "string", "pattern": "^[A-Z_]*(,[A-Z_]+)*$", "maxLength": 1024}, "connect_timeout": {"description": "The number of seconds that the mysqld server waits for a connect packet before responding with bad handshake.", "type": "integer", "minimum": 2, "maximum": 3600}, "default_time_zone": {"description": "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.", "type": "string", "minLength": 2, "maxLength": 100}, "group_concat_max_len": {"description": "The maximum permitted result length, in bytes, for the GROUP_CONCAT() function.", "type": "integer", "minimum": 4, "maximum": 18446744073709552000}, "information_schema_stats_expiry": {"description": "The time, in seconds, before cached statistics expire.", "type": "integer", "minimum": 900, "maximum": 31536000}, "innodb_ft_min_token_size": {"description": "The minimum length of words that an InnoDB FULLTEXT index stores.", "type": "integer", "minimum": 0, "maximum": 16}, "innodb_ft_server_stopword_table": {"description": "The InnoDB FULLTEXT index stopword list for all InnoDB tables.", "type": "string", "pattern": "^.+/.+$", "maxLength": 1024}, "innodb_lock_wait_timeout": {"description": "The time, in seconds, that an InnoDB transaction waits for a row lock. before giving up.", "type": "integer", "minimum": 1, "maximum": 3600}, "innodb_log_buffer_size": {"description": "The size of the buffer, in bytes, that InnoDB uses to write to the log files. on disk.", "type": "integer", "minimum": 1048576, "maximum": 4294967295}, "innodb_online_alter_log_max_size": {"description": "The upper limit, in bytes, of the size of the temporary log files used during online DDL operations for InnoDB tables.", "type": "integer", "minimum": 65536, "maximum": 1099511627776}, "innodb_print_all_deadlocks": {"description": "When enabled, records information about all deadlocks in InnoDB user transactions in the error log. Disabled by default.", "type": "boolean"}, "innodb_rollback_on_timeout": {"description": "When enabled, transaction timeouts cause InnoDB to abort and roll back the entire transaction.", "type": "boolean"}, "interactive_timeout": {"description": "The time, in seconds, the server waits for activity on an interactive. connection before closing it.", "type": "integer", "minimum": 30, "maximum": 604800}, "internal_tmp_mem_storage_engine": {"description": "The storage engine for in-memory internal temporary tables.", "type": "string", "enum": ["TempTable", "MEMORY"]}, "net_read_timeout": {"description": "The time, in seconds, to wait for more data from an existing connection. aborting the read.", "type": "integer", "minimum": 1, "maximum": 3600}, "net_write_timeout": {"description": "The number of seconds to wait for a block to be written to a connection before aborting the write.", "type": "integer", "minimum": 1, "maximum": 3600}, "sql_require_primary_key": {"description": "Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them.", "type": "boolean"}, "wait_timeout": {"description": "The number of seconds the server waits for activity on a noninteractive connection before closing it.", "type": "integer", "minimum": 1, "maximum": 2147483}, "max_allowed_packet": {"description": "The size of the largest message, in bytes, that can be received by the server. Default is 67108864 (64M).", "type": "integer", "minimum": 102400, "maximum": 1073741824}, "max_heap_table_size": {"description": "The maximum size, in bytes, of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)", "type": "integer", "minimum": 1048576, "maximum": 1073741824}, "sort_buffer_size": {"description": "The sort buffer size, in bytes, for ORDER BY optimization. Default is 262144. (256K).", "type": "integer", "minimum": 32768, "maximum": 1073741824}, "tmp_table_size": {"description": "The maximum size, in bytes, of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M).", "type": "integer", "minimum": 1048576, "maximum": 1073741824}, "slow_query_log": {"description": "When enabled, captures slow queries. When disabled, also truncates the mysql.slow_log table. Default is false.", "type": "boolean"}, "long_query_time": {"description": "The time, in seconds, for a query to take to execute before being captured by slow_query_logs. Default is 10 seconds.", "type": "number", "minimum": 0, "maximum": 3600}, "binlog_retention_period": {"description": "The minimum amount of time, in seconds, to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default, for example if using the MySQL Debezium Kafka connector.", "type": "number", "minimum": 600, "maximum": 86400}}}, {"type": "object", "properties": {"autovacuum_freeze_max_age": {"description": "Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.", "type": "integer", "minimum": 200000000, "maximum": 1500000000}, "autovacuum_max_workers": {"description": "Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.", "type": "integer", "minimum": 1, "maximum": 20}, "autovacuum_naptime": {"description": "Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.", "type": "integer", "minimum": 0, "maximum": 86400}, "autovacuum_vacuum_threshold": {"description": "Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.", "type": "integer", "minimum": 0, "maximum": 2147483647}, "autovacuum_analyze_threshold": {"description": "Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.", "type": "integer", "minimum": 0, "maximum": 2147483647}, "autovacuum_vacuum_scale_factor": {"description": "Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).", "type": "number", "minimum": 0, "maximum": 1}, "autovacuum_analyze_scale_factor": {"description": "Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).", "type": "number", "minimum": 0, "maximum": 1}, "autovacuum_vacuum_cost_delay": {"description": "Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.", "type": "integer", "minimum": -1, "maximum": 100}, "autovacuum_vacuum_cost_limit": {"description": "Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.", "type": "integer", "minimum": -1, "maximum": 10000}, "backup_hour": {"description": "The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.", "minimum": 0, "maximum": 23, "type": "integer"}, "backup_minute": {"description": "The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.", "minimum": 0, "maximum": 59, "type": "integer"}, "bgwriter_delay": {"description": "Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.", "type": "integer", "minimum": 10, "maximum": 10000}, "bgwriter_flush_after": {"description": "The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.", "type": "integer", "minimum": 0, "maximum": 2048}, "bgwriter_lru_maxpages": {"description": "The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.", "type": "integer", "minimum": 0, "maximum": 1073741823}, "bgwriter_lru_multiplier": {"description": "The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a \u201cjust in time\u201d policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.", "type": "number", "minimum": 0, "maximum": 10}, "deadlock_timeout": {"description": "The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.", "type": "integer", "minimum": 500, "maximum": 1800000}, "default_toast_compression": {"description": "Specifies the default TOAST compression method for values of compressible columns (the default is lz4).", "type": "string", "enum": ["lz4", "pglz"]}, "idle_in_transaction_session_timeout": {"description": "Time out sessions with open transactions after this number of milliseconds", "type": "integer", "minimum": 0, "maximum": 604800000}, "jit": {"description": "Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).", "type": "boolean"}, "log_autovacuum_min_duration": {"description": "Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.", "type": "integer", "minimum": -1, "maximum": 2147483647}, "log_error_verbosity": {"description": "Controls the amount of detail written in the server log for each message that is logged.", "type": "string", "enum": ["TERSE", "DEFAULT", "VERBOSE"]}, "log_line_prefix": {"description": "Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc.", "type": "string", "enum": ["pid=%p,user=%u,db=%d,app=%a,client=%h", "%m [%p] %q[user=%u,db=%d,app=%a]", "%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h"]}, "log_min_duration_statement": {"description": "Log statements that take more than this number of milliseconds to run. If -1, disables.", "type": "integer", "minimum": -1, "maximum": 86400000}, "max_files_per_process": {"description": "PostgreSQL maximum number of files that can be open per process.", "type": "integer", "minimum": 1000, "maximum": 4096}, "max_prepared_transactions": {"description": "PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.", "type": "integer", "minimum": 0, "maximum": 10000}, "max_pred_locks_per_transaction": {"description": "PostgreSQL maximum predicate locks per transaction.", "type": "integer", "minimum": 64, "maximum": 640}, "max_locks_per_transaction": {"description": "PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.", "type": "integer", "minimum": 64, "maximum": 6400}, "max_stack_depth": {"description": "Maximum depth of the stack in bytes.", "type": "integer", "minimum": 2097152, "maximum": 6291456}, "max_standby_archive_delay": {"description": "Max standby archive delay in milliseconds.", "type": "integer", "minimum": 1, "maximum": 43200000}, "max_standby_streaming_delay": {"description": "Max standby streaming delay in milliseconds.", "type": "integer", "minimum": 1, "maximum": 43200000}, "max_replication_slots": {"description": "PostgreSQL maximum replication slots.", "type": "integer", "minimum": 8, "maximum": 64}, "max_logical_replication_workers": {"description": "PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).", "type": "integer", "minimum": 4, "maximum": 64}, "max_parallel_workers": {"description": "Sets the maximum number of workers that the system can support for parallel queries.", "type": "integer", "minimum": 0, "maximum": 96}, "max_parallel_workers_per_gather": {"description": "Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.", "type": "integer", "minimum": 0, "maximum": 96}, "max_worker_processes": {"description": "Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.", "type": "integer", "minimum": 8, "maximum": 96}, "pg_partman_bgw.role": {"type": "string", "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$", "maxLength": 64, "description": "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."}, "pg_partman_bgw.interval": {"description": "Sets the time interval to run pg_partman's scheduled tasks.", "type": "integer", "minimum": 3600, "maximum": 604800}, "pg_stat_statements.track": {"description": "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.", "type": "string", "enum": ["all", "top", "none"]}, "temp_file_limit": {"description": "PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.", "type": "integer", "minimum": -1, "maximum": 2147483647}, "timezone": {"description": "PostgreSQL service timezone", "type": "string", "maxLength": 64}, "track_activity_query_size": {"description": "Specifies the number of bytes reserved to track the currently executing command for each active session.", "type": "integer", "minimum": 1024, "maximum": 10240}, "track_commit_timestamp": {"description": "Record commit time of transactions.", "type": "string", "enum": ["off", "on"]}, "track_functions": {"description": "Enables tracking of function call counts and time used.", "type": "string", "enum": ["all", "pl", "none"]}, "track_io_timing": {"description": "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.", "type": "string", "enum": ["off", "on"]}, "max_wal_senders": {"description": "PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.", "type": "integer", "minimum": 20, "maximum": 64}, "wal_sender_timeout": {"description": "Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.", "type": "integer", "minimum": 0, "maximum": 10800000}, "wal_writer_delay": {"description": "WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance", "type": "integer", "minimum": 10, "maximum": 200}, "shared_buffers_percentage": {"description": "Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.", "type": "number", "minimum": 20, "maximum": 60}, "pgbouncer": {"type": "object", "description": "PGBouncer connection pooling settings", "properties": {"server_reset_query_always": {"description": "Run server_reset_query (DISCARD ALL) in all pooling modes.", "type": "boolean"}, "ignore_startup_parameters": {"description": "List of parameters to ignore when given in startup packet.", "type": "array", "items": {"description": "Enum of parameters to ignore when given in startup packet.", "type": "string", "enum": ["extra_float_digits", "search_path"]}, "maxItems": 32}, "min_pool_size": {"description": "If current server connections are below this number, adds more. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size.", "type": "integer", "minimum": 0, "maximum": 10000}, "server_lifetime": {"description": "The pooler closes any unused server connection that has been connected longer than this amount of seconds.", "type": "integer", "minimum": 60, "maximum": 86400}, "server_idle_timeout": {"description": "Drops server connections if they have been idle more than this many seconds. If 0, timeout is disabled. ", "type": "integer", "minimum": 0, "maximum": 86400}, "autodb_pool_size": {"description": "If non-zero, automatically creates a pool of that size per user when a pool doesn't exist.", "type": "integer", "minimum": 0, "maximum": 10000}, "autodb_pool_mode": {"enum": ["session", "transaction", "statement"], "description": "PGBouncer pool mode", "type": "string"}, "autodb_max_db_connections": {"description": "Only allows a maximum this many server connections per database (regardless of user). If 0, allows unlimited connections.", "type": "integer", "minimum": 0, "maximum": 2147483647}, "autodb_idle_timeout": {"description": "If the automatically-created database pools have been unused this many seconds, they are freed. If 0, timeout is disabled.", "type": "integer", "minimum": 0, "maximum": 86400}}}, "work_mem": {"description": "The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).", "type": "integer", "minimum": 1, "maximum": 1024}, "timescaledb": {"type": "object", "description": "TimescaleDB extension configuration values", "properties": {"max_background_workers": {"description": "The number of background workers for timescaledb operations. Set to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time.", "type": "integer", "minimum": 1, "maximum": 4096}}}, "synchronous_replication": {"description": "Synchronous replication type. Note that the service plan also needs to support synchronous replication.", "type": "string", "enum": ["off", "quorum"]}, "stat_monitor_enable": {"description": "Enable the pg_stat_monitor extension. <b>Enabling this extension will cause the cluster to be restarted.</b> When this extension is enabled, pg_stat_statements results for utility commands are unreliable.", "type": "boolean"}}}, {"type": "object", "properties": {"redis_maxmemory_policy": {"type": "string", "enum": ["noeviction", "allkeys_lru", "allkeys_random", "volatile_lru", "volatile_random", "volatile_ttl"], "description": "A string specifying the desired eviction policy for the Redis cluster.\n\n- `noeviction`: Don't evict any data, returns error when memory limit is reached.\n- `allkeys_lru:` Evict any key, least recently used (LRU) first.\n- `allkeys_random`: Evict keys in a random order.\n- `volatile_lru`: Evict keys with expiration only, least recently used (LRU) first.\n- `volatile_random`: Evict keys with expiration only in a random order.\n- `volatile_ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first."}, "redis_pubsub_client_output_buffer_limit": {"description": "Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.", "type": "integer", "minimum": 32, "maximum": 512}, "redis_number_of_databases": {"type": "integer", "minimum": 1, "maximum": 128, "description": "Set number of redis databases. Changing this will cause a restart of redis service."}, "redis_io_threads": {"description": "Redis IO thread count", "type": "integer", "minimum": 1, "maximum": 32}, "redis_lfu_log_factor": {"description": "Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies", "type": "integer", "minimum": 0, "maximum": 100, "default": 10}, "redis_lfu_decay_time": {"description": "LFU maxmemory-policy counter decay time in minutes", "type": "integer", "minimum": 1, "maximum": 120, "default": 1}, "redis_ssl": {"description": "Require SSL to access Redis", "type": "boolean", "default": true}, "redis_timeout": {"description": "Redis idle connection timeout in seconds", "type": "integer", "minimum": 0, "maximum": 31536000, "default": 300}, "redis_notify_keyspace_events": {"description": "Set notify-keyspace-events option", "type": "string", "pattern": "^[KEg\\$lshzxeA]*$", "default": "", "maxLength": 32}, "redis_persistence": {"type": "string", "enum": ["off", "rdb"], "description": "When persistence is 'rdb', Redis 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."}, "redis_acl_channels_default": {"type": "string", "enum": ["allchannels", "resetchannels"], "description": "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 Redis configuration acl-pubsub-default."}}}]}}, "required": ["config"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/871bae20-97c9-43c2-b610-abbead4b7c4f/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_config
|
Shows configuration parameters for an existing database cluster by sending a GET request to
/v2/databases/$DATABASE_ID/config.
The response is a JSON object with a config key, which is set to an object
containing any database configuration parameters.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/871bae20-97c9-43c2-b610-abbead4b7c4f/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_config
|
Shows configuration parameters for an existing database cluster by sending a GET request to
/v2/databases/$DATABASE_ID/config.
The response is a JSON object with a config key, which is set to an object
containing any database configuration parameters.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/26667e31-f749-4b18-80ba-ae86c0c43495/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_evictionPolicy
|
To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to /v2/databases/$DATABASE_ID/eviction_policy.
The response will be a JSON object with an eviction_policy key. This will be set to a string representing the eviction policy.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/26667e31-f749-4b18-80ba-ae86c0c43495/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_evictionPolicy
|
To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to /v2/databases/$DATABASE_ID/eviction_policy.
The response will be a JSON object with an eviction_policy key. This will be set to a string representing the eviction policy.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/26667e31-f749-4b18-80ba-ae86c0c43495/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_evictionPolicy
|
To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to /v2/databases/$DATABASE_ID/eviction_policy.
The response will be a JSON object with an eviction_policy key. This will be set to a string representing the eviction policy.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/26667e31-f749-4b18-80ba-ae86c0c43495/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_evictionPolicy
|
To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to /v2/databases/$DATABASE_ID/eviction_policy.
The response will be a JSON object with an eviction_policy key. This will be set to a string representing the eviction policy.
| 200 | null |
{"eviction_policy": "noeviction"}
|
{"required": ["eviction_policy"], "properties": {"eviction_policy": {"type": "string", "enum": ["noeviction", "allkeys_lru", "allkeys_random", "volatile_lru", "volatile_random", "volatile_ttl"], "description": "A string specifying the desired eviction policy for the Redis cluster.\n\n- `noeviction`: Don't evict any data, returns error when memory limit is reached.\n- `allkeys_lru:` Evict any key, least recently used (LRU) first.\n- `allkeys_random`: Evict keys in a random order.\n- `volatile_lru`: Evict keys with expiration only, least recently used (LRU) first.\n- `volatile_random`: Evict keys with expiration only in a random order.\n- `volatile_ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first."}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/26667e31-f749-4b18-80ba-ae86c0c43495/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_evictionPolicy
|
To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to /v2/databases/$DATABASE_ID/eviction_policy.
The response will be a JSON object with an eviction_policy key. This will be set to a string representing the eviction policy.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8cc3d2ef-f347-4138-90b2-c917c2302968/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletMemoryAvailableMetrics
|
To retrieve available memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_available.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8cc3d2ef-f347-4138-90b2-c917c2302968/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletMemoryAvailableMetrics
|
To retrieve available memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_available.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8cc3d2ef-f347-4138-90b2-c917c2302968/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletMemoryAvailableMetrics
|
To retrieve available memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_available.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8cc3d2ef-f347-4138-90b2-c917c2302968/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletMemoryAvailableMetrics
|
To retrieve available memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_available.
| 200 | null |
{"data": {"result": [{"metric": {}, "values": []}], "resultType": "matrix"}, "status": "success"}
|
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "description": "An object containing the metric labels.", "additionalProperties": {"type": "string"}}, "values": {"type": "array", "items": {"type": "array", "items": {"oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}}}, "resultType": {"type": "string", "enum": ["matrix"]}}}, "status": {"type": "string", "enum": ["success", "error"]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/530fa4bb-b80d-4a17-b06b-0d9e3b1fcb5a/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad5Metrics
|
To retrieve 5 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_5.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/530fa4bb-b80d-4a17-b06b-0d9e3b1fcb5a/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad5Metrics
|
To retrieve 5 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_5.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/530fa4bb-b80d-4a17-b06b-0d9e3b1fcb5a/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad5Metrics
|
To retrieve 5 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_5.
| 200 | null |
{"data": {"result": [{"metric": {}, "values": []}], "resultType": "matrix"}, "status": "success"}
|
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "description": "An object containing the metric labels.", "additionalProperties": {"type": "string"}}, "values": {"type": "array", "items": {"type": "array", "items": {"oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}}}, "resultType": {"type": "string", "enum": ["matrix"]}}}, "status": {"type": "string", "enum": ["success", "error"]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/530fa4bb-b80d-4a17-b06b-0d9e3b1fcb5a/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad5Metrics
|
To retrieve 5 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_5.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c03bfd1f-cd04-4d2f-8789-6184d6ce787c/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_cluster
|
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c03bfd1f-cd04-4d2f-8789-6184d6ce787c/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_cluster
|
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c03bfd1f-cd04-4d2f-8789-6184d6ce787c/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_cluster
|
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c03bfd1f-cd04-4d2f-8789-6184d6ce787c/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_cluster
|
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c03bfd1f-cd04-4d2f-8789-6184d6ce787c/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_get_cluster
|
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
| 200 | null |
{"database": {"id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "name": "backend", "engine": "pg", "version": "10", "num_nodes": 2, "size": "db-s-2vcpu-4gb", "region": "nyc3", "status": "creating", "created_at": "2019-01-11T18:37:36Z", "private_network_uuid": "d455e75d-4858-4eec-8c95-da2f0a5f93a7", "tags": [], "db_names": [], "connection": {"uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", "database": "defaultdb", "host": "backend-do-user-19081923-0.db.ondigitalocean.com", "port": 25060, "user": "doadmin", "password": "wv78n3zpz42xezdk", "ssl": true}, "private_connection": {"uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", "database": "defaultdb", "host": "backend-do-user-19081923-0.db.ondigitalocean.com", "port": 25060, "user": "doadmin", "password": "wv78n3zpz42xezdk", "ssl": true}, "users": [{"name": "app-01", "role": "primary", "password": "jge5lfxtzhx42iff", "mysql_settings": {"auth_plugin": "mysql_native_password"}}], "maintenance_window": {"day": "tuesday", "hour": "14:00", "pending": true, "description": []}, "project_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "rules": [{"uuid": "79f26d28-ea8a-41f2-8ad8-8cfcdd020095", "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "type": "droplet", "value": "ff2a6c52-5a44-4b63-b99c-0e98e7a63d61", "created_at": "2019-01-11T18:37:36Z"}], "version_end_of_life": "2023-11-09T00:00:00Z", "version_end_of_availability": "2023-05-09T00:00:00Z"}}
|
{"type": "object", "properties": {"database": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a database cluster."}, "name": {"type": "string", "description": "A unique, human-readable name referring to a database cluster."}, "engine": {"type": "string", "enum": ["pg", "mysql", "redis", "mongodb"], "description": "A slug representing the database engine used for the cluster. The possible values are: \"pg\" for PostgreSQL, \"mysql\" for MySQL, \"redis\" for Redis, and \"mongodb\" for MongoDB."}, "version": {"type": "string", "description": "A string representing the version of the database engine in use for the cluster."}, "num_nodes": {"type": "integer", "description": "The number of nodes in the database cluster."}, "size": {"type": "string", "description": "The slug identifier representing the size of the nodes in the database cluster."}, "region": {"type": "string", "description": "The slug identifier for the region where the database cluster is located."}, "status": {"type": "string", "enum": ["creating", "online", "resizing", "migrating", "forking"], "description": "A string representing the current status of the database cluster."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the database cluster was created."}, "private_network_uuid": {"type": "string", "pattern": "^$|[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}", "description": "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."}, "tags": {"type": ["array", "null"], "items": {"type": "string"}, "description": "An array of tags that have been applied to the database cluster."}, "db_names": {"type": ["array", "null"], "items": {"type": "string"}, "description": "An array of strings containing the names of databases created in the database cluster."}, "connection": {"allOf": [{"type": "object", "properties": {"uri": {"type": "string", "description": "A connection string in the format accepted by the `psql` command. This is provided as a convenience and should be able to be constructed by the other attributes."}, "database": {"type": "string", "description": "The name of the default database."}, "host": {"type": "string", "description": "The FQDN pointing to the database cluster's current primary node."}, "port": {"type": "integer", "description": "The port on which the database cluster is listening."}, "user": {"type": "string", "description": "The default user for the database."}, "password": {"type": "string", "description": "The randomly generated password for the default user."}, "ssl": {"type": "boolean", "description": "A boolean value indicating if the connection should be made over SSL."}}}, {}]}, "private_connection": {"allOf": [{"type": "object", "properties": {"uri": {"type": "string", "description": "A connection string in the format accepted by the `psql` command. This is provided as a convenience and should be able to be constructed by the other attributes."}, "database": {"type": "string", "description": "The name of the default database."}, "host": {"type": "string", "description": "The FQDN pointing to the database cluster's current primary node."}, "port": {"type": "integer", "description": "The port on which the database cluster is listening."}, "user": {"type": "string", "description": "The default user for the database."}, "password": {"type": "string", "description": "The randomly generated password for the default user."}, "ssl": {"type": "boolean", "description": "A boolean value indicating if the connection should be made over SSL."}}}, {}]}, "users": {"type": ["array", "null"], "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of a database user."}, "role": {"type": "string", "enum": ["primary", "normal"], "description": "A string representing the database user's role. The value will be either\n\"primary\" or \"normal\".\n"}, "password": {"type": "string", "description": "A randomly generated password for the database user."}, "mysql_settings": {"type": "object", "properties": {"auth_plugin": {"type": "string", "enum": ["mysql_native_password", "caching_sha2_password"], "description": "A string specifying the authentication method to be used for connections\nto the MySQL user account. The valid values are `mysql_native_password`\nor `caching_sha2_password`. If excluded when creating a new user, the\ndefault for the version of MySQL in use will be used. As of MySQL 8.0, the\ndefault is `caching_sha2_password`.\n"}}, "required": ["auth_plugin"]}}, "required": ["name"]}}, "maintenance_window": {"allOf": [{"type": ["object", "null"], "properties": {"day": {"type": "string", "description": "The day of the week on which to apply maintenance updates."}, "hour": {"type": "string", "description": "The hour in UTC at which maintenance updates will be applied in 24 hour format."}, "pending": {"type": "boolean", "description": "A boolean value indicating whether any maintenance is scheduled to be performed in the next window."}, "description": {"type": "array", "items": {"type": "string"}, "description": "A list of strings, each containing information about a pending maintenance update."}}, "required": ["day", "hour"]}, {}]}, "project_id": {"type": "string", "format": "uuid", "description": "The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project."}, "rules": {"type": "array", "items": {"type": "object", "properties": {"uuid": {"type": "string", "pattern": "^$|[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}", "description": "A unique ID for the firewall rule itself."}, "cluster_uuid": {"type": "string", "pattern": "^$|[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}", "description": "A unique ID for the database cluster to which the rule is applied."}, "type": {"type": "string", "enum": ["droplet", "k8s", "ip_addr", "tag", "app"], "description": "The type of resource that the firewall rule allows to access the database cluster."}, "value": {"type": "string", "description": "The ID of the specific resource, the name of a tag applied to a group of resources, or the IP address that the firewall rule allows to access the database cluster."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the firewall rule was created."}}, "required": ["type", "value"]}}, "version_end_of_life": {"type": "string", "description": "A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline."}, "version_end_of_availability": {"type": "string", "description": "A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline."}}, "required": ["name", "engine", "num_nodes", "size", "region"]}}, "required": ["database"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6dbd4e93-b7be-4af1-8717-d83a9e27c178/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
droplets_list_associatedResources
|
To list the associated billable resources that can be destroyed along with a
Droplet, send a GET request to the
/v2/droplets/$DROPLET_ID/destroy_with_associated_resources endpoint.
The response will be a JSON object containing snapshots, volumes, and
volume_snapshots keys. Each will be set to an array of objects containing
information about the associated resources.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6dbd4e93-b7be-4af1-8717-d83a9e27c178/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
droplets_list_associatedResources
|
To list the associated billable resources that can be destroyed along with a
Droplet, send a GET request to the
/v2/droplets/$DROPLET_ID/destroy_with_associated_resources endpoint.
The response will be a JSON object containing snapshots, volumes, and
volume_snapshots keys. Each will be set to an array of objects containing
information about the associated resources.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6dbd4e93-b7be-4af1-8717-d83a9e27c178/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
droplets_list_associatedResources
|
To list the associated billable resources that can be destroyed along with a
Droplet, send a GET request to the
/v2/droplets/$DROPLET_ID/destroy_with_associated_resources endpoint.
The response will be a JSON object containing snapshots, volumes, and
volume_snapshots keys. Each will be set to an array of objects containing
information about the associated resources.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6dbd4e93-b7be-4af1-8717-d83a9e27c178/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
droplets_list_associatedResources
|
To list the associated billable resources that can be destroyed along with a
Droplet, send a GET request to the
/v2/droplets/$DROPLET_ID/destroy_with_associated_resources endpoint.
The response will be a JSON object containing snapshots, volumes, and
volume_snapshots keys. Each will be set to an array of objects containing
information about the associated resources.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6dbd4e93-b7be-4af1-8717-d83a9e27c178/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
droplets_list_associatedResources
|
To list the associated billable resources that can be destroyed along with a
Droplet, send a GET request to the
/v2/droplets/$DROPLET_ID/destroy_with_associated_resources endpoint.
The response will be a JSON object containing snapshots, volumes, and
volume_snapshots keys. Each will be set to an array of objects containing
information about the associated resources.
| 200 | null |
{"reserved_ips": [{"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "cost": "0.05"}], "floating_ips": [{"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "cost": "0.05"}], "snapshots": [{"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "cost": "0.05"}], "volumes": [{"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "cost": "0.05"}], "volume_snapshots": [{"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "cost": "0.05"}]}
|
{"allOf": [{"type": "object", "properties": {"reserved_ips": {"type": "array", "items": {"type": "object", "description": "An objects containing information about a resource associated with a Droplet.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource associated with the Droplet."}, "name": {"type": "string", "description": "The name of the resource associated with the Droplet."}, "cost": {"type": "string", "description": "The cost of the resource in USD per month if the resource is retained after the Droplet is destroyed."}}}}, "floating_ips": {"type": "array", "items": {"type": "object", "description": "An objects containing information about a resource associated with a Droplet.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource associated with the Droplet."}, "name": {"type": "string", "description": "The name of the resource associated with the Droplet."}, "cost": {"type": "string", "description": "The cost of the resource in USD per month if the resource is retained after the Droplet is destroyed."}}}}, "snapshots": {"type": "array", "items": {"type": "object", "description": "An objects containing information about a resource associated with a Droplet.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource associated with the Droplet."}, "name": {"type": "string", "description": "The name of the resource associated with the Droplet."}, "cost": {"type": "string", "description": "The cost of the resource in USD per month if the resource is retained after the Droplet is destroyed."}}}}, "volumes": {"type": "array", "items": {"type": "object", "description": "An objects containing information about a resource associated with a Droplet.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource associated with the Droplet."}, "name": {"type": "string", "description": "The name of the resource associated with the Droplet."}, "cost": {"type": "string", "description": "The cost of the resource in USD per month if the resource is retained after the Droplet is destroyed."}}}}, "volume_snapshots": {"type": "array", "items": {"type": "object", "description": "An objects containing information about a resource associated with a Droplet.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource associated with the Droplet."}, "name": {"type": "string", "description": "The name of the resource associated with the Droplet."}, "cost": {"type": "string", "description": "The cost of the resource in USD per month if the resource is retained after the Droplet is destroyed."}}}}}}]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9937230f-9372-47b0-bbba-15cb76ca6127/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_list_alertPolicy
|
Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to /v2/monitoring/alerts.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9937230f-9372-47b0-bbba-15cb76ca6127/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_list_alertPolicy
|
Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to /v2/monitoring/alerts.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9937230f-9372-47b0-bbba-15cb76ca6127/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_list_alertPolicy
|
Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to /v2/monitoring/alerts.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9937230f-9372-47b0-bbba-15cb76ca6127/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_list_alertPolicy
|
Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to /v2/monitoring/alerts.
| 200 | null |
{"policies": [{"alerts": {"email": ["[email protected]"], "slack": [{"channel": "Production Alerts", "url": "https://hooks.slack.com/services/T1234567/AAAAAAAA/ZZZZZZ\""}]}, "compare": "GreaterThan", "description": "CPU Alert", "enabled": true, "entities": [192018292], "tags": ["production_droplets"], "type": "v1/insights/droplet/cpu", "uuid": "78b3da62-27e5-49ba-ac70-5db0b5935c64", "value": 80, "window": "5m"}], "links": {"first": "https//api.digitalocean.com/v2/monitoring/alerts?page=1&per_page=10", "prev": "https//api.digitalocean.com/v2/monitoring/alerts?page=2&per_page=10", "next": "https//api.digitalocean.com/v2/monitoring/alerts?page=4&per_page=10", "last": "https//api.digitalocean.com/v2/monitoring/alerts?page=5&per_page=10"}, "meta": {"total": 50}}
|
{"allOf": [{"type": "object", "required": ["policies"], "properties": {"policies": {"type": "array", "items": {"type": "object", "required": ["uuid", "type", "description", "compare", "value", "window", "entities", "tags", "alerts", "enabled"], "properties": {"alerts": {"type": "object", "required": ["slack", "email"], "properties": {"email": {"description": "An email to notify on an alert trigger.", "type": "array", "items": {"type": "string"}}, "slack": {"type": "array", "description": "Slack integration details.", "items": {"type": "object", "required": ["url", "channel"], "properties": {"channel": {"description": "**Omitted**"}, "url": {"description": "**Omitted**"}}}}}}, "compare": {"type": "string", "enum": ["GreaterThan", "LessThan"]}, "description": {"type": "string"}, "enabled": {"type": "boolean"}, "entities": {"type": "array", "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "string"}}, "type": {"type": "string", "enum": ["v1/insights/droplet/load_1", "v1/insights/droplet/load_5", "v1/insights/droplet/load_15", "v1/insights/droplet/memory_utilization_percent", "v1/insights/droplet/disk_utilization_percent", "v1/insights/droplet/cpu", "v1/insights/droplet/disk_read", "v1/insights/droplet/disk_write", "v1/insights/droplet/public_outbound_bandwidth", "v1/insights/droplet/public_inbound_bandwidth", "v1/insights/droplet/private_outbound_bandwidth", "v1/insights/droplet/private_inbound_bandwidth", "v1/insights/lbaas/avg_cpu_utilization_percent", "v1/insights/lbaas/connection_utilization_percent", "v1/insights/lbaas/droplet_health", "v1/insights/lbaas/tls_connections_per_second_utilization_percent", "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx", "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx", "v1/insights/lbaas/increase_in_http_error_rate_count_5xx", "v1/insights/lbaas/increase_in_http_error_rate_count_4xx", "v1/insights/lbaas/high_http_request_response_time", "v1/insights/lbaas/high_http_request_response_time_50p", "v1/insights/lbaas/high_http_request_response_time_95p", "v1/insights/lbaas/high_http_request_response_time_99p", "v1/dbaas/alerts/load_15_alerts", "v1/dbaas/alerts/memory_utilization_alerts", "v1/dbaas/alerts/disk_utilization_alerts", "v1/dbaas/alerts/cpu_alerts"]}, "uuid": {"type": "string"}, "value": {"type": "number", "format": "float", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38}, "window": {"type": "string", "enum": ["5m", "10m", "30m", "1h"]}}}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cc6a2867-1853-4a3b-8a2f-f49cc0b9deef/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_list_options
|
To list all of the options available for the offered database engines, send a GET request to /v2/databases/options.
The result will be a JSON object with an options key.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cc6a2867-1853-4a3b-8a2f-f49cc0b9deef/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_list_options
|
To list all of the options available for the offered database engines, send a GET request to /v2/databases/options.
The result will be a JSON object with an options key.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cc6a2867-1853-4a3b-8a2f-f49cc0b9deef/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_list_options
|
To list all of the options available for the offered database engines, send a GET request to /v2/databases/options.
The result will be a JSON object with an options key.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cc6a2867-1853-4a3b-8a2f-f49cc0b9deef/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_list_options
|
To list all of the options available for the offered database engines, send a GET request to /v2/databases/options.
The result will be a JSON object with an options key.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cc6a2867-1853-4a3b-8a2f-f49cc0b9deef/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_list_options
|
To list all of the options available for the offered database engines, send a GET request to /v2/databases/options.
The result will be a JSON object with an options key.
| 200 | null |
{"options": {"mongodb": {"regions": [], "versions": [], "layouts": [{"num_nodes": 1, "sizes": []}]}, "pg": {"regions": [], "versions": [], "layouts": [{"num_nodes": 1, "sizes": []}]}, "mysql": {"regions": [], "versions": [], "layouts": [{"num_nodes": 1, "sizes": []}]}, "redis": {"regions": [], "versions": [], "layouts": [{"num_nodes": 1, "sizes": []}]}}, "version_availability": {"pg": [{"end_of_life": "2023-11-09T00:00:00Z", "end_of_availability": "2023-05-09T00:00:00Z", "version": "8"}], "mysql": [{"end_of_life": "2023-11-09T00:00:00Z", "end_of_availability": "2023-05-09T00:00:00Z", "version": "8"}], "redis": [{"end_of_life": "2023-11-09T00:00:00Z", "end_of_availability": "2023-05-09T00:00:00Z", "version": "8"}], "mongodb": [{"end_of_life": "2023-11-09T00:00:00Z", "end_of_availability": "2023-05-09T00:00:00Z", "version": "8"}]}}
|
{"type": "object", "properties": {"options": {"type": "object", "properties": {"mongodb": {"allOf": [{"type": "object", "properties": {"regions": {"type": "array", "items": {"type": "string"}, "description": "An array of strings containing the names of available regions"}}}, {"type": "object", "properties": {"versions": {"type": "array", "items": {"type": "string"}, "description": "An array of strings containing the names of available regions"}}}, {"type": "object", "properties": {"layouts": {"type": "array", "description": "An array of objects, each indicating the node sizes (otherwise referred to as slugs) that are available with various numbers of nodes in the database cluster. Each slugs denotes the node's identifier, CPU, and RAM (in that order).", "items": {"type": "object", "properties": {"num_nodes": {"type": "integer"}, "sizes": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of objects containing the slugs available with various node counts"}}}}}}]}, "pg": {"allOf": [{"type": "object", "properties": {"regions": {"type": "array", "items": {"type": "string"}, "description": "An array of strings containing the names of available regions"}}}, {"type": "object", "properties": {"versions": {"type": "array", "items": {"type": "string"}, "description": "An array of strings containing the names of available regions"}}}, {"type": "object", "properties": {"layouts": {"type": "array", "description": "An array of objects, each indicating the node sizes (otherwise referred to as slugs) that are available with various numbers of nodes in the database cluster. Each slugs denotes the node's identifier, CPU, and RAM (in that order).", "items": {"type": "object", "properties": {"num_nodes": {"type": "integer"}, "sizes": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of objects containing the slugs available with various node counts"}}}}}}]}, "mysql": {"allOf": [{"type": "object", "properties": {"regions": {"type": "array", "items": {"type": "string"}, "description": "An array of strings containing the names of available regions"}}}, {"type": "object", "properties": {"versions": {"type": "array", "items": {"type": "string"}, "description": "An array of strings containing the names of available regions"}}}, {"type": "object", "properties": {"layouts": {"type": "array", "description": "An array of objects, each indicating the node sizes (otherwise referred to as slugs) that are available with various numbers of nodes in the database cluster. Each slugs denotes the node's identifier, CPU, and RAM (in that order).", "items": {"type": "object", "properties": {"num_nodes": {"type": "integer"}, "sizes": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of objects containing the slugs available with various node counts"}}}}}}]}, "redis": {"allOf": [{"type": "object", "properties": {"regions": {"type": "array", "items": {"type": "string"}, "description": "An array of strings containing the names of available regions"}}}, {"type": "object", "properties": {"versions": {"type": "array", "items": {"type": "string"}, "description": "An array of strings containing the names of available regions"}}}, {"type": "object", "properties": {"layouts": {"type": "array", "description": "An array of objects, each indicating the node sizes (otherwise referred to as slugs) that are available with various numbers of nodes in the database cluster. Each slugs denotes the node's identifier, CPU, and RAM (in that order).", "items": {"type": "object", "properties": {"num_nodes": {"type": "integer"}, "sizes": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of objects containing the slugs available with various node counts"}}}}}}]}}}, "version_availability": {"type": "object", "properties": {"pg": {"type": "array", "description": "An array of objects, each indicating the version end-of-life, end-of-availability for various database engines", "items": {"type": "object", "properties": {"end_of_life": {"type": "string", "description": "A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline."}, "end_of_availability": {"type": "string", "description": "A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline."}, "version": {"type": "string", "description": "The engine version."}}}}, "mysql": {"type": "array", "description": "An array of objects, each indicating the version end-of-life, end-of-availability for various database engines", "items": {"type": "object", "properties": {"end_of_life": {"type": "string", "description": "A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline."}, "end_of_availability": {"type": "string", "description": "A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline."}, "version": {"type": "string", "description": "The engine version."}}}}, "redis": {"type": "array", "description": "An array of objects, each indicating the version end-of-life, end-of-availability for various database engines", "items": {"type": "object", "properties": {"end_of_life": {"type": "string", "description": "A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline."}, "end_of_availability": {"type": "string", "description": "A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline."}, "version": {"type": "string", "description": "The engine version."}}}}, "mongodb": {"type": "array", "description": "An array of objects, each indicating the version end-of-life, end-of-availability for various database engines", "items": {"type": "object", "properties": {"end_of_life": {"type": "string", "description": "A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline."}, "end_of_availability": {"type": "string", "description": "A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline."}, "version": {"type": "string", "description": "The engine version."}}}}}}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/acb3b330-9468-40ae-a2a1-e7bf97ccca77/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad15Metrics
|
To retrieve 15 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_15.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/acb3b330-9468-40ae-a2a1-e7bf97ccca77/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad15Metrics
|
To retrieve 15 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_15.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/acb3b330-9468-40ae-a2a1-e7bf97ccca77/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad15Metrics
|
To retrieve 15 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_15.
| 200 | null |
{"data": {"result": [{"metric": {}, "values": []}], "resultType": "matrix"}, "status": "success"}
|
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "description": "An object containing the metric labels.", "additionalProperties": {"type": "string"}}, "values": {"type": "array", "items": {"type": "array", "items": {"oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}}}, "resultType": {"type": "string", "enum": ["matrix"]}}}, "status": {"type": "string", "enum": ["success", "error"]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/acb3b330-9468-40ae-a2a1-e7bf97ccca77/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad15Metrics
|
To retrieve 15 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_15.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/2914f0ee-b885-4c5f-9975-024b9762a053/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad1Metrics
|
To retrieve 1 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_1.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/2914f0ee-b885-4c5f-9975-024b9762a053/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad1Metrics
|
To retrieve 1 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_1.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/2914f0ee-b885-4c5f-9975-024b9762a053/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad1Metrics
|
To retrieve 1 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_1.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/2914f0ee-b885-4c5f-9975-024b9762a053/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletLoad1Metrics
|
To retrieve 1 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_1.
| 200 | null |
{"data": {"result": [{"metric": {}, "values": []}], "resultType": "matrix"}, "status": "success"}
|
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "description": "An object containing the metric labels.", "additionalProperties": {"type": "string"}}, "values": {"type": "array", "items": {"type": "array", "items": {"oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}}}, "resultType": {"type": "string", "enum": ["matrix"]}}}, "status": {"type": "string", "enum": ["success", "error"]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aeacb989-da7d-44fc-a742-c83a96cc3afa/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_get_default
|
To get your default project, send a GET request to /v2/projects/default.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aeacb989-da7d-44fc-a742-c83a96cc3afa/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_get_default
|
To get your default project, send a GET request to /v2/projects/default.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aeacb989-da7d-44fc-a742-c83a96cc3afa/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_get_default
|
To get your default project, send a GET request to /v2/projects/default.
| 200 | null |
{"project": {"id": "addb4547-6bab-419a-8542-76263a033cf6", "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7", "owner_id": 258992, "name": "Default", "description": "Default project", "purpose": "Just trying out DigitalOcean", "environment": "Development", "is_default": true, "created_at": "2017-10-19T21:44:20Z", "updated_at": "2019-11-05T18:50:03Z"}}
|
{"properties": {"project": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "The unique universal identifier of this project."}, "owner_uuid": {"type": "string", "description": "The unique universal identifier of the project owner."}, "owner_id": {"type": "integer", "description": "The integer id of the project owner."}, "name": {"type": "string", "maxLength": 175, "description": "The human-readable name for the project. The maximum length is 175 characters and the name must be unique."}, "description": {"type": "string", "maxLength": 255, "description": "The description of the project. The maximum length is 255 characters."}, "purpose": {"type": "string", "maxLength": 255, "description": "The purpose of the project. The maximum length is 255 characters. It can\nhave one of the following values:\n\n- Just trying out DigitalOcean\n- Class project / Educational purposes\n- Website or blog\n- Web Application\n- Service or API\n- Mobile Application\n- Machine learning / AI / Data processing\n- IoT\n- Operational / Developer tooling\n\nIf another value for purpose is specified, for example, \"your custom purpose\",\nyour purpose will be stored as `Other: your custom purpose`.\n"}, "environment": {"type": "string", "enum": ["Development", "Staging", "Production"], "description": "The environment of the project's resources."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was updated."}}}, {"type": "object", "properties": {"is_default": {"type": "boolean", "description": "If true, all resources will be added to this project if no project is specified."}}}]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aeacb989-da7d-44fc-a742-c83a96cc3afa/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_get_default
|
To get your default project, send a GET request to /v2/projects/default.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aeacb989-da7d-44fc-a742-c83a96cc3afa/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_get_default
|
To get your default project, send a GET request to /v2/projects/default.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fb76f600-28f7-4f9f-b7bc-fa3c7dafd15e/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_add_user
|
To add a new database user, send a POST request to /v2/databases/$DATABASE_ID/users
with the desired username.
Note: User management is not supported for Redis clusters.
When adding a user to a MySQL cluster, additional options can be configured in the
mysql_settings object.
The response will be a JSON object with a key called user. The value of this will be an
object that contains the standard attributes associated with a database user including
its randomly generated password.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fb76f600-28f7-4f9f-b7bc-fa3c7dafd15e/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_add_user
|
To add a new database user, send a POST request to /v2/databases/$DATABASE_ID/users
with the desired username.
Note: User management is not supported for Redis clusters.
When adding a user to a MySQL cluster, additional options can be configured in the
mysql_settings object.
The response will be a JSON object with a key called user. The value of this will be an
object that contains the standard attributes associated with a database user including
its randomly generated password.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fb76f600-28f7-4f9f-b7bc-fa3c7dafd15e/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_add_user
|
To add a new database user, send a POST request to /v2/databases/$DATABASE_ID/users
with the desired username.
Note: User management is not supported for Redis clusters.
When adding a user to a MySQL cluster, additional options can be configured in the
mysql_settings object.
The response will be a JSON object with a key called user. The value of this will be an
object that contains the standard attributes associated with a database user including
its randomly generated password.
| 201 | null |
{"user": {"name": "app-01", "role": "normal", "password": "jge5lfxtzhx42iff"}}
|
{"type": "object", "properties": {"user": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of a database user."}, "role": {"type": "string", "enum": ["primary", "normal"], "description": "A string representing the database user's role. The value will be either\n\"primary\" or \"normal\".\n"}, "password": {"type": "string", "description": "A randomly generated password for the database user."}, "mysql_settings": {"type": "object", "properties": {"auth_plugin": {"type": "string", "enum": ["mysql_native_password", "caching_sha2_password"], "description": "A string specifying the authentication method to be used for connections\nto the MySQL user account. The valid values are `mysql_native_password`\nor `caching_sha2_password`. If excluded when creating a new user, the\ndefault for the version of MySQL in use will be used. As of MySQL 8.0, the\ndefault is `caching_sha2_password`.\n"}}, "required": ["auth_plugin"]}}, "required": ["name"]}}, "required": ["user"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fb76f600-28f7-4f9f-b7bc-fa3c7dafd15e/2/1
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_add_user
|
To add a new database user, send a POST request to /v2/databases/$DATABASE_ID/users
with the desired username.
Note: User management is not supported for Redis clusters.
When adding a user to a MySQL cluster, additional options can be configured in the
mysql_settings object.
The response will be a JSON object with a key called user. The value of this will be an
object that contains the standard attributes associated with a database user including
its randomly generated password.
| 201 | null |
{"user": {"name": "app-02", "role": "normal", "password": "wv78n3zpz42xezdk", "mysql_settings": {"auth_plugin": "mysql_native_password"}}}
|
{"type": "object", "properties": {"user": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of a database user."}, "role": {"type": "string", "enum": ["primary", "normal"], "description": "A string representing the database user's role. The value will be either\n\"primary\" or \"normal\".\n"}, "password": {"type": "string", "description": "A randomly generated password for the database user."}, "mysql_settings": {"type": "object", "properties": {"auth_plugin": {"type": "string", "enum": ["mysql_native_password", "caching_sha2_password"], "description": "A string specifying the authentication method to be used for connections\nto the MySQL user account. The valid values are `mysql_native_password`\nor `caching_sha2_password`. If excluded when creating a new user, the\ndefault for the version of MySQL in use will be used. As of MySQL 8.0, the\ndefault is `caching_sha2_password`.\n"}}, "required": ["auth_plugin"]}}, "required": ["name"]}}, "required": ["user"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fb76f600-28f7-4f9f-b7bc-fa3c7dafd15e/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_add_user
|
To add a new database user, send a POST request to /v2/databases/$DATABASE_ID/users
with the desired username.
Note: User management is not supported for Redis clusters.
When adding a user to a MySQL cluster, additional options can be configured in the
mysql_settings object.
The response will be a JSON object with a key called user. The value of this will be an
object that contains the standard attributes associated with a database user including
its randomly generated password.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fb76f600-28f7-4f9f-b7bc-fa3c7dafd15e/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_add_user
|
To add a new database user, send a POST request to /v2/databases/$DATABASE_ID/users
with the desired username.
Note: User management is not supported for Redis clusters.
When adding a user to a MySQL cluster, additional options can be configured in the
mysql_settings object.
The response will be a JSON object with a key called user. The value of this will be an
object that contains the standard attributes associated with a database user including
its randomly generated password.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/56610317-73af-4d24-9a59-b28b699445d6/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_patch
|
To update only specific attributes of a project, send a PATCH request to /v2/projects/$PROJECT_ID. At least one of the following attributes needs to be sent.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/56610317-73af-4d24-9a59-b28b699445d6/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_patch
|
To update only specific attributes of a project, send a PATCH request to /v2/projects/$PROJECT_ID. At least one of the following attributes needs to be sent.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/56610317-73af-4d24-9a59-b28b699445d6/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_patch
|
To update only specific attributes of a project, send a PATCH request to /v2/projects/$PROJECT_ID. At least one of the following attributes needs to be sent.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/56610317-73af-4d24-9a59-b28b699445d6/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_patch
|
To update only specific attributes of a project, send a PATCH request to /v2/projects/$PROJECT_ID. At least one of the following attributes needs to be sent.
| 200 | null |
{"project": {"id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679", "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7", "owner_id": 258992, "name": "my-web-api", "description": "My website API", "purpose": "Service or API", "environment": "Development", "created_at": "2018-09-27T20:10:35Z", "updated_at": "2018-09-27T20:10:35Z", "is_default": true}}
|
{"properties": {"project": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "The unique universal identifier of this project."}, "owner_uuid": {"type": "string", "description": "The unique universal identifier of the project owner."}, "owner_id": {"type": "integer", "description": "The integer id of the project owner."}, "name": {"type": "string", "maxLength": 175, "description": "The human-readable name for the project. The maximum length is 175 characters and the name must be unique."}, "description": {"type": "string", "maxLength": 255, "description": "The description of the project. The maximum length is 255 characters."}, "purpose": {"type": "string", "maxLength": 255, "description": "The purpose of the project. The maximum length is 255 characters. It can\nhave one of the following values:\n\n- Just trying out DigitalOcean\n- Class project / Educational purposes\n- Website or blog\n- Web Application\n- Service or API\n- Mobile Application\n- Machine learning / AI / Data processing\n- IoT\n- Operational / Developer tooling\n\nIf another value for purpose is specified, for example, \"your custom purpose\",\nyour purpose will be stored as `Other: your custom purpose`.\n"}, "environment": {"type": "string", "enum": ["Development", "Staging", "Production"], "description": "The environment of the project's resources."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was updated."}}}, {"type": "object", "properties": {"is_default": {"type": "boolean", "description": "If true, all resources will be added to this project if no project is specified."}}}]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/56610317-73af-4d24-9a59-b28b699445d6/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_patch
|
To update only specific attributes of a project, send a PATCH request to /v2/projects/$PROJECT_ID. At least one of the following attributes needs to be sent.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e640ac0c-31b4-4aeb-acd3-dc45dfa8eb5f/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_delete_alertPolicy
|
To delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e640ac0c-31b4-4aeb-acd3-dc45dfa8eb5f/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_delete_alertPolicy
|
To delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e640ac0c-31b4-4aeb-acd3-dc45dfa8eb5f/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_delete_alertPolicy
|
To delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e640ac0c-31b4-4aeb-acd3-dc45dfa8eb5f/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_delete_alertPolicy
|
To delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/094943f2-9cf0-4f79-87a4-99caaf4e26b3/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_promote_replica
|
To promote a specific read-only replica, send a PUT request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote.
Note: Read-only replicas are not supported for Redis clusters.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/094943f2-9cf0-4f79-87a4-99caaf4e26b3/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_promote_replica
|
To promote a specific read-only replica, send a PUT request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote.
Note: Read-only replicas are not supported for Redis clusters.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/094943f2-9cf0-4f79-87a4-99caaf4e26b3/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_promote_replica
|
To promote a specific read-only replica, send a PUT request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote.
Note: Read-only replicas are not supported for Redis clusters.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/094943f2-9cf0-4f79-87a4-99caaf4e26b3/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_promote_replica
|
To promote a specific read-only replica, send a PUT request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote.
Note: Read-only replicas are not supported for Redis clusters.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/692b9a2f-a212-452d-abbf-5f62a10eae10/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_alertPolicy
|
To retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/692b9a2f-a212-452d-abbf-5f62a10eae10/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_alertPolicy
|
To retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/692b9a2f-a212-452d-abbf-5f62a10eae10/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_alertPolicy
|
To retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/692b9a2f-a212-452d-abbf-5f62a10eae10/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_alertPolicy
|
To retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/692b9a2f-a212-452d-abbf-5f62a10eae10/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_alertPolicy
|
To retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}
| 200 | null |
{"policy": {"alerts": {"email": [], "slack": []}, "compare": "GreaterThan", "description": "CPU Alert", "enabled": true, "entities": [], "tags": [], "type": "v1/insights/droplet/load_1", "uuid": "78b3da62-27e5-49ba-ac70-5db0b5935c64", "value": 80, "window": "5m"}}
|
{"properties": {"policy": {"type": "object", "required": ["uuid", "type", "description", "compare", "value", "window", "entities", "tags", "alerts", "enabled"], "properties": {"alerts": {"type": "object", "required": ["slack", "email"], "properties": {"email": {"description": "An email to notify on an alert trigger.", "type": "array", "items": {"type": "string"}}, "slack": {"type": "array", "description": "Slack integration details.", "items": {"type": "object", "required": ["url", "channel"], "properties": {"channel": {"description": "**Omitted**"}, "url": {"description": "**Omitted**"}}}}}}, "compare": {"type": "string", "enum": ["GreaterThan", "LessThan"]}, "description": {"type": "string"}, "enabled": {"type": "boolean"}, "entities": {"type": "array", "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "string"}}, "type": {"type": "string", "enum": ["v1/insights/droplet/load_1", "v1/insights/droplet/load_5", "v1/insights/droplet/load_15", "v1/insights/droplet/memory_utilization_percent", "v1/insights/droplet/disk_utilization_percent", "v1/insights/droplet/cpu", "v1/insights/droplet/disk_read", "v1/insights/droplet/disk_write", "v1/insights/droplet/public_outbound_bandwidth", "v1/insights/droplet/public_inbound_bandwidth", "v1/insights/droplet/private_outbound_bandwidth", "v1/insights/droplet/private_inbound_bandwidth", "v1/insights/lbaas/avg_cpu_utilization_percent", "v1/insights/lbaas/connection_utilization_percent", "v1/insights/lbaas/droplet_health", "v1/insights/lbaas/tls_connections_per_second_utilization_percent", "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx", "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx", "v1/insights/lbaas/increase_in_http_error_rate_count_5xx", "v1/insights/lbaas/increase_in_http_error_rate_count_4xx", "v1/insights/lbaas/high_http_request_response_time", "v1/insights/lbaas/high_http_request_response_time_50p", "v1/insights/lbaas/high_http_request_response_time_95p", "v1/insights/lbaas/high_http_request_response_time_99p", "v1/dbaas/alerts/load_15_alerts", "v1/dbaas/alerts/memory_utilization_alerts", "v1/dbaas/alerts/disk_utilization_alerts", "v1/dbaas/alerts/cpu_alerts"]}, "uuid": {"type": "string"}, "value": {"type": "number", "format": "float", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38}, "window": {"type": "string", "enum": ["5m", "10m", "30m", "1h"]}}}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f0b000da-e031-45e2-81e6-02e0aef14743/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_delete_onlineMigration
|
To stop an online migration, send a DELETE request to /v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f0b000da-e031-45e2-81e6-02e0aef14743/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_delete_onlineMigration
|
To stop an online migration, send a DELETE request to /v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f0b000da-e031-45e2-81e6-02e0aef14743/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_delete_onlineMigration
|
To stop an online migration, send a DELETE request to /v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f0b000da-e031-45e2-81e6-02e0aef14743/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_delete_onlineMigration
|
To stop an online migration, send a DELETE request to /v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/19da7b75-7426-46d5-b22e-6b5bd743e9b2/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletFilesystemSizeMetrics
|
To retrieve filesystem size metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem_size.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/19da7b75-7426-46d5-b22e-6b5bd743e9b2/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletFilesystemSizeMetrics
|
To retrieve filesystem size metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem_size.
| 200 | null |
{"status": "success", "data": {"resultType": "matrix", "result": [{"metric": {"device": "/dev/vda1", "fstype": "ext4", "host_id": "222651441", "mountpoint": "/"}, "values": [[1635386880, "25832407040"], [1635387000, "25832407040"], [1635387120, "25832407040"]]}]}}
|
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "description": "An object containing the metric labels.", "additionalProperties": {"type": "string"}}, "values": {"type": "array", "items": {"type": "array", "items": {"oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}}}, "resultType": {"type": "string", "enum": ["matrix"]}}}, "status": {"type": "string", "enum": ["success", "error"]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/19da7b75-7426-46d5-b22e-6b5bd743e9b2/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletFilesystemSizeMetrics
|
To retrieve filesystem size metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem_size.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/19da7b75-7426-46d5-b22e-6b5bd743e9b2/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_get_dropletFilesystemSizeMetrics
|
To retrieve filesystem size metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem_size.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7ba09794-2fc7-46b9-b1f5-75d3aa1b9b66/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_list
|
To list all your projects, send a GET request to /v2/projects.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7ba09794-2fc7-46b9-b1f5-75d3aa1b9b66/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_list
|
To list all your projects, send a GET request to /v2/projects.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7ba09794-2fc7-46b9-b1f5-75d3aa1b9b66/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_list
|
To list all your projects, send a GET request to /v2/projects.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7ba09794-2fc7-46b9-b1f5-75d3aa1b9b66/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_list
|
To list all your projects, send a GET request to /v2/projects.
| 200 | null |
{"projects": [{"id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679", "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7", "owner_id": 258992, "name": "my-web-api", "description": "My website API", "purpose": "Service or API", "environment": "Production", "is_default": false, "created_at": "2018-09-27T20:10:35Z", "updated_at": "2018-09-27T20:10:35Z"}, {"id": "addb4547-6bab-419a-8542-76263a033cf6", "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7", "owner_id": 258992, "name": "Default", "description": "Default project", "purpose": "Just trying out DigitalOcean", "environment": "Development", "is_default": true, "created_at": "2017-10-19T21:44:20Z", "updated_at": "2019-11-05T18:50:03Z"}], "links": {"pages": {"first": "https://api.digitalocean.com/v2/projects?page=1", "last": "https://api.digitalocean.com/v2/projects?page=1"}}, "meta": {"total": 2}}
|
{"allOf": [{"type": "object", "properties": {"projects": {"type": "array", "items": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "The unique universal identifier of this project."}, "owner_uuid": {"type": "string", "description": "The unique universal identifier of the project owner."}, "owner_id": {"type": "integer", "description": "The integer id of the project owner."}, "name": {"type": "string", "maxLength": 175, "description": "The human-readable name for the project. The maximum length is 175 characters and the name must be unique."}, "description": {"type": "string", "maxLength": 255, "description": "The description of the project. The maximum length is 255 characters."}, "purpose": {"type": "string", "maxLength": 255, "description": "The purpose of the project. The maximum length is 255 characters. It can\nhave one of the following values:\n\n- Just trying out DigitalOcean\n- Class project / Educational purposes\n- Website or blog\n- Web Application\n- Service or API\n- Mobile Application\n- Machine learning / AI / Data processing\n- IoT\n- Operational / Developer tooling\n\nIf another value for purpose is specified, for example, \"your custom purpose\",\nyour purpose will be stored as `Other: your custom purpose`.\n"}, "environment": {"type": "string", "enum": ["Development", "Staging", "Production"], "description": "The environment of the project's resources."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was updated."}}}, {"type": "object", "properties": {"is_default": {"type": "boolean", "description": "If true, all resources will be added to this project if no project is specified."}}}]}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1dc790a1-f065-4779-8501-b859035f4bed/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_reset_auth
|
To reset the password for a database user, send a POST request to
/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth.
For mysql databases, the authentication method can be specifying by
including a key in the JSON body called mysql_settings with the auth_plugin
value specified.
The response will be a JSON object with a user key. This will be set to an
object containing the standard database user attributes.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1dc790a1-f065-4779-8501-b859035f4bed/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_reset_auth
|
To reset the password for a database user, send a POST request to
/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth.
For mysql databases, the authentication method can be specifying by
including a key in the JSON body called mysql_settings with the auth_plugin
value specified.
The response will be a JSON object with a user key. This will be set to an
object containing the standard database user attributes.
| 200 | null |
{"user": {"name": "app-01", "role": "normal", "password": "jge5lfxtzhx42iff"}}
|
{"type": "object", "properties": {"user": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of a database user."}, "role": {"type": "string", "enum": ["primary", "normal"], "description": "A string representing the database user's role. The value will be either\n\"primary\" or \"normal\".\n"}, "password": {"type": "string", "description": "A randomly generated password for the database user."}, "mysql_settings": {"type": "object", "properties": {"auth_plugin": {"type": "string", "enum": ["mysql_native_password", "caching_sha2_password"], "description": "A string specifying the authentication method to be used for connections\nto the MySQL user account. The valid values are `mysql_native_password`\nor `caching_sha2_password`. If excluded when creating a new user, the\ndefault for the version of MySQL in use will be used. As of MySQL 8.0, the\ndefault is `caching_sha2_password`.\n"}}, "required": ["auth_plugin"]}}, "required": ["name"]}}, "required": ["user"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1dc790a1-f065-4779-8501-b859035f4bed/1/1
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_reset_auth
|
To reset the password for a database user, send a POST request to
/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth.
For mysql databases, the authentication method can be specifying by
including a key in the JSON body called mysql_settings with the auth_plugin
value specified.
The response will be a JSON object with a user key. This will be set to an
object containing the standard database user attributes.
| 200 | null |
{"user": {"name": "app-02", "role": "normal", "password": "wv78n3zpz42xezdk", "mysql_settings": {"auth_plugin": "mysql_native_password"}}}
|
{"type": "object", "properties": {"user": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of a database user."}, "role": {"type": "string", "enum": ["primary", "normal"], "description": "A string representing the database user's role. The value will be either\n\"primary\" or \"normal\".\n"}, "password": {"type": "string", "description": "A randomly generated password for the database user."}, "mysql_settings": {"type": "object", "properties": {"auth_plugin": {"type": "string", "enum": ["mysql_native_password", "caching_sha2_password"], "description": "A string specifying the authentication method to be used for connections\nto the MySQL user account. The valid values are `mysql_native_password`\nor `caching_sha2_password`. If excluded when creating a new user, the\ndefault for the version of MySQL in use will be used. As of MySQL 8.0, the\ndefault is `caching_sha2_password`.\n"}}, "required": ["auth_plugin"]}}, "required": ["name"]}}, "required": ["user"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1dc790a1-f065-4779-8501-b859035f4bed/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_reset_auth
|
To reset the password for a database user, send a POST request to
/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth.
For mysql databases, the authentication method can be specifying by
including a key in the JSON body called mysql_settings with the auth_plugin
value specified.
The response will be a JSON object with a user key. This will be set to an
object containing the standard database user attributes.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1dc790a1-f065-4779-8501-b859035f4bed/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_reset_auth
|
To reset the password for a database user, send a POST request to
/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth.
For mysql databases, the authentication method can be specifying by
including a key in the JSON body called mysql_settings with the auth_plugin
value specified.
The response will be a JSON object with a user key. This will be set to an
object containing the standard database user attributes.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1dc790a1-f065-4779-8501-b859035f4bed/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
databases_reset_auth
|
To reset the password for a database user, send a POST request to
/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth.
For mysql databases, the authentication method can be specifying by
including a key in the JSON body called mysql_settings with the auth_plugin
value specified.
The response will be a JSON object with a user key. This will be set to an
object containing the standard database user attributes.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/812f9efa-3662-4d1c-acbe-fb6dcd16cbc0/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_get
|
To get a project, send a GET request to /v2/projects/$PROJECT_ID.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/812f9efa-3662-4d1c-acbe-fb6dcd16cbc0/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_get
|
To get a project, send a GET request to /v2/projects/$PROJECT_ID.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/812f9efa-3662-4d1c-acbe-fb6dcd16cbc0/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_get
|
To get a project, send a GET request to /v2/projects/$PROJECT_ID.
| 200 | null |
{"project": {"id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679", "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7", "owner_id": 258992, "name": "my-web-api", "description": "My website API", "purpose": "Service or API", "environment": "Development", "created_at": "2018-09-27T20:10:35Z", "updated_at": "2018-09-27T20:10:35Z", "is_default": true}}
|
{"properties": {"project": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "The unique universal identifier of this project."}, "owner_uuid": {"type": "string", "description": "The unique universal identifier of the project owner."}, "owner_id": {"type": "integer", "description": "The integer id of the project owner."}, "name": {"type": "string", "maxLength": 175, "description": "The human-readable name for the project. The maximum length is 175 characters and the name must be unique."}, "description": {"type": "string", "maxLength": 255, "description": "The description of the project. The maximum length is 255 characters."}, "purpose": {"type": "string", "maxLength": 255, "description": "The purpose of the project. The maximum length is 255 characters. It can\nhave one of the following values:\n\n- Just trying out DigitalOcean\n- Class project / Educational purposes\n- Website or blog\n- Web Application\n- Service or API\n- Mobile Application\n- Machine learning / AI / Data processing\n- IoT\n- Operational / Developer tooling\n\nIf another value for purpose is specified, for example, \"your custom purpose\",\nyour purpose will be stored as `Other: your custom purpose`.\n"}, "environment": {"type": "string", "enum": ["Development", "Staging", "Production"], "description": "The environment of the project's resources."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was updated."}}}, {"type": "object", "properties": {"is_default": {"type": "boolean", "description": "If true, all resources will be added to this project if no project is specified."}}}]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/812f9efa-3662-4d1c-acbe-fb6dcd16cbc0/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_get
|
To get a project, send a GET request to /v2/projects/$PROJECT_ID.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.