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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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:35Z", "is_default": true}} | {"properties": {"project": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "The unique universal identifier of this project."}, "owner_uuid": {"type": "string", "description": "The unique universal identifier of the project owner."}, "owner_id": {"type": "integer", "description": "The integer id of the project owner."}, "name": {"type": "string", "maxLength": 175, "description": "The human-readable name for the project. The maximum length is 175 characters and the name must be unique."}, "description": {"type": "string", "maxLength": 255, "description": "The description of the project. The maximum length is 255 characters."}, "purpose": {"type": "string", "maxLength": 255, "description": "The purpose of the project. The maximum length is 255 characters. It can\nhave one of the following values:\n\n- Just trying out DigitalOcean\n- Class project / Educational purposes\n- Website or blog\n- Web Application\n- Service or API\n- Mobile Application\n- Machine learning / AI / Data processing\n- IoT\n- Operational / Developer tooling\n\nIf another value for purpose is specified, for example, \"your custom purpose\",\nyour purpose will be stored as `Other: your custom purpose`.\n"}, "environment": {"type": "string", "enum": ["Development", "Staging", "Production"], "description": "The environment of the project's resources."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was updated."}}}, {"type": "object", "properties": {"is_default": {"type": "boolean", "description": "If true, all resources will be added to this project if no project is specified."}}}]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 now be set to migrating. This will transition back to online when the
migration has completed. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 now be set to migrating. This will transition back to online when the
migration has completed. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 now be set to migrating. This will transition back to online when the
migration has completed. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 now be set to migrating. This will transition back to online when the
migration has completed. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 migration was initiated, in ISO 8601 format."}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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", "description": "An object containing the metric labels.", "additionalProperties": {"type": "string"}}, "values": {"type": "array", "items": {"type": "array", "items": {"oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}}}, "resultType": {"type": "string", "enum": ["matrix"]}}}, "status": {"type": "string", "enum": ["success", "error"]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 activity. Does not reflect `month_to_date_usage`."}, "month_to_date_usage": {"type": "string", "description": "Amount used in the current billing period as of the `generated_at` time."}, "generated_at": {"type": "string", "format": "date-time", "description": "The time at which balances were most recently generated."}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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", "description": "An object containing the metric labels.", "additionalProperties": {"type": "string"}}, "values": {"type": "array", "items": {"type": "array", "items": {"oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}}}, "resultType": {"type": "string", "enum": ["matrix"]}}}, "status": {"type": "string", "enum": ["success", "error"]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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.", "type": "array", "items": {"type": "string"}}, "slack": {"type": "array", "description": "Slack integration details.", "items": {"type": "object", "required": ["url", "channel"], "properties": {"channel": {"description": "**Omitted**"}, "url": {"description": "**Omitted**"}}}}}}, "compare": {"type": "string", "enum": ["GreaterThan", "LessThan"]}, "description": {"type": "string"}, "enabled": {"type": "boolean"}, "entities": {"type": "array", "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "string"}}, "type": {"type": "string", "enum": ["v1/insights/droplet/load_1", "v1/insights/droplet/load_5", "v1/insights/droplet/load_15", "v1/insights/droplet/memory_utilization_percent", "v1/insights/droplet/disk_utilization_percent", "v1/insights/droplet/cpu", "v1/insights/droplet/disk_read", "v1/insights/droplet/disk_write", "v1/insights/droplet/public_outbound_bandwidth", "v1/insights/droplet/public_inbound_bandwidth", "v1/insights/droplet/private_outbound_bandwidth", "v1/insights/droplet/private_inbound_bandwidth", "v1/insights/lbaas/avg_cpu_utilization_percent", "v1/insights/lbaas/connection_utilization_percent", "v1/insights/lbaas/droplet_health", "v1/insights/lbaas/tls_connections_per_second_utilization_percent", "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx", "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx", "v1/insights/lbaas/increase_in_http_error_rate_count_5xx", "v1/insights/lbaas/increase_in_http_error_rate_count_4xx", "v1/insights/lbaas/high_http_request_response_time", "v1/insights/lbaas/high_http_request_response_time_50p", "v1/insights/lbaas/high_http_request_response_time_95p", "v1/insights/lbaas/high_http_request_response_time_99p", "v1/dbaas/alerts/load_15_alerts", "v1/dbaas/alerts/memory_utilization_alerts", "v1/dbaas/alerts/disk_utilization_alerts", "v1/dbaas/alerts/cpu_alerts"]}, "uuid": {"type": "string"}, "value": {"type": "number", "format": "float", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38}, "window": {"type": "string", "enum": ["5m", "10m", "30m", "1h"]}}}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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"], [1635387120, "15.01"]]}, {"metric": {"host_id": "222651441", "mode": "irq"}, "values": [[1635386880, "0"], [1635387000, "0"], [1635387120, "0"]]}, {"metric": {"host_id": "222651441", "mode": "nice"}, "values": [[1635386880, "66.35"], [1635387000, "66.35"], [1635387120, "66.35"]]}, {"metric": {"host_id": "222651441", "mode": "softirq"}, "values": [[1635386880, "2.13"], [1635387000, "2.13"], [1635387120, "2.13"]]}, {"metric": {"host_id": "222651441", "mode": "steal"}, "values": [[1635386880, "7.89"], [1635387000, "7.9"], [1635387120, "7.91"]]}, {"metric": {"host_id": "222651441", "mode": "system"}, "values": [[1635386880, "140.09"], [1635387000, "140.2"], [1635387120, "140.23"]]}, {"metric": {"host_id": "222651441", "mode": "user"}, "values": [[1635386880, "278.57"], [1635387000, "278.65"], [1635387120, "278.69"]]}]}} | {"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "description": "An object containing the metric labels.", "additionalProperties": {"type": "string"}}, "values": {"type": "array", "items": {"type": "array", "items": {"oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}}}, "resultType": {"type": "string", "enum": ["matrix"]}}}, "status": {"type": "string", "enum": ["success", "error"]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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": {"description": "**Omitted**"}, "labels": {"description": "**Omitted**"}, "taints": {"description": "**Omitted**"}, "auto_scale": {"description": "**Omitted**"}, "min_nodes": {"description": "**Omitted**"}, "max_nodes": {"description": "**Omitted**"}, "nodes": {"description": "**Omitted**"}}}], "required": ["name", "size", "count"]}}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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.digitalocean.com.\nexample.com. 1800 IN A 1.2.3.4\n"}} | {"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 attribute may contain an IP address. When provided, an A record will be automatically created pointing to the apex domain."}, "ttl": {"type": ["integer", "null"], "description": "This value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested."}, "zone_file": {"type": ["string", "null"], "description": "This attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource."}}}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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_type=droplet. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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_type=droplet. | 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-4e4d-971d-1fdda33a46b1", "name": "k8s-nyc1-1584127772221", "created_at": "2020-03-13T19:30:16Z"}, {"urn": "do:droplet:86e29982-03a7-4946-8a07-a0114dff8754", "name": "ubuntu-s-1vcpu-1gb-nyc1-01", "created_at": "2020-03-13T19:29:20Z"}], "links": {}, "meta": {"total": 4}} | {"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):.*", "description": "The uniform resource name (URN) for the resource in the format do:resource_type:resource_id."}, "created_at": {"type": "string", "description": "A time value given in ISO8601 combined date and time format that represents when the resource was created."}}}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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_type=droplet. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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_type=droplet. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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_type=droplet. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 IP from a Droplet | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 IP from a Droplet | 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-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata"], "available": true}, "region_slug": "nyc3", "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}} | {"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 \"errored\".", "enum": ["in-progress", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}}, {"type": "object", "properties": {"project_id": {"type": "string", "format": "uuid", "description": "The UUID of the project to which the reserved IP currently belongs."}}}]}}} |
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 IP from a Droplet | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 IP from a Droplet | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 IP from a Droplet | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata"], "available": true}, "region_slug": "nyc3", "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}} | {"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 \"errored\".", "enum": ["in-progress", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}}, {"type": "object", "properties": {"project_id": {"type": "string", "format": "uuid", "description": "The UUID of the project to which the reserved IP currently belongs."}}}]}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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/$IMAGE_ID/actions. Set the type attribute to transfer and set
region attribute to the slug identifier of the region you wish to transfer
to. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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/$IMAGE_ID/actions. Set the type attribute to transfer and set
region attribute to the slug identifier of the region you wish to transfer
to. | 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", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}} |
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/$IMAGE_ID/actions. Set the type attribute to transfer and set
region attribute to the slug identifier of the region you wish to transfer
to. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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/$IMAGE_ID/actions. Set the type attribute to transfer and set
region attribute to the slug identifier of the region you wish to transfer
to. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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/$IMAGE_ID/actions. Set the type attribute to transfer and set
region attribute to the slug identifier of the region you wish to transfer
to. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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", "next": "https://api.digitalocean.com/v2/images?page=2", "first": "https://api.digitalocean.com/v2/images?page=1", "prev": "https://api.digitalocean.com/v2/images?page=1"}}, "meta": {"total": 1}} | {"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 can be \"in-progress\", \"completed\", or \"errored\".", "enum": ["in-progress", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata"], "available": true}, "region_slug": "nyc3"}], "links": {}, "meta": {"total": 1}} | {"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 can be \"in-progress\", \"completed\", or \"errored\".", "enum": ["in-progress", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 load balancer. Additional Droplets will be automatically
assigned as they are tagged.
These methods are mutually exclusive. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 load balancer. Additional Droplets will be automatically
assigned as they are tagged.
These methods are mutually exclusive. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 load balancer. Additional Droplets will be automatically
assigned as they are tagged.
These methods are mutually exclusive. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 load balancer. Additional Droplets will be automatically
assigned as they are tagged.
These methods are mutually exclusive. | 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_port": 80, "certificate_id": "", "tls_passthrough": false}, {"entry_protocol": "https", "entry_port": 443, "target_protocol": "https", "target_port": 443, "certificate_id": "", "tls_passthrough": true}], "health_check": {"protocol": "http", "port": 80, "path": "/", "check_interval_seconds": 10, "response_timeout_seconds": 5, "healthy_threshold": 5, "unhealthy_threshold": 3}, "sticky_sessions": {"type": "none"}, "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent"], "available": true}, "tag": "", "droplet_ids": [3164444, 3164445], "redirect_http_to_https": false, "enable_proxy_protocol": false, "enable_backend_keepalive": false, "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "disable_lets_encrypt_dns_records": false, "project_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "http_idle_timeout_seconds": 60, "firewall": {"deny": ["cidr:1.2.0.0/16", "ip:2.3.4.5"], "allow": ["ip:1.2.3.4", "cidr:2.3.4.0/24"]}}} | {"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_id": {"type": "string", "description": "The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created."}, "ip": {"type": "string", "pattern": "^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "description": "An attribute containing the public-facing IP address of the load balancer."}, "size_unit": {"type": "integer", "default": 1, "minimum": 1, "maximum": 100, "description": "How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions."}, "size": {"type": "string", "enum": ["lb-small", "lb-medium", "lb-large"], "default": "lb-small", "description": "This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.\n* `lb-small` = 1 node\n* `lb-medium` = 3 nodes\n* `lb-large` = 6 nodes\n\nYou can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation."}, "algorithm": {"type": "string", "enum": ["round_robin", "least_connections"], "default": "round_robin", "description": "This field has been deprecated. You can no longer specify an algorithm for load balancers."}, "status": {"type": "string", "enum": ["new", "active", "errored"], "description": "A status string indicating the current state of the load balancer. This can be `new`, `active`, or `errored`."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the load balancer was created."}, "forwarding_rules": {"type": "array", "minItems": 1, "items": {"type": "object", "description": "An object specifying a forwarding rule for a load balancer.", "properties": {"entry_protocol": {"description": "**Omitted**"}, "entry_port": {"description": "**Omitted**"}, "target_protocol": {"description": "**Omitted**"}, "target_port": {"description": "**Omitted**"}, "certificate_id": {"description": "**Omitted**"}, "tls_passthrough": {"description": "**Omitted**"}}, "required": ["entry_protocol", "entry_port", "target_protocol", "target_port"]}, "description": "An array of objects specifying the forwarding rules for a load balancer."}, "health_check": {"type": "object", "description": "An object specifying health check settings for the load balancer.", "properties": {"protocol": {"type": "string", "enum": ["http", "https", "tcp"], "default": "http", "description": "The protocol used for health checks sent to the backend Droplets. The possible values are `http`, `https`, or `tcp`."}, "port": {"type": "integer", "default": 80, "description": "An integer representing the port on the backend Droplets on which the health check will attempt a connection."}, "path": {"type": "string", "default": "/", "description": "The path on the backend Droplets to which the load balancer instance will send a request."}, "check_interval_seconds": {"type": "integer", "default": 10, "description": "The number of seconds between between two consecutive health checks."}, "response_timeout_seconds": {"type": "integer", "default": 5, "description": "The number of seconds the load balancer instance will wait for a response until marking a health check as failed."}, "unhealthy_threshold": {"type": "integer", "default": 5, "description": "The number of times a health check must fail for a backend Droplet to be marked \"unhealthy\" and be removed from the pool."}, "healthy_threshold": {"type": "integer", "default": 3, "description": "The number of times a health check must pass for a backend Droplet to be marked \"healthy\" and be re-added to the pool."}}}, "sticky_sessions": {"type": "object", "description": "An object specifying sticky sessions settings for the load balancer.", "properties": {"type": {"type": "string", "enum": ["cookies", "none"], "default": "none", "description": "An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are `cookies` or `none`."}, "cookie_name": {"type": "string", "description": "The name of the cookie sent to the client. This attribute is only returned when using `cookies` for the sticky sessions type."}, "cookie_ttl_seconds": {"type": "integer", "description": "The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using `cookies` for the sticky sessions type."}}}, "redirect_http_to_https": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443."}, "enable_proxy_protocol": {"type": "boolean", "default": false, "description": "A boolean value indicating whether PROXY Protocol is in use."}, "enable_backend_keepalive": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets."}, "http_idle_timeout_seconds": {"type": "integer", "default": 60, "minimum": 30, "maximum": 600, "description": "An integer value which configures the idle timeout for HTTP requests to the target droplets."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the load balancer is assigned."}, "disable_lets_encrypt_dns_records": {"type": "boolean", "default": false, "description": "A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer."}, "firewall": {"type": "object", "description": "An object specifying allow and deny rules to control traffic to the load balancer.", "properties": {"deny": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}, "allow": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}}}}, "required": ["forwarding_rules"]}, {"type": "object", "properties": {"region": {"type": "object", "allOf": [{"description": "The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned."}, {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}]}}}, {"type": "object", "properties": {"droplet_ids": {"type": "array", "items": {"type": "integer"}, "description": "An array containing the IDs of the Droplets assigned to the load balancer."}}}, {"type": "object", "properties": {"tag": {"type": "string", "description": "The name of a Droplet tag corresponding to Droplets assigned to the load balancer."}}}]}}} |
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 load balancer. Additional Droplets will be automatically
assigned as they are tagged.
These methods are mutually exclusive. | 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_port": 8080, "certificate_id": "892071a0-bb95-49bc-8021-3afd67a210bf"}], "health_check": {"protocol": "http", "port": 80, "path": "/", "check_interval_seconds": 10, "response_timeout_seconds": 5, "healthy_threshold": 5, "unhealthy_threshold": 3}, "sticky_sessions": {"type": "none"}, "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent"], "available": true}, "tag": "", "droplet_ids": [3164444, 3164445], "redirect_http_to_https": false, "enable_proxy_protocol": false, "enable_backend_keepalive": false, "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "disable_lets_encrypt_dns_records": false}} | {"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_id": {"type": "string", "description": "The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created."}, "ip": {"type": "string", "pattern": "^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "description": "An attribute containing the public-facing IP address of the load balancer."}, "size_unit": {"type": "integer", "default": 1, "minimum": 1, "maximum": 100, "description": "How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions."}, "size": {"type": "string", "enum": ["lb-small", "lb-medium", "lb-large"], "default": "lb-small", "description": "This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.\n* `lb-small` = 1 node\n* `lb-medium` = 3 nodes\n* `lb-large` = 6 nodes\n\nYou can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation."}, "algorithm": {"type": "string", "enum": ["round_robin", "least_connections"], "default": "round_robin", "description": "This field has been deprecated. You can no longer specify an algorithm for load balancers."}, "status": {"type": "string", "enum": ["new", "active", "errored"], "description": "A status string indicating the current state of the load balancer. This can be `new`, `active`, or `errored`."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the load balancer was created."}, "forwarding_rules": {"type": "array", "minItems": 1, "items": {"type": "object", "description": "An object specifying a forwarding rule for a load balancer.", "properties": {"entry_protocol": {"description": "**Omitted**"}, "entry_port": {"description": "**Omitted**"}, "target_protocol": {"description": "**Omitted**"}, "target_port": {"description": "**Omitted**"}, "certificate_id": {"description": "**Omitted**"}, "tls_passthrough": {"description": "**Omitted**"}}, "required": ["entry_protocol", "entry_port", "target_protocol", "target_port"]}, "description": "An array of objects specifying the forwarding rules for a load balancer."}, "health_check": {"type": "object", "description": "An object specifying health check settings for the load balancer.", "properties": {"protocol": {"type": "string", "enum": ["http", "https", "tcp"], "default": "http", "description": "The protocol used for health checks sent to the backend Droplets. The possible values are `http`, `https`, or `tcp`."}, "port": {"type": "integer", "default": 80, "description": "An integer representing the port on the backend Droplets on which the health check will attempt a connection."}, "path": {"type": "string", "default": "/", "description": "The path on the backend Droplets to which the load balancer instance will send a request."}, "check_interval_seconds": {"type": "integer", "default": 10, "description": "The number of seconds between between two consecutive health checks."}, "response_timeout_seconds": {"type": "integer", "default": 5, "description": "The number of seconds the load balancer instance will wait for a response until marking a health check as failed."}, "unhealthy_threshold": {"type": "integer", "default": 5, "description": "The number of times a health check must fail for a backend Droplet to be marked \"unhealthy\" and be removed from the pool."}, "healthy_threshold": {"type": "integer", "default": 3, "description": "The number of times a health check must pass for a backend Droplet to be marked \"healthy\" and be re-added to the pool."}}}, "sticky_sessions": {"type": "object", "description": "An object specifying sticky sessions settings for the load balancer.", "properties": {"type": {"type": "string", "enum": ["cookies", "none"], "default": "none", "description": "An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are `cookies` or `none`."}, "cookie_name": {"type": "string", "description": "The name of the cookie sent to the client. This attribute is only returned when using `cookies` for the sticky sessions type."}, "cookie_ttl_seconds": {"type": "integer", "description": "The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using `cookies` for the sticky sessions type."}}}, "redirect_http_to_https": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443."}, "enable_proxy_protocol": {"type": "boolean", "default": false, "description": "A boolean value indicating whether PROXY Protocol is in use."}, "enable_backend_keepalive": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets."}, "http_idle_timeout_seconds": {"type": "integer", "default": 60, "minimum": 30, "maximum": 600, "description": "An integer value which configures the idle timeout for HTTP requests to the target droplets."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the load balancer is assigned."}, "disable_lets_encrypt_dns_records": {"type": "boolean", "default": false, "description": "A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer."}, "firewall": {"type": "object", "description": "An object specifying allow and deny rules to control traffic to the load balancer.", "properties": {"deny": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}, "allow": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}}}}, "required": ["forwarding_rules"]}, {"type": "object", "properties": {"region": {"type": "object", "allOf": [{"description": "The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned."}, {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}]}}}, {"type": "object", "properties": {"droplet_ids": {"type": "array", "items": {"type": "integer"}, "description": "An array containing the IDs of the Droplets assigned to the load balancer."}}}, {"type": "object", "properties": {"tag": {"type": "string", "description": "The name of a Droplet tag corresponding to Droplets assigned to the load balancer."}}}]}}} |
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 load balancer. Additional Droplets will be automatically
assigned as they are tagged.
These methods are mutually exclusive. | 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_port": 8080, "certificate_id": "892071a0-bb95-49bc-8021-3afd67a210bf"}], "health_check": {"protocol": "http", "port": 80, "path": "/", "check_interval_seconds": 10, "response_timeout_seconds": 5, "healthy_threshold": 5, "unhealthy_threshold": 3}, "sticky_sessions": {"type": "none"}, "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent"], "available": true}, "tag": "prod:web", "droplet_ids": [3164444, 3164445], "redirect_http_to_https": false, "enable_proxy_protocol": false, "enable_backend_keepalive": false, "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "disable_lets_encrypt_dns_records": false, "project_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"}} | {"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_id": {"type": "string", "description": "The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created."}, "ip": {"type": "string", "pattern": "^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "description": "An attribute containing the public-facing IP address of the load balancer."}, "size_unit": {"type": "integer", "default": 1, "minimum": 1, "maximum": 100, "description": "How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions."}, "size": {"type": "string", "enum": ["lb-small", "lb-medium", "lb-large"], "default": "lb-small", "description": "This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.\n* `lb-small` = 1 node\n* `lb-medium` = 3 nodes\n* `lb-large` = 6 nodes\n\nYou can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation."}, "algorithm": {"type": "string", "enum": ["round_robin", "least_connections"], "default": "round_robin", "description": "This field has been deprecated. You can no longer specify an algorithm for load balancers."}, "status": {"type": "string", "enum": ["new", "active", "errored"], "description": "A status string indicating the current state of the load balancer. This can be `new`, `active`, or `errored`."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the load balancer was created."}, "forwarding_rules": {"type": "array", "minItems": 1, "items": {"type": "object", "description": "An object specifying a forwarding rule for a load balancer.", "properties": {"entry_protocol": {"description": "**Omitted**"}, "entry_port": {"description": "**Omitted**"}, "target_protocol": {"description": "**Omitted**"}, "target_port": {"description": "**Omitted**"}, "certificate_id": {"description": "**Omitted**"}, "tls_passthrough": {"description": "**Omitted**"}}, "required": ["entry_protocol", "entry_port", "target_protocol", "target_port"]}, "description": "An array of objects specifying the forwarding rules for a load balancer."}, "health_check": {"type": "object", "description": "An object specifying health check settings for the load balancer.", "properties": {"protocol": {"type": "string", "enum": ["http", "https", "tcp"], "default": "http", "description": "The protocol used for health checks sent to the backend Droplets. The possible values are `http`, `https`, or `tcp`."}, "port": {"type": "integer", "default": 80, "description": "An integer representing the port on the backend Droplets on which the health check will attempt a connection."}, "path": {"type": "string", "default": "/", "description": "The path on the backend Droplets to which the load balancer instance will send a request."}, "check_interval_seconds": {"type": "integer", "default": 10, "description": "The number of seconds between between two consecutive health checks."}, "response_timeout_seconds": {"type": "integer", "default": 5, "description": "The number of seconds the load balancer instance will wait for a response until marking a health check as failed."}, "unhealthy_threshold": {"type": "integer", "default": 5, "description": "The number of times a health check must fail for a backend Droplet to be marked \"unhealthy\" and be removed from the pool."}, "healthy_threshold": {"type": "integer", "default": 3, "description": "The number of times a health check must pass for a backend Droplet to be marked \"healthy\" and be re-added to the pool."}}}, "sticky_sessions": {"type": "object", "description": "An object specifying sticky sessions settings for the load balancer.", "properties": {"type": {"type": "string", "enum": ["cookies", "none"], "default": "none", "description": "An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are `cookies` or `none`."}, "cookie_name": {"type": "string", "description": "The name of the cookie sent to the client. This attribute is only returned when using `cookies` for the sticky sessions type."}, "cookie_ttl_seconds": {"type": "integer", "description": "The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using `cookies` for the sticky sessions type."}}}, "redirect_http_to_https": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443."}, "enable_proxy_protocol": {"type": "boolean", "default": false, "description": "A boolean value indicating whether PROXY Protocol is in use."}, "enable_backend_keepalive": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets."}, "http_idle_timeout_seconds": {"type": "integer", "default": 60, "minimum": 30, "maximum": 600, "description": "An integer value which configures the idle timeout for HTTP requests to the target droplets."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the load balancer is assigned."}, "disable_lets_encrypt_dns_records": {"type": "boolean", "default": false, "description": "A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer."}, "firewall": {"type": "object", "description": "An object specifying allow and deny rules to control traffic to the load balancer.", "properties": {"deny": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}, "allow": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}}}}, "required": ["forwarding_rules"]}, {"type": "object", "properties": {"region": {"type": "object", "allOf": [{"description": "The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned."}, {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}]}}}, {"type": "object", "properties": {"droplet_ids": {"type": "array", "items": {"type": "integer"}, "description": "An array containing the IDs of the Droplets assigned to the load balancer."}}}, {"type": "object", "properties": {"tag": {"type": "string", "description": "The name of a Droplet tag corresponding to Droplets assigned to the load balancer."}}}]}}} |
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 load balancer. Additional Droplets will be automatically
assigned as they are tagged.
These methods are mutually exclusive. | 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_port": 8080, "certificate_id": "892071a0-bb95-49bc-8021-3afd67a210bf"}], "health_check": {"protocol": "http", "port": 8080, "path": "/health", "check_interval_seconds": 10, "response_timeout_seconds": 5, "healthy_threshold": 5, "unhealthy_threshold": 3}, "sticky_sessions": {"type": "cookies", "cookie_name": "LB_COOKIE", "cookie_ttl_seconds": 300}, "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent"], "available": true}, "tag": "prod:web", "droplet_ids": [3164444, 3164445], "redirect_http_to_https": false, "enable_proxy_protocol": false, "enable_backend_keepalive": false, "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "disable_lets_encrypt_dns_records": false, "project_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"}} | {"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_id": {"type": "string", "description": "The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created."}, "ip": {"type": "string", "pattern": "^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "description": "An attribute containing the public-facing IP address of the load balancer."}, "size_unit": {"type": "integer", "default": 1, "minimum": 1, "maximum": 100, "description": "How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions."}, "size": {"type": "string", "enum": ["lb-small", "lb-medium", "lb-large"], "default": "lb-small", "description": "This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.\n* `lb-small` = 1 node\n* `lb-medium` = 3 nodes\n* `lb-large` = 6 nodes\n\nYou can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation."}, "algorithm": {"type": "string", "enum": ["round_robin", "least_connections"], "default": "round_robin", "description": "This field has been deprecated. You can no longer specify an algorithm for load balancers."}, "status": {"type": "string", "enum": ["new", "active", "errored"], "description": "A status string indicating the current state of the load balancer. This can be `new`, `active`, or `errored`."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the load balancer was created."}, "forwarding_rules": {"type": "array", "minItems": 1, "items": {"type": "object", "description": "An object specifying a forwarding rule for a load balancer.", "properties": {"entry_protocol": {"description": "**Omitted**"}, "entry_port": {"description": "**Omitted**"}, "target_protocol": {"description": "**Omitted**"}, "target_port": {"description": "**Omitted**"}, "certificate_id": {"description": "**Omitted**"}, "tls_passthrough": {"description": "**Omitted**"}}, "required": ["entry_protocol", "entry_port", "target_protocol", "target_port"]}, "description": "An array of objects specifying the forwarding rules for a load balancer."}, "health_check": {"type": "object", "description": "An object specifying health check settings for the load balancer.", "properties": {"protocol": {"type": "string", "enum": ["http", "https", "tcp"], "default": "http", "description": "The protocol used for health checks sent to the backend Droplets. The possible values are `http`, `https`, or `tcp`."}, "port": {"type": "integer", "default": 80, "description": "An integer representing the port on the backend Droplets on which the health check will attempt a connection."}, "path": {"type": "string", "default": "/", "description": "The path on the backend Droplets to which the load balancer instance will send a request."}, "check_interval_seconds": {"type": "integer", "default": 10, "description": "The number of seconds between between two consecutive health checks."}, "response_timeout_seconds": {"type": "integer", "default": 5, "description": "The number of seconds the load balancer instance will wait for a response until marking a health check as failed."}, "unhealthy_threshold": {"type": "integer", "default": 5, "description": "The number of times a health check must fail for a backend Droplet to be marked \"unhealthy\" and be removed from the pool."}, "healthy_threshold": {"type": "integer", "default": 3, "description": "The number of times a health check must pass for a backend Droplet to be marked \"healthy\" and be re-added to the pool."}}}, "sticky_sessions": {"type": "object", "description": "An object specifying sticky sessions settings for the load balancer.", "properties": {"type": {"type": "string", "enum": ["cookies", "none"], "default": "none", "description": "An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are `cookies` or `none`."}, "cookie_name": {"type": "string", "description": "The name of the cookie sent to the client. This attribute is only returned when using `cookies` for the sticky sessions type."}, "cookie_ttl_seconds": {"type": "integer", "description": "The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using `cookies` for the sticky sessions type."}}}, "redirect_http_to_https": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443."}, "enable_proxy_protocol": {"type": "boolean", "default": false, "description": "A boolean value indicating whether PROXY Protocol is in use."}, "enable_backend_keepalive": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets."}, "http_idle_timeout_seconds": {"type": "integer", "default": 60, "minimum": 30, "maximum": 600, "description": "An integer value which configures the idle timeout for HTTP requests to the target droplets."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the load balancer is assigned."}, "disable_lets_encrypt_dns_records": {"type": "boolean", "default": false, "description": "A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer."}, "firewall": {"type": "object", "description": "An object specifying allow and deny rules to control traffic to the load balancer.", "properties": {"deny": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}, "allow": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}}}}, "required": ["forwarding_rules"]}, {"type": "object", "properties": {"region": {"type": "object", "allOf": [{"description": "The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned."}, {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}]}}}, {"type": "object", "properties": {"droplet_ids": {"type": "array", "items": {"type": "integer"}, "description": "An array containing the IDs of the Droplets assigned to the load balancer."}}}, {"type": "object", "properties": {"tag": {"type": "string", "description": "The name of a Droplet tag corresponding to Droplets assigned to the load balancer."}}}]}}} |
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®ion=nyc1.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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®ion=nyc1.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.