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,...
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,...
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,...
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,...
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,...
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,...
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_timeo...
{"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": {"des...
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,...
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,...
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,...
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,...
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,...
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 dat...
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,...
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,...
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,...
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,...
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", "desc...
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,...
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,...
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", "desc...
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,...
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 inf...
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,...
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 inf...
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,...
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 inf...
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,...
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 inf...
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,...
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 inf...
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": ...
{"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 cluste...
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 contai...
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,...
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 contai...
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,...
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 contai...
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,...
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 contai...
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,...
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 contai...
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"}], "vol...
{"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 Dr...
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,...
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,...
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,...
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": ["bob@example.com"], "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/insight...
{"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"],...
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,...
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,...
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,...
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,...
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"...
{"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"...
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,...
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,...
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", "desc...
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,...
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,...
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,...
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,...
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", "desc...
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,...
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,...
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",...
{"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",...
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,...
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,...
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 ke...
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,...
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 ke...
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,...
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 ke...
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 \"norm...
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 ke...
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 \"norm...
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 ke...
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,...
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 ke...
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,...
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,...
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,...
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,...
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...
{"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",...
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,...
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,...
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,...
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,...
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,...
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,...
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,...
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,...
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,...
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,...
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,...
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,...
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,...
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.", ...
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,...
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,...
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,...
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,...
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,...
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", "desc...
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,...
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,...
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,...
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,...
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,...
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_...
{"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...
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 wit...
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,...
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 wit...
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 \"norm...
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 wit...
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 \"norm...
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 wit...
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,...
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 wit...
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,...
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 wit...
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,...
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,...
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,...
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...
{"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",...
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,...