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/812f9efa-3662-4d1c-acbe-fb6dcd16cbc0/4/0
Digital Ocean
Digital Ocean Public API
null
projects_get
To get a project, send a GET request to /v2/projects/$PROJECT_ID.
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/5730a3bd-35ca-467f-9ef6-8d661538d065/0/0
Digital Ocean
Digital Ocean Public API
null
projects_create
To create a project, send a POST request to /v2/projects.
201
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/5730a3bd-35ca-467f-9ef6-8d661538d065/1/0
Digital Ocean
Digital Ocean Public API
null
projects_create
To create a project, send a POST 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/5730a3bd-35ca-467f-9ef6-8d661538d065/2/0
Digital Ocean
Digital Ocean Public API
null
projects_create
To create a project, send a POST 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/5730a3bd-35ca-467f-9ef6-8d661538d065/3/0
Digital Ocean
Digital Ocean Public API
null
projects_create
To create a project, send a POST 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/c81dbc08-93ee-42cb-8bee-e2e270f44f2d/0/0
Digital Ocean
Digital Ocean Public API
null
databases_update_region
To migrate a database cluster to a new region, send a PUT request to /v2/databases/$DATABASE_ID/migrate. The body of the request must specify a region attribute. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will ...
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/c81dbc08-93ee-42cb-8bee-e2e270f44f2d/1/0
Digital Ocean
Digital Ocean Public API
null
databases_update_region
To migrate a database cluster to a new region, send a PUT request to /v2/databases/$DATABASE_ID/migrate. The body of the request must specify a region attribute. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will ...
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/c81dbc08-93ee-42cb-8bee-e2e270f44f2d/3/0
Digital Ocean
Digital Ocean Public API
null
databases_update_region
To migrate a database cluster to a new region, send a PUT request to /v2/databases/$DATABASE_ID/migrate. The body of the request must specify a region attribute. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will ...
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/c81dbc08-93ee-42cb-8bee-e2e270f44f2d/4/0
Digital Ocean
Digital Ocean Public API
null
databases_update_region
To migrate a database cluster to a new region, send a PUT request to /v2/databases/$DATABASE_ID/migrate. The body of the request must specify a region attribute. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will ...
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/5897b950-fb22-4b03-92ee-2f157b6af67a/0/0
Digital Ocean
Digital Ocean Public API
null
databases_get_migrationStatus
To retrieve the status of the most recent online migration, send a GET request to /v2/databases/$DATABASE_ID/online-migration.
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/5897b950-fb22-4b03-92ee-2f157b6af67a/1/0
Digital Ocean
Digital Ocean Public API
null
databases_get_migrationStatus
To retrieve the status of the most recent online migration, send a GET request to /v2/databases/$DATABASE_ID/online-migration.
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/5897b950-fb22-4b03-92ee-2f157b6af67a/2/0
Digital Ocean
Digital Ocean Public API
null
databases_get_migrationStatus
To retrieve the status of the most recent online migration, send a GET request to /v2/databases/$DATABASE_ID/online-migration.
200
null
{"id": "77b28fc8-19ff-11eb-8c9c-c68e24557488", "status": "running", "created_at": "2020-10-29T15:57:38Z"}
{"type": "object", "properties": {"id": {"type": "string", "description": "The ID of the most recent migration."}, "status": {"type": "string", "description": "The current status of the migration.", "enum": ["running", "canceled", "error", "done"]}, "created_at": {"type": "string", "description": "The time the migratio...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5897b950-fb22-4b03-92ee-2f157b6af67a/3/0
Digital Ocean
Digital Ocean Public API
null
databases_get_migrationStatus
To retrieve the status of the most recent online migration, send a GET request to /v2/databases/$DATABASE_ID/online-migration.
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/5897b950-fb22-4b03-92ee-2f157b6af67a/4/0
Digital Ocean
Digital Ocean Public API
null
databases_get_migrationStatus
To retrieve the status of the most recent online migration, send a GET request to /v2/databases/$DATABASE_ID/online-migration.
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/afb5893b-cc57-46bb-a0c1-2eb95db03712/0/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryTotalMetrics
To retrieve total memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_total.
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/afb5893b-cc57-46bb-a0c1-2eb95db03712/1/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryTotalMetrics
To retrieve total memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_total.
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/afb5893b-cc57-46bb-a0c1-2eb95db03712/2/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryTotalMetrics
To retrieve total memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_total.
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/afb5893b-cc57-46bb-a0c1-2eb95db03712/3/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryTotalMetrics
To retrieve total memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_total.
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/a5cc0b36-fe0a-4e23-a443-0aa339241576/0/0
Digital Ocean
Digital Ocean Public API
null
balance_get
To retrieve the balances on a customer's account, send a GET request to /v2/customers/my/balance.
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/a5cc0b36-fe0a-4e23-a443-0aa339241576/1/0
Digital Ocean
Digital Ocean Public API
null
balance_get
To retrieve the balances on a customer's account, send a GET request to /v2/customers/my/balance.
200
null
{"month_to_date_balance": "23.44", "account_balance": "12.23", "month_to_date_usage": "11.21", "generated_at": "2019-07-09T15:01:12Z"}
{"type": "object", "properties": {"month_to_date_balance": {"type": "string", "description": "Balance as of the `generated_at` time. This value includes the `account_balance` and `month_to_date_usage`."}, "account_balance": {"type": "string", "description": "Current balance of the customer's most recent billing activi...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a5cc0b36-fe0a-4e23-a443-0aa339241576/2/0
Digital Ocean
Digital Ocean Public API
null
balance_get
To retrieve the balances on a customer's account, send a GET request to /v2/customers/my/balance.
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/a5cc0b36-fe0a-4e23-a443-0aa339241576/3/0
Digital Ocean
Digital Ocean Public API
null
balance_get
To retrieve the balances on a customer's account, send a GET request to /v2/customers/my/balance.
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/a5cc0b36-fe0a-4e23-a443-0aa339241576/4/0
Digital Ocean
Digital Ocean Public API
null
balance_get
To retrieve the balances on a customer's account, send a GET request to /v2/customers/my/balance.
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/12f4c6ac-4694-4796-888d-d3035e7b109c/0/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryCachedMetrics
To retrieve cached memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_cached.
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/12f4c6ac-4694-4796-888d-d3035e7b109c/1/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryCachedMetrics
To retrieve cached memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_cached.
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/12f4c6ac-4694-4796-888d-d3035e7b109c/2/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryCachedMetrics
To retrieve cached memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_cached.
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/12f4c6ac-4694-4796-888d-d3035e7b109c/3/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryCachedMetrics
To retrieve cached memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_cached.
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/9ba83a77-d42a-4c49-afca-1d7c82335036/0/0
Digital Ocean
Digital Ocean Public API
null
monitoring_create_alertPolicy
To create a new alert, send a POST 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/9ba83a77-d42a-4c49-afca-1d7c82335036/1/0
Digital Ocean
Digital Ocean Public API
null
monitoring_create_alertPolicy
To create a new alert, send a POST 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/9ba83a77-d42a-4c49-afca-1d7c82335036/2/0
Digital Ocean
Digital Ocean Public API
null
monitoring_create_alertPolicy
To create a new alert, send a POST 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/9ba83a77-d42a-4c49-afca-1d7c82335036/3/0
Digital Ocean
Digital Ocean Public API
null
monitoring_create_alertPolicy
To create a new alert, send a POST request to /v2/monitoring/alerts.
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/dc22da0e-707c-435c-95d1-ec247b51585b/0/0
Digital Ocean
Digital Ocean Public API
null
databases_update_evictionPolicy
To configure an eviction policy for an existing Redis cluster, send a PUT request to /v2/databases/$DATABASE_ID/eviction_policy specifying the desired 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/dc22da0e-707c-435c-95d1-ec247b51585b/1/0
Digital Ocean
Digital Ocean Public API
null
databases_update_evictionPolicy
To configure an eviction policy for an existing Redis cluster, send a PUT request to /v2/databases/$DATABASE_ID/eviction_policy specifying the desired 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/dc22da0e-707c-435c-95d1-ec247b51585b/3/0
Digital Ocean
Digital Ocean Public API
null
databases_update_evictionPolicy
To configure an eviction policy for an existing Redis cluster, send a PUT request to /v2/databases/$DATABASE_ID/eviction_policy specifying the desired 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/dc22da0e-707c-435c-95d1-ec247b51585b/4/0
Digital Ocean
Digital Ocean Public API
null
databases_update_evictionPolicy
To configure an eviction policy for an existing Redis cluster, send a PUT request to /v2/databases/$DATABASE_ID/eviction_policy specifying the desired 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/8ec4ce72-6088-4aac-9892-44e845d8939e/0/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_DropletCpuMetrics
To retrieve CPU metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/cpu.
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/8ec4ce72-6088-4aac-9892-44e845d8939e/1/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_DropletCpuMetrics
To retrieve CPU metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/cpu.
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/8ec4ce72-6088-4aac-9892-44e845d8939e/2/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_DropletCpuMetrics
To retrieve CPU metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/cpu.
200
null
{"status": "success", "data": {"resultType": "matrix", "result": [{"metric": {"host_id": "222651441", "mode": "idle"}, "values": [[1635386880, "122901.18"], [1635387000, "123020.92"], [1635387120, "123140.8"]]}, {"metric": {"host_id": "222651441", "mode": "iowait"}, "values": [[1635386880, "14.99"], [1635387000, "15.01...
{"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/8ec4ce72-6088-4aac-9892-44e845d8939e/3/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_DropletCpuMetrics
To retrieve CPU metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/cpu.
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/7f26340e-7478-426d-9015-916882d86265/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_nodePools
To list all of the node pools in a Kubernetes clusters, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools.
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/7f26340e-7478-426d-9015-916882d86265/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_nodePools
To list all of the node pools in a Kubernetes clusters, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools.
200
null
{"node_pools": []}
{"properties": {"node_pools": {"type": "array", "items": {"type": "object", "allOf": [{"type": "object", "properties": {"size": {"description": "**Omitted**"}}}, {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "count": {"description": "**Omitted**"}, "tags...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7f26340e-7478-426d-9015-916882d86265/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_nodePools
To list all of the node pools in a Kubernetes clusters, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools.
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/7f26340e-7478-426d-9015-916882d86265/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_nodePools
To list all of the node pools in a Kubernetes clusters, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools.
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/7f26340e-7478-426d-9015-916882d86265/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_nodePools
To list all of the node pools in a Kubernetes clusters, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools.
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/9c2faf7b-05df-420f-8de0-57b6cd5c5c71/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_remove_registry
To remove the container registry from Kubernetes clusters, send a DELETE request to /v2/kubernetes/registry.
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/9c2faf7b-05df-420f-8de0-57b6cd5c5c71/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_remove_registry
To remove the container registry from Kubernetes clusters, send a DELETE request to /v2/kubernetes/registry.
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/9c2faf7b-05df-420f-8de0-57b6cd5c5c71/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_remove_registry
To remove the container registry from Kubernetes clusters, send a DELETE request to /v2/kubernetes/registry.
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/e074b1c9-a2ff-4dc6-aef8-b2ba66bcb84e/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_delete_cluster
To delete a Kubernetes cluster and all services deployed to it, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID. A 204 status code with no body will be returned in response to a successful request.
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/e074b1c9-a2ff-4dc6-aef8-b2ba66bcb84e/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_delete_cluster
To delete a Kubernetes cluster and all services deployed to it, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID. A 204 status code with no body will be returned in response to a successful request.
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/e074b1c9-a2ff-4dc6-aef8-b2ba66bcb84e/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_delete_cluster
To delete a Kubernetes cluster and all services deployed to it, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID. A 204 status code with no body will be returned in response to a successful request.
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/e074b1c9-a2ff-4dc6-aef8-b2ba66bcb84e/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_delete_cluster
To delete a Kubernetes cluster and all services deployed to it, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID. A 204 status code with no body will be returned in response to a successful request.
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/3a3dfb48-4a46-4c85-9368-b1d7815ebf8d/0/0
Digital Ocean
Digital Ocean Public API
null
domains_get
To get details about a specific domain, send a GET request to /v2/domains/$DOMAIN_NAME.
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/3a3dfb48-4a46-4c85-9368-b1d7815ebf8d/1/0
Digital Ocean
Digital Ocean Public API
null
domains_get
To get details about a specific domain, send a GET request to /v2/domains/$DOMAIN_NAME.
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/3a3dfb48-4a46-4c85-9368-b1d7815ebf8d/2/0
Digital Ocean
Digital Ocean Public API
null
domains_get
To get details about a specific domain, send a GET request to /v2/domains/$DOMAIN_NAME.
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/3a3dfb48-4a46-4c85-9368-b1d7815ebf8d/3/0
Digital Ocean
Digital Ocean Public API
null
domains_get
To get details about a specific domain, send a GET request to /v2/domains/$DOMAIN_NAME.
200
null
{"domain": {"name": "example.com", "ttl": 1800, "zone_file": "$ORIGIN example.com.\n$TTL 1800\nexample.com. IN SOA ns1.digitalocean.com. hostmaster.example.com. 1415982611 10800 3600 604800 1800\nexample.com. 1800 IN NS ns1.digitalocean.com.\nexample.com. 1800 IN NS ns2.digitalocean.com.\nexample.com. 1800 IN NS ns3.di...
{"properties": {"domain": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, `example.com` is a valid domain name."}, "ip_address": {"type": "string", "description": "This optional attribu...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3a3dfb48-4a46-4c85-9368-b1d7815ebf8d/4/0
Digital Ocean
Digital Ocean Public API
null
domains_get
To get details about a specific domain, send a GET request to /v2/domains/$DOMAIN_NAME.
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/84eeb798-202e-434a-85bd-fee3cfc4f840/0/0
Digital Ocean
Digital Ocean Public API
null
vpcs_list_members
To list all of the resources that are members of a VPC, send a GET request to /v2/vpcs/$VPC_ID/members. To only list resources of a specific type that are members of the VPC, included a resource_type query parameter. For example, to only list Droplets in the VPC, send a GET request to /v2/vpcs/$VPC_ID/members?resource_...
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/84eeb798-202e-434a-85bd-fee3cfc4f840/1/0
Digital Ocean
Digital Ocean Public API
null
vpcs_list_members
To list all of the resources that are members of a VPC, send a GET request to /v2/vpcs/$VPC_ID/members. To only list resources of a specific type that are members of the VPC, included a resource_type query parameter. For example, to only list Droplets in the VPC, send a GET request to /v2/vpcs/$VPC_ID/members?resource_...
200
null
{"members": [{"urn": "do:loadbalancer:fb294d78-d193-4cb2-8737-ea620993591b", "name": "nyc1-load-balancer-01", "created_at": "2020-03-13T19:30:48Z"}, {"urn": "do:dbaas:13f7a2f6-43df-4c4a-8129-8733267ddeea", "name": "db-postgresql-nyc1-55986", "created_at": "2020-03-13T19:30:18Z"}, {"urn": "do:kubernetes:da39d893-96e1-4e...
{"allOf": [{"type": "object", "properties": {"members": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the resource."}, "urn": {"type": "string", "pattern": "^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*", "descript...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/84eeb798-202e-434a-85bd-fee3cfc4f840/2/0
Digital Ocean
Digital Ocean Public API
null
vpcs_list_members
To list all of the resources that are members of a VPC, send a GET request to /v2/vpcs/$VPC_ID/members. To only list resources of a specific type that are members of the VPC, included a resource_type query parameter. For example, to only list Droplets in the VPC, send a GET request to /v2/vpcs/$VPC_ID/members?resource_...
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/84eeb798-202e-434a-85bd-fee3cfc4f840/3/0
Digital Ocean
Digital Ocean Public API
null
vpcs_list_members
To list all of the resources that are members of a VPC, send a GET request to /v2/vpcs/$VPC_ID/members. To only list resources of a specific type that are members of the VPC, included a resource_type query parameter. For example, to only list Droplets in the VPC, send a GET request to /v2/vpcs/$VPC_ID/members?resource_...
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/84eeb798-202e-434a-85bd-fee3cfc4f840/4/0
Digital Ocean
Digital Ocean Public API
null
vpcs_list_members
To list all of the resources that are members of a VPC, send a GET request to /v2/vpcs/$VPC_ID/members. To only list resources of a specific type that are members of the VPC, included a resource_type query parameter. For example, to only list Droplets in the VPC, send a GET request to /v2/vpcs/$VPC_ID/members?resource_...
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/1fdf4e85-0392-4ad3-a0be-7183dbc8cf55/0/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_post
To initiate an action on a floating IP send a POST request to /v2/floating_ips/$FLOATING_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types: | Action | Details |------------|-------- | assign | Assigns a floating IP to a Droplet | unassign | Unassign a floating...
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/1fdf4e85-0392-4ad3-a0be-7183dbc8cf55/1/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_post
To initiate an action on a floating IP send a POST request to /v2/floating_ips/$FLOATING_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types: | Action | Details |------------|-------- | assign | Assigns a floating IP to a Droplet | unassign | Unassign a floating...
201
null
{"action": {"id": 72531856, "status": "completed", "type": "assign_ip", "started_at": "2015-11-12T17:51:03Z", "completed_at": "2015-11-12T17:51:14Z", "resource_id": 758604968, "resource_type": "floating_ip", "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu...
{"properties": {"action": {"allOf": [{"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This can be \"in-progress\", \"completed\", or \"er...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1fdf4e85-0392-4ad3-a0be-7183dbc8cf55/2/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_post
To initiate an action on a floating IP send a POST request to /v2/floating_ips/$FLOATING_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types: | Action | Details |------------|-------- | assign | Assigns a floating IP to a Droplet | unassign | Unassign a floating...
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/1fdf4e85-0392-4ad3-a0be-7183dbc8cf55/3/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_post
To initiate an action on a floating IP send a POST request to /v2/floating_ips/$FLOATING_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types: | Action | Details |------------|-------- | assign | Assigns a floating IP to a Droplet | unassign | Unassign a floating...
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/1fdf4e85-0392-4ad3-a0be-7183dbc8cf55/4/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_post
To initiate an action on a floating IP send a POST request to /v2/floating_ips/$FLOATING_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types: | Action | Details |------------|-------- | assign | Assigns a floating IP to a Droplet | unassign | Unassign a floating...
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/c83e8c03-bf79-4a8c-843b-6f70c634aef5/0/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_get
To retrieve the status of a floating IP action, send a GET request to /v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID.
200
null
{"action": {"id": 72531856, "status": "completed", "type": "assign_ip", "started_at": "2015-11-12T17:51:03Z", "completed_at": "2015-11-12T17:51:14Z", "resource_id": 758604968, "resource_type": "floating_ip", "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu...
{"properties": {"action": {"allOf": [{"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This can be \"in-progress\", \"completed\", or \"er...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c83e8c03-bf79-4a8c-843b-6f70c634aef5/1/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_get
To retrieve the status of a floating IP action, send a GET request to /v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID.
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/c83e8c03-bf79-4a8c-843b-6f70c634aef5/2/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_get
To retrieve the status of a floating IP action, send a GET request to /v2/floating_ips/$FLOATING_IP/actions/$ACTION_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/c83e8c03-bf79-4a8c-843b-6f70c634aef5/3/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_get
To retrieve the status of a floating IP action, send a GET request to /v2/floating_ips/$FLOATING_IP/actions/$ACTION_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/c83e8c03-bf79-4a8c-843b-6f70c634aef5/4/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_get
To retrieve the status of a floating IP action, send a GET request to /v2/floating_ips/$FLOATING_IP/actions/$ACTION_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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1dfd3ada-4fe6-4435-bfec-43c9db861398/0/0
Digital Ocean
Digital Ocean Public API
null
imageActions_post
The following actions are available on an Image. Convert an Image to a Snapshot To convert an image, for example, a backup to a snapshot, send a POST request to /v2/images/$IMAGE_ID/actions. Set the type attribute to convert. Transfer an Image To transfer an image to another region, send a POST request to /v2/images/$I...
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/1dfd3ada-4fe6-4435-bfec-43c9db861398/1/0
Digital Ocean
Digital Ocean Public API
null
imageActions_post
The following actions are available on an Image. Convert an Image to a Snapshot To convert an image, for example, a backup to a snapshot, send a POST request to /v2/images/$IMAGE_ID/actions. Set the type attribute to convert. Transfer an Image To transfer an image to another region, send a POST request to /v2/images/$I...
201
null
{"id": 36804636, "status": "in-progress", "type": "create", "started_at": "2020-11-14T16:29:21Z", "completed_at": "2020-11-14T16:30:06Z", "resource_id": 3164444, "resource_type": "droplet", "region": {}, "region_slug": "nyc3"}
{"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This can be \"in-progress\", \"completed\", or \"errored\".", "enum": ["in-progress", "c...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1dfd3ada-4fe6-4435-bfec-43c9db861398/2/0
Digital Ocean
Digital Ocean Public API
null
imageActions_post
The following actions are available on an Image. Convert an Image to a Snapshot To convert an image, for example, a backup to a snapshot, send a POST request to /v2/images/$IMAGE_ID/actions. Set the type attribute to convert. Transfer an Image To transfer an image to another region, send a POST request to /v2/images/$I...
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/1dfd3ada-4fe6-4435-bfec-43c9db861398/3/0
Digital Ocean
Digital Ocean Public API
null
imageActions_post
The following actions are available on an Image. Convert an Image to a Snapshot To convert an image, for example, a backup to a snapshot, send a POST request to /v2/images/$IMAGE_ID/actions. Set the type attribute to convert. Transfer an Image To transfer an image to another region, send a POST request to /v2/images/$I...
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/1dfd3ada-4fe6-4435-bfec-43c9db861398/4/0
Digital Ocean
Digital Ocean Public API
null
imageActions_post
The following actions are available on an Image. Convert an Image to a Snapshot To convert an image, for example, a backup to a snapshot, send a POST request to /v2/images/$IMAGE_ID/actions. Set the type attribute to convert. Transfer an Image To transfer an image to another region, send a POST request to /v2/images/$I...
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/932eb266-d609-4437-bbb5-28872d80ecf4/0/0
Digital Ocean
Digital Ocean Public API
null
imageActions_get
To retrieve the status of an image action, send a GET request to /v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_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/932eb266-d609-4437-bbb5-28872d80ecf4/1/0
Digital Ocean
Digital Ocean Public API
null
imageActions_get
To retrieve the status of an image action, send a GET request to /v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID.
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/932eb266-d609-4437-bbb5-28872d80ecf4/2/0
Digital Ocean
Digital Ocean Public API
null
imageActions_get
To retrieve the status of an image action, send a GET request to /v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID.
200
null
{"id": 36804636, "status": "in-progress", "type": "create", "started_at": "2020-11-14T16:29:21Z", "completed_at": "2020-11-14T16:30:06Z", "resource_id": 3164444, "resource_type": "droplet", "region": {}, "region_slug": "nyc3"}
{"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This can be \"in-progress\", \"completed\", or \"errored\".", "enum": ["in-progress", "c...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/932eb266-d609-4437-bbb5-28872d80ecf4/3/0
Digital Ocean
Digital Ocean Public API
null
imageActions_get
To retrieve the status of an image action, send a GET request to /v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_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/932eb266-d609-4437-bbb5-28872d80ecf4/4/0
Digital Ocean
Digital Ocean Public API
null
imageActions_get
To retrieve the status of an image action, send a GET request to /v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/178518f0-f576-4d25-b61e-eab972472680/0/0
Digital Ocean
Digital Ocean Public API
null
imageActions_list
To retrieve all actions that have been executed on an image, send a GET request to /v2/images/$IMAGE_ID/actions.
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/178518f0-f576-4d25-b61e-eab972472680/1/0
Digital Ocean
Digital Ocean Public API
null
imageActions_list
To retrieve all actions that have been executed on an image, send a GET request to /v2/images/$IMAGE_ID/actions.
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/178518f0-f576-4d25-b61e-eab972472680/2/0
Digital Ocean
Digital Ocean Public API
null
imageActions_list
To retrieve all actions that have been executed on an image, send a GET request to /v2/images/$IMAGE_ID/actions.
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/178518f0-f576-4d25-b61e-eab972472680/3/0
Digital Ocean
Digital Ocean Public API
null
imageActions_list
To retrieve all actions that have been executed on an image, send a GET request to /v2/images/$IMAGE_ID/actions.
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/178518f0-f576-4d25-b61e-eab972472680/4/0
Digital Ocean
Digital Ocean Public API
null
imageActions_list
To retrieve all actions that have been executed on an image, send a GET request to /v2/images/$IMAGE_ID/actions.
200
null
{"actions": [{"id": 36804636, "status": "in-progress", "type": "create", "started_at": "2020-11-14T16:29:21Z", "completed_at": "2020-11-14T16:30:06Z", "resource_id": 3164444, "resource_type": "droplet", "region": {}, "region_slug": "nyc3"}], "links": {"pages": {"last": "https://api.digitalocean.com/v2/images?page=2", "...
{"allOf": [{"type": "object", "properties": {"actions": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/91639d66-d37a-4e34-82b9-fd7328028060/0/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_list
To retrieve all actions that have been executed on a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP/actions.
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/91639d66-d37a-4e34-82b9-fd7328028060/1/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_list
To retrieve all actions that have been executed on a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP/actions.
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/91639d66-d37a-4e34-82b9-fd7328028060/2/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_list
To retrieve all actions that have been executed on a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP/actions.
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/91639d66-d37a-4e34-82b9-fd7328028060/3/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_list
To retrieve all actions that have been executed on a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP/actions.
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/91639d66-d37a-4e34-82b9-fd7328028060/4/0
Digital Ocean
Digital Ocean Public API
null
floatingIPsAction_list
To retrieve all actions that have been executed on a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP/actions.
200
null
{"actions": [{"id": 72531856, "status": "completed", "type": "reserve_ip", "started_at": "2015-11-21T21:51:09Z", "completed_at": "2015-11-21T21:51:09Z", "resource_id": 758604197, "resource_type": "floating_ip", "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2v...
{"allOf": [{"type": "object", "properties": {"actions": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/62bcdae7-03e6-44cf-8fcf-2ee75630498a/0/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_create
To create a new load balancer instance, send a POST request to /v2/load_balancers. You can specify the Droplets that will sit behind the load balancer using one of two methods: Set droplet_ids to a list of specific Droplet IDs. Set tag to the name of a tag. All Droplets with this tag applied will be assigned to the ...
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/62bcdae7-03e6-44cf-8fcf-2ee75630498a/1/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_create
To create a new load balancer instance, send a POST request to /v2/load_balancers. You can specify the Droplets that will sit behind the load balancer using one of two methods: Set droplet_ids to a list of specific Droplet IDs. Set tag to the name of a tag. All Droplets with this tag applied will be assigned to the ...
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/62bcdae7-03e6-44cf-8fcf-2ee75630498a/2/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_create
To create a new load balancer instance, send a POST request to /v2/load_balancers. You can specify the Droplets that will sit behind the load balancer using one of two methods: Set droplet_ids to a list of specific Droplet IDs. Set tag to the name of a tag. All Droplets with this tag applied will be assigned to the ...
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/62bcdae7-03e6-44cf-8fcf-2ee75630498a/3/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_create
To create a new load balancer instance, send a POST request to /v2/load_balancers. You can specify the Droplets that will sit behind the load balancer using one of two methods: Set droplet_ids to a list of specific Droplet IDs. Set tag to the name of a tag. All Droplets with this tag applied will be assigned to the ...
202
null
{"load_balancer": {"id": "4de7ac8b-495b-4884-9a69-1050c6793cd6", "name": "example-lb-01", "ip": "104.131.186.241", "size": "lb-small", "algorithm": "round_robin", "status": "new", "created_at": "2017-02-01T22:22:58Z", "forwarding_rules": [{"entry_protocol": "http", "entry_port": 80, "target_protocol": "http", "target_p...
{"properties": {"load_balancer": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a load balancer."}, "name": {"type": "string", "description": "A human-readable name for a load balancer instance."}, "project_i...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/62bcdae7-03e6-44cf-8fcf-2ee75630498a/3/1
Digital Ocean
Digital Ocean Public API
null
loadBalancers_create
To create a new load balancer instance, send a POST request to /v2/load_balancers. You can specify the Droplets that will sit behind the load balancer using one of two methods: Set droplet_ids to a list of specific Droplet IDs. Set tag to the name of a tag. All Droplets with this tag applied will be assigned to the ...
202
null
{"load_balancer": {"id": "4de7ac8b-495b-4884-9a69-1050c6793cd6", "name": "example-lb-01", "ip": "104.131.186.241", "size": "lb-small", "algorithm": "round_robin", "status": "new", "created_at": "2017-02-01T22:22:58Z", "forwarding_rules": [{"entry_protocol": "https", "entry_port": 443, "target_protocol": "http", "target...
{"properties": {"load_balancer": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a load balancer."}, "name": {"type": "string", "description": "A human-readable name for a load balancer instance."}, "project_i...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/62bcdae7-03e6-44cf-8fcf-2ee75630498a/3/2
Digital Ocean
Digital Ocean Public API
null
loadBalancers_create
To create a new load balancer instance, send a POST request to /v2/load_balancers. You can specify the Droplets that will sit behind the load balancer using one of two methods: Set droplet_ids to a list of specific Droplet IDs. Set tag to the name of a tag. All Droplets with this tag applied will be assigned to the ...
202
null
{"load_balancer": {"id": "4de7ac8b-495b-4884-9a69-1050c6793cd6", "name": "example-lb-01", "ip": "104.131.186.241", "size": "lb-small", "algorithm": "round_robin", "status": "new", "created_at": "2017-02-01T22:22:58Z", "forwarding_rules": [{"entry_protocol": "https", "entry_port": 443, "target_protocol": "http", "target...
{"properties": {"load_balancer": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a load balancer."}, "name": {"type": "string", "description": "A human-readable name for a load balancer instance."}, "project_i...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/62bcdae7-03e6-44cf-8fcf-2ee75630498a/3/3
Digital Ocean
Digital Ocean Public API
null
loadBalancers_create
To create a new load balancer instance, send a POST request to /v2/load_balancers. You can specify the Droplets that will sit behind the load balancer using one of two methods: Set droplet_ids to a list of specific Droplet IDs. Set tag to the name of a tag. All Droplets with this tag applied will be assigned to the ...
202
null
{"load_balancer": {"id": "4de7ac8b-495b-4884-9a69-1050c6793cd6", "name": "example-lb-01", "ip": "104.131.186.241", "size": "lb-small", "algorithm": "round_robin", "status": "new", "created_at": "2017-02-01T22:22:58Z", "forwarding_rules": [{"entry_protocol": "https", "entry_port": 443, "target_protocol": "http", "target...
{"properties": {"load_balancer": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a load balancer."}, "name": {"type": "string", "description": "A human-readable name for a load balancer instance."}, "project_i...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/22041601-dca5-426b-9735-7392cef446dd/0/0
Digital Ocean
Digital Ocean Public API
null
volumes_delete_byName
Block storage volumes may also be deleted by name by sending a DELETE request with the volume's name and the region slug for the region it is located in as query parameters to /v2/volumes?name=$VOLUME_NAME&region=nyc1. No response body will be sent back, but the response code will indicate success. Specifically, the re...
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/22041601-dca5-426b-9735-7392cef446dd/2/0
Digital Ocean
Digital Ocean Public API
null
volumes_delete_byName
Block storage volumes may also be deleted by name by sending a DELETE request with the volume's name and the region slug for the region it is located in as query parameters to /v2/volumes?name=$VOLUME_NAME&region=nyc1. No response body will be sent back, but the response code will indicate success. Specifically, the re...
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,...