{ "info": { "_postman_id": "788c2ba1-61c6-4e37-a154-f05dbba2ba03", "name": "DigitalOcean API-V2", "description": "## API v2 Introduction\r\nWelcome to the DigitalOcean API documentation.\r\n\r\nThe DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. The endpoints are intuitive and powerful, allowing you to easily make calls to retrieve information or to execute actions.\r\n\r\nAll of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires.\r\n\r\nThe API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints.\r\n\r\nRequests\r\nAny tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required.\r\n\r\nMethod\tUsage\r\nGET\t\r\nFor simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object.\r\n\r\nThe attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.\r\n\r\nDELETE\t\r\nTo destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found.\r\n\r\nThis idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.\r\n\r\nPUT\t\r\nTo update the information about a resource in your account, the PUT method is available.\r\n\r\nLike the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.\r\n\r\nPOST\t\r\nTo create a new object, your request should specify the POST method.\r\n\r\nThe POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.\r\n\r\nHEAD\t\r\nFinally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request.\r\n\r\nResponse headers contain some useful information about your API access and the results that are available for your request.\r\n\r\nFor instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Account", "item": [ { "name": "Get user information", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/account", "host": [ "{{base_url}}" ], "path": [ "account" ] }, "description": "Get [DigitalOcean](https://www.digitalocean.com/) account" }, "response": [ { "name": "Failed to authenticate", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "https://api.digitalocean.com/v2/account", "protocol": "https", "host": [ "api", "digitalocean", "com" ], "path": [ "v2", "account" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "CF-RAY", "value": "443a5fbbd93f5ba5-HEL", "name": "CF-RAY", "description": "Custom header" }, { "key": "Connection", "value": "keep-alive", "name": "Connection", "description": "Options that are desired for the connection" }, { "key": "Content-Length", "value": "65", "name": "Content-Length", "description": "The length of the response body in octets (8-bit bytes)" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "The mime type of this content" }, { "key": "Date", "value": "Wed, 01 Aug 2018 18:30:05 GMT", "name": "Date", "description": "The date and time that the message was sent" }, { "key": "Expect-CT", "value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"", "name": "Expect-CT", "description": "Custom header" }, { "key": "Server", "value": "cloudflare", "name": "Server", "description": "A name for the server" }, { "key": "Set-Cookie", "value": "__cfduid=dddc37f9edb69c5c3d2047e5e4060a9fc1533148205; expires=Thu, 01-Aug-19 18:30:05 GMT; path=/; domain=.digitalocean.com; HttpOnly", "name": "Set-Cookie", "description": "an HTTP cookie" }, { "key": "X-Gateway", "value": "Edge-Gateway", "name": "X-Gateway", "description": "Custom header" }, { "key": "X-Request-Id", "value": "7fbf5054-fc6a-4e4b-9f6e-443681d69068", "name": "X-Request-Id", "description": "Custom header" } ], "cookie": [ { "expires": "Invalid Date", "httpOnly": true, "domain": "digitalocean.com", "path": "/", "secure": false, "value": "dddc37f9edb69c5c3d2047e5e4060a9fc1533148205", "key": "__cfduid" } ], "body": "{\"id\": \"unauthorized\", \"message\": \"Unable to authenticate you.\" }" }, { "name": "Get User Information", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/account", "host": [ "{{base_url}}" ], "path": [ "account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "CF-RAY", "value": "443ac7279fac5b99-HEL", "name": "CF-RAY", "description": "Custom header" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate", "name": "Cache-Control", "description": "Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds" }, { "key": "Connection", "value": "keep-alive", "name": "Connection", "description": "Options that are desired for the connection" }, { "key": "Content-Encoding", "value": "gzip", "name": "Content-Encoding", "description": "The type of encoding used on the data." }, { "key": "Content-Type", "value": "application/json; charset=utf-8", "name": "Content-Type", "description": "The mime type of this content" }, { "key": "Date", "value": "Wed, 01 Aug 2018 19:40:42 GMT", "name": "Date", "description": "The date and time that the message was sent" }, { "key": "Etag", "value": "W/\"26d334e4f07ab09d00c9b2612adf23c1\"", "name": "Etag", "description": "An identifier for a specific version of a resource, often a message digest" }, { "key": "Expect-CT", "value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"", "name": "Expect-CT", "description": "Custom header" }, { "key": "Ratelimit-Limit", "value": "5000", "name": "Ratelimit-Limit", "description": "Custom header" }, { "key": "Ratelimit-Remaining", "value": "4990", "name": "Ratelimit-Remaining", "description": "Custom header" }, { "key": "Ratelimit-Reset", "value": "1533152110", "name": "Ratelimit-Reset", "description": "Custom header" }, { "key": "Server", "value": "cloudflare", "name": "Server", "description": "A name for the server" }, { "key": "Transfer-Encoding", "value": "chunked", "name": "Transfer-Encoding", "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity." }, { "key": "X-Content-Type-Options", "value": "nosniff", "name": "X-Content-Type-Options", "description": "The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN", "name": "X-Frame-Options", "description": "Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch" }, { "key": "X-Gateway", "value": "Edge-Gateway", "name": "X-Gateway", "description": "Custom header" }, { "key": "X-Request-Id", "value": "3f9ed76d-0e12-4a8b-ab42-f7f5cdbb8c0f", "name": "X-Request-Id", "description": "Custom header" }, { "key": "X-Response-From", "value": "service", "name": "X-Response-From", "description": "Custom header" }, { "key": "X-Runtime", "value": "0.070912", "name": "X-Runtime", "description": "Custom header" }, { "key": "X-Xss-Protection", "value": "1; mode=block", "name": "X-Xss-Protection", "description": "Cross-site scripting (XSS) filter" } ], "cookie": [ { "expires": "Invalid Date", "httpOnly": true, "domain": "digitalocean.com", "path": "/", "secure": false, "value": "dddc37f9edb69c5c3d2047e5e4060a9fc1533148205", "key": "__cfduid" } ], "body": "{\n \"account\": {\n \"droplet_limit\": 1,\n \"floating_ip_limit\": 1,\n \"email\": \"postman-do@gmail.com\",\n \"uuid\": \"fe87d52a44365d3d8781365d3d8781365d3d8781ed68\",\n \"email_verified\": true,\n \"status\": \"active\",\n \"status_message\": \"\"\n }\n}" }, { "name": "Failed to authenticate", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/account", "host": [ "{{base_url}}" ], "path": [ "account" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "CF-RAY", "value": "443a654a1e3c5ba5-HEL", "name": "CF-RAY", "description": "Custom header" }, { "key": "Connection", "value": "keep-alive", "name": "Connection", "description": "Options that are desired for the connection" }, { "key": "Content-Length", "value": "65", "name": "Content-Length", "description": "The length of the response body in octets (8-bit bytes)" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "The mime type of this content" }, { "key": "Date", "value": "Wed, 01 Aug 2018 18:33:53 GMT", "name": "Date", "description": "The date and time that the message was sent" }, { "key": "Expect-CT", "value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"", "name": "Expect-CT", "description": "Custom header" }, { "key": "Server", "value": "cloudflare", "name": "Server", "description": "A name for the server" }, { "key": "X-Gateway", "value": "Edge-Gateway", "name": "X-Gateway", "description": "Custom header" }, { "key": "X-Request-Id", "value": "fb823905-1040-4e33-b2de-7187549eb261", "name": "X-Request-Id", "description": "Custom header" } ], "cookie": [ { "expires": "Invalid Date", "httpOnly": true, "domain": "digitalocean.com", "path": "/", "secure": false, "value": "dddc37f9edb69c5c3d2047e5e4060a9fc1533148205", "key": "__cfduid" } ], "body": "{\"id\": \"unauthorized\", \"message\": \"Unable to authenticate you.\" }" } ] } ], "description": "Name\t\t\t\tType\t\tDescription\r\ndroplet_limit\t\tinteger\t\tThe total number of droplets the user may have\r\nfloating_ip_limit\tinteger\t\tThe total number of floating IPs the user may have\r\nemail\t\t\t\tstring\t\tThe email the user has registered for Digital Ocean with\r\nuuid\t\t\t\tstring (alphanumeric)\tThe universal identifier for this user\r\nemail_verified\t\tboolean\t\tIf true, the user has verified their account via email. False otherwise.\r\nstatus\t\t\t\tstring\t\tThis value is one of \"active\", \"warning\" or \"locked\".\r\nstatus_message\t\tstring\t\tA human-readable message giving more details about the status of the account.\r\n", "event": [ { "listen": "prerequest", "script": { "id": "3636f17d-28e1-4924-abdd-28e967acfcec", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "47d22316-7323-4743-9737-05ea9889a93d", "type": "text/javascript", "exec": [ "" ] } } ], "protocolProfileBehavior": {} }, { "name": "Actions", "item": [ { "name": "List all actions", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/actions?page={{page}}&per_page={{per_page}}", "host": [ "{{base_url}}" ], "path": [ "actions" ], "query": [ { "key": "page", "value": "{{page}}" }, { "key": "per_page", "value": "{{per_page}}" } ] }, "description": "To list all of the actions that have been executed on the current account, send a GET request to /v2/actions.\r\n\r\nThis will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 25 on each page by default.\r\n\r\nThe results will be returned as a JSON object with an actions key." }, "response": [ { "name": "List all actions", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/actions?page={{page}}&per_page={{per_page}}", "host": [ "{{base_url}}" ], "path": [ "actions" ], "query": [ { "key": "page", "value": "{{page}}" }, { "key": "per_page", "value": "{{per_page}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "CF-RAY", "value": "44f668b2ae405ae5-HEL", "name": "CF-RAY", "description": "Custom header" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate", "name": "Cache-Control", "description": "Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds" }, { "key": "Connection", "value": "keep-alive", "name": "Connection", "description": "Options that are desired for the connection" }, { "key": "Content-Encoding", "value": "gzip", "name": "Content-Encoding", "description": "The type of encoding used on the data." }, { "key": "Content-Type", "value": "application/json; charset=utf-8", "name": "Content-Type", "description": "The mime type of this content" }, { "key": "Date", "value": "Fri, 24 Aug 2018 14:11:36 GMT", "name": "Date", "description": "The date and time that the message was sent" }, { "key": "Etag", "value": "W/\"5092565a70737a40ae99cb0ffc2b1953\"", "name": "Etag", "description": "An identifier for a specific version of a resource, often a message digest" }, { "key": "Expect-CT", "value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"", "name": "Expect-CT", "description": "Custom header" }, { "key": "Ratelimit-Limit", "value": "5000", "name": "Ratelimit-Limit", "description": "Custom header" }, { "key": "Ratelimit-Remaining", "value": "4998", "name": "Ratelimit-Remaining", "description": "Custom header" }, { "key": "Ratelimit-Reset", "value": "1535119720", "name": "Ratelimit-Reset", "description": "Custom header" }, { "key": "Server", "value": "cloudflare", "name": "Server", "description": "A name for the server" }, { "key": "Transfer-Encoding", "value": "chunked", "name": "Transfer-Encoding", "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity." }, { "key": "X-Content-Type-Options", "value": "nosniff", "name": "X-Content-Type-Options", "description": "The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN", "name": "X-Frame-Options", "description": "Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch" }, { "key": "X-Gateway", "value": "Edge-Gateway", "name": "X-Gateway", "description": "Custom header" }, { "key": "X-Request-Id", "value": "7285feea-5e49-4348-8a4f-995b897545ce", "name": "X-Request-Id", "description": "Custom header" }, { "key": "X-Response-From", "value": "service", "name": "X-Response-From", "description": "Custom header" }, { "key": "X-Runtime", "value": "0.137472", "name": "X-Runtime", "description": "Custom header" }, { "key": "X-Xss-Protection", "value": "1; mode=block", "name": "X-Xss-Protection", "description": "Cross-site scripting (XSS) filter" } ], "cookie": [ { "expires": "Invalid Date", "httpOnly": true, "domain": "digitalocean.com", "path": "/", "secure": false, "value": "d17e588f7c99717215499d2e2c273e4dc1533154506", "key": "__cfduid" } ], "body": "{\"actions\":[{\"id\":230459959,\"status\":\"completed\",\"type\":\"destroy\",\"started_at\":\"2017-05-02T04:19:20Z\",\"completed_at\":\"2017-05-02T04:19:24Z\",\"resource_id\":31650085,\"resource_type\":\"droplet\",\"region\":{\"name\":\"Amsterdam 2\",\"slug\":\"ams2\",\"sizes\":[],\"features\":[\"private_networking\",\"backups\",\"ipv6\",\"metadata\",\"install_agent\",\"image_transfer\"],\"available\":false},\"region_slug\":\"ams2\"},{\"id\":219421692,\"status\":\"completed\",\"type\":\"power_off\",\"started_at\":\"2017-04-06T04:39:40Z\",\"completed_at\":\"2017-04-06T04:40:02Z\",\"resource_id\":31650085,\"resource_type\":\"droplet\",\"region\":{\"name\":\"Amsterdam 2\",\"slug\":\"ams2\",\"sizes\":[],\"features\":[\"private_networking\",\"backups\",\"ipv6\",\"metadata\",\"install_agent\",\"image_transfer\"],\"available\":false},\"region_slug\":\"ams2\"}],\"links\":{\"pages\":{\"last\":\"https://api.digitalocean.com/v2/actions?page=11&per_page=2\",\"next\":\"https://api.digitalocean.com/v2/actions?page=2&per_page=2\"}},\"meta\":{\"total\":21}}" } ] }, { "name": "Retrieve an existing action", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/actions/{{action_id}}", "host": [ "{{base_url}}" ], "path": [ "actions", "{{action_id}}" ] }, "description": "To retrieve a specific action object, send a GET request to /v2/actions/$ACTION_ID.\r\n\r\nThe result will be a JSON object with an action key. " }, "response": [ { "name": "Retrieve an existing Action", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/actions/{{action_id}}", "host": [ "{{base_url}}" ], "path": [ "actions", "{{action_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "CF-RAY", "value": "44f671e5ae205ae5-HEL", "name": "CF-RAY", "description": "Custom header" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate", "name": "Cache-Control", "description": "Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds" }, { "key": "Connection", "value": "keep-alive", "name": "Connection", "description": "Options that are desired for the connection" }, { "key": "Content-Encoding", "value": "gzip", "name": "Content-Encoding", "description": "The type of encoding used on the data." }, { "key": "Content-Type", "value": "application/json; charset=utf-8", "name": "Content-Type", "description": "The mime type of this content" }, { "key": "Date", "value": "Fri, 24 Aug 2018 14:17:52 GMT", "name": "Date", "description": "The date and time that the message was sent" }, { "key": "Etag", "value": "W/\"4b835fe7bd5da69184d67237c433e003\"", "name": "Etag", "description": "An identifier for a specific version of a resource, often a message digest" }, { "key": "Expect-CT", "value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"", "name": "Expect-CT", "description": "Custom header" }, { "key": "Ratelimit-Limit", "value": "5000", "name": "Ratelimit-Limit", "description": "Custom header" }, { "key": "Ratelimit-Remaining", "value": "4993", "name": "Ratelimit-Remaining", "description": "Custom header" }, { "key": "Ratelimit-Reset", "value": "1535119720", "name": "Ratelimit-Reset", "description": "Custom header" }, { "key": "Server", "value": "cloudflare", "name": "Server", "description": "A name for the server" }, { "key": "Transfer-Encoding", "value": "chunked", "name": "Transfer-Encoding", "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity." }, { "key": "X-Content-Type-Options", "value": "nosniff", "name": "X-Content-Type-Options", "description": "The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN", "name": "X-Frame-Options", "description": "Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch" }, { "key": "X-Gateway", "value": "Edge-Gateway", "name": "X-Gateway", "description": "Custom header" }, { "key": "X-Request-Id", "value": "0d3fd8ae-e9a0-4bd6-9aed-b2e34302d8c9", "name": "X-Request-Id", "description": "Custom header" }, { "key": "X-Response-From", "value": "service", "name": "X-Response-From", "description": "Custom header" }, { "key": "X-Runtime", "value": "0.087273", "name": "X-Runtime", "description": "Custom header" }, { "key": "X-Xss-Protection", "value": "1; mode=block", "name": "X-Xss-Protection", "description": "Cross-site scripting (XSS) filter" } ], "cookie": [ { "expires": "Invalid Date", "httpOnly": true, "domain": "digitalocean.com", "path": "/", "secure": false, "value": "d17e588f7c99717215499d2e2c273e4dc1533154506", "key": "__cfduid" } ], "body": "{\"action\":{\"id\":219421692,\"status\":\"completed\",\"type\":\"power_off\",\"started_at\":\"2017-04-06T04:39:40Z\",\"completed_at\":\"2017-04-06T04:40:02Z\",\"resource_id\":31650085,\"resource_type\":\"droplet\",\"region\":{\"name\":\"Amsterdam 2\",\"slug\":\"ams2\",\"sizes\":[],\"features\":[\"private_networking\",\"backups\",\"ipv6\",\"metadata\",\"install_agent\",\"image_transfer\"],\"available\":false},\"region_slug\":\"ams2\"}}" }, { "name": "No existing action found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/actions/{{action_id}}", "host": [ "{{base_url}}" ], "path": [ "actions", "{{action_id}}" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "CF-RAY", "value": "44f66fffae8b5ae5-HEL", "name": "CF-RAY", "description": "Custom header" }, { "key": "Cache-Control", "value": "no-cache", "name": "Cache-Control", "description": "Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds" }, { "key": "Connection", "value": "keep-alive", "name": "Connection", "description": "Options that are desired for the connection" }, { "key": "Content-Encoding", "value": "gzip", "name": "Content-Encoding", "description": "The type of encoding used on the data." }, { "key": "Content-Type", "value": "application/json; charset=utf-8", "name": "Content-Type", "description": "The mime type of this content" }, { "key": "Date", "value": "Fri, 24 Aug 2018 14:16:34 GMT", "name": "Date", "description": "The date and time that the message was sent" }, { "key": "Expect-CT", "value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"", "name": "Expect-CT", "description": "Custom header" }, { "key": "Ratelimit-Limit", "value": "5000", "name": "Ratelimit-Limit", "description": "Custom header" }, { "key": "Ratelimit-Remaining", "value": "4994", "name": "Ratelimit-Remaining", "description": "Custom header" }, { "key": "Ratelimit-Reset", "value": "1535119720", "name": "Ratelimit-Reset", "description": "Custom header" }, { "key": "Server", "value": "cloudflare", "name": "Server", "description": "A name for the server" }, { "key": "Transfer-Encoding", "value": "chunked", "name": "Transfer-Encoding", "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity." }, { "key": "X-Content-Type-Options", "value": "nosniff", "name": "X-Content-Type-Options", "description": "The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN", "name": "X-Frame-Options", "description": "Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch" }, { "key": "X-Gateway", "value": "Edge-Gateway", "name": "X-Gateway", "description": "Custom header" }, { "key": "X-Request-Id", "value": "9d8cf84e-c8a0-4beb-a31b-2059f161593b", "name": "X-Request-Id", "description": "Custom header" }, { "key": "X-Response-From", "value": "service", "name": "X-Response-From", "description": "Custom header" }, { "key": "X-Runtime", "value": "0.070871", "name": "X-Runtime", "description": "Custom header" }, { "key": "X-Xss-Protection", "value": "1; mode=block", "name": "X-Xss-Protection", "description": "Cross-site scripting (XSS) filter" } ], "cookie": [ { "expires": "Invalid Date", "httpOnly": true, "domain": "digitalocean.com", "path": "/", "secure": false, "value": "d17e588f7c99717215499d2e2c273e4dc1533154506", "key": "__cfduid" } ], "body": "{\"id\":\"not_found\",\"message\":\"The resource you were accessing could not be found.\"}" } ] } ], "description": "Actions are records of events that have occurred on the resources in your account. These can be things like rebooting a Droplet, or transferring an image to a new region.\r\n\r\nAn action object is created every time one of these actions is initiated. The action object contains information about the current status of the action, start and complete timestamps, and the associated resource type and ID.\r\n\r\nEvery action that creates an action object is available through this endpoint. Completed actions are not removed from this list and are always available for querying.\r\n\r\nName\tType\tDescription\r\nid\tinteger\tA unique numeric ID that can be used to identify and reference an action.\r\nstatus\tstring\tThe current status of the action. This can be \"in-progress\", \"completed\", or \"errored\".\r\ntype\tstring\tThis is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action.\r\nstarted_at\tstring\tA time value given in ISO8601 combined date and time format that represents when the action was initiated.\r\ncompleted_at\tstring\tA time value given in ISO8601 combined date and time format that represents when the action was completed.\r\nresource_id\tinteger\tA unique identifier for the resource that the action is associated with.\r\nresource_type\tstring\tThe type of resource that the action is associated with.\r\nregion\tobject\tA full region object containing information about the region where the action occurred.\r\nregion_slug\tnullable string\tA slug representing the region where the action occurred.", "protocolProfileBehavior": {} }, { "name": "Certificates", "item": [ { "name": "List all certificates", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/certificates", "host": [ "{{base_url}}" ], "path": [ "certificates" ] }, "description": "To list all of the certificates available on your account, send a GET request to /v2/certificates.\r\n\r\nThe result will be a JSON object with a certificates key. This will be set to an array of certificate objects, each of which will contain the standard certificate attributes:" }, "response": [ { "name": "Empty certificates", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/certificates", "host": [ "{{base_url}}" ], "path": [ "certificates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "CF-RAY", "value": "4484be8739f45b33-HEL", "name": "CF-RAY", "description": "Custom header" }, { "key": "Connection", "value": "keep-alive", "name": "Connection", "description": "Options that are desired for the connection" }, { "key": "Content-Encoding", "value": "gzip", "name": "Content-Encoding", "description": "The type of encoding used on the data." }, { "key": "Content-Type", "value": "application/json; charset=utf-8", "name": "Content-Type", "description": "The mime type of this content" }, { "key": "Date", "value": "Fri, 10 Aug 2018 19:07:15 GMT", "name": "Date", "description": "The date and time that the message was sent" }, { "key": "Expect-CT", "value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"", "name": "Expect-CT", "description": "Custom header" }, { "key": "Ratelimit-Limit", "value": "5000", "name": "Ratelimit-Limit", "description": "Custom header" }, { "key": "Ratelimit-Remaining", "value": "4999", "name": "Ratelimit-Remaining", "description": "Custom header" }, { "key": "Ratelimit-Reset", "value": "1533928034", "name": "Ratelimit-Reset", "description": "Custom header" }, { "key": "Server", "value": "cloudflare", "name": "Server", "description": "A name for the server" }, { "key": "Transfer-Encoding", "value": "chunked", "name": "Transfer-Encoding", "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity." }, { "key": "X-Gateway", "value": "Edge-Gateway", "name": "X-Gateway", "description": "Custom header" }, { "key": "X-Request-Id", "value": "43ce9279-b7ab-4dde-bc57-5d88c111da5a", "name": "X-Request-Id", "description": "Custom header" }, { "key": "X-Response-From", "value": "service", "name": "X-Response-From", "description": "Custom header" } ], "cookie": [ { "expires": "Invalid Date", "httpOnly": true, "domain": "digitalocean.com", "path": "/", "secure": false, "value": "d17e588f7c99717215499d2e2c273e4dc1533154506", "key": "__cfduid" } ], "body": "{\"certificates\":[],\"links\":{},\"meta\":{\"total\":0}}" } ] }, { "name": "Retrieve an existing certificate", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/certificates/{{certificate_id}}", "host": [ "{{base_url}}" ], "path": [ "certificates", "{{certificate_id}}" ] }, "description": "To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.\r\n\r\nThe response will be a JSON object with a certificate key." }, "response": [ { "name": "Certificate not found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/certificates/892071a0-bb95-49bc-8021-3afd67a210bf", "host": [ "{{base_url}}" ], "path": [ "certificates", "892071a0-bb95-49bc-8021-3afd67a210bf" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "CF-RAY", "value": "4484c2cd1c005b33-HEL", "name": "CF-RAY", "description": "Custom header" }, { "key": "Connection", "value": "keep-alive", "name": "Connection", "description": "Options that are desired for the connection" }, { "key": "Content-Encoding", "value": "gzip", "name": "Content-Encoding", "description": "The type of encoding used on the data." }, { "key": "Content-Type", "value": "application/json; charset=utf-8", "name": "Content-Type", "description": "The mime type of this content" }, { "key": "Date", "value": "Fri, 10 Aug 2018 19:10:10 GMT", "name": "Date", "description": "The date and time that the message was sent" }, { "key": "Expect-CT", "value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"", "name": "Expect-CT", "description": "Custom header" }, { "key": "Ratelimit-Limit", "value": "5000", "name": "Ratelimit-Limit", "description": "Custom header" }, { "key": "Ratelimit-Remaining", "value": "4997", "name": "Ratelimit-Remaining", "description": "Custom header" }, { "key": "Ratelimit-Reset", "value": "1533928034", "name": "Ratelimit-Reset", "description": "Custom header" }, { "key": "Server", "value": "cloudflare", "name": "Server", "description": "A name for the server" }, { "key": "Transfer-Encoding", "value": "chunked", "name": "Transfer-Encoding", "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity." }, { "key": "X-Gateway", "value": "Edge-Gateway", "name": "X-Gateway", "description": "Custom header" }, { "key": "X-Request-Id", "value": "1a015cc7-7477-4b8a-a4fa-58120b49a03b", "name": "X-Request-Id", "description": "Custom header" }, { "key": "X-Response-From", "value": "service", "name": "X-Response-From", "description": "Custom header" } ], "cookie": [ { "expires": "Invalid Date", "httpOnly": true, "domain": "digitalocean.com", "path": "/", "secure": false, "value": "d17e588f7c99717215499d2e2c273e4dc1533154506", "key": "__cfduid" } ], "body": "{\"id\":\"not_found\",\"message\":\"Certificate not found\",\"request_id\":\"1a015cc7-7477-4b8a-a4fa-58120b49a03b\"}\n" } ] }, { "name": "Create a new certificate", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"name\": \"web-cert-01\",\r\n \"type\": \"custom\",\r\n \"private_key\": \"(