{"openapi":"3.0.0","info":{"description":"Cloud computing platform","version":[{"name":"v2","value":"v2"}]},"servers":[{"description":"Cloud computing platform","url":"https://api.apirails.com/digitalocean"}],"paths":{"/v2/1-clicks":{"get":{"tags":["1-Click Applications"],"parameters":[{"name":"type","in":"query","description":"Restrict results to a certain type of 1-Click","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/1-clicks"},"summary":"List 1-Click Applications","description":"To list all available 1-Click applications send a GET request to `/v2/1-clicks`.","security":[{"bearerAuth":[]}]}},"/v2/1-clicks/kubernetes":{"post":{"tags":["1-Click Applications"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/1-clicks/kubernetes"},"summary":"Install Kubernetes 1-Click Applications","description":"To install a Kubernetes 1-Click application on a cluster send a POST request to `/v2/1-clicks/kubernetes`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"addon_slugs":{"type":"array","description":"An array of 1-Click Application slugs to be installed to the Kubernetes cluster","required":true,"items":{"type":"string"}},"cluster_uuid":{"type":"string","description":"A unique ID for the Kubernetes cluster to which the 1-Click Applications will be installed","required":true}}},"example":{"addon_slugs":[],"cluster_uuid":""}}}}}},"/v2/account":{"get":{"tags":["Account"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/account"},"summary":"Get User Information","description":"To show information about the current user account send a GET request to `/v2/account`.","security":[{"bearerAuth":[]}]}},"/v2/actions":{"get":{"tags":["Actions"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/actions"},"summary":"List All Actions","description":"This will be the entire list of actions taken on your account so it will be quite large.","security":[{"bearerAuth":[]}]}},"/v2/actions/{action_id}":{"get":{"tags":["Actions"],"parameters":[{"name":"action_id","in":"path","description":"A unique numeric ID that can be used to identify and reference an action","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/actions/{action_id}"},"summary":"Retrieve an Existing Action","description":"To retrieve a specific action object send a GET request to `/v2/actions/$ACTION_ID`.","security":[{"bearerAuth":[]}]}},"/v2/apps":{"get":{"tags":["Apps"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}},{"name":"with_projects","in":"query","description":"Whether the project_id of listed apps should be fetched and included","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps"},"summary":"List All Apps","description":"List all apps on your account.","security":[{"bearerAuth":[]}]},"post":{"tags":["Apps"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps"},"summary":"Create a New App","description":"Create a new app by submitting an app specification.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"project_id":{"type":"string","description":"The ID of the project the app should be assigned to"},"spec":{"type":"object","description":"The desired configuration of an application","required":true,"properties":{}}}},"example":{"project_id":"","spec":{}}}}}}},"/v2/apps/{id}":{"delete":{"tags":["Apps"],"parameters":[{"name":"id","in":"path","description":"The ID of the app","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{id}"},"summary":"Delete an App","description":"Delete an existing app.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Apps"],"parameters":[{"name":"id","in":"path","description":"The ID of the app","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"The name of the app to retrieve","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{id}"},"summary":"Retrieve an Existing App","description":"Retrieve details about an existing app by either its ID or name.","security":[{"bearerAuth":[]}]},"put":{"tags":["Apps"],"parameters":[{"name":"id","in":"path","description":"The ID of the app","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{id}"},"summary":"Update an App","description":"Update an existing app by submitting a new app specification.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"spec":{"type":"object","description":"The desired configuration of an application","required":true,"properties":{}}}},"example":{"spec":{}}}}}}},"/v2/apps/{app_id}/components/{component_name}/logs":{"get":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}},{"name":"component_name","in":"path","description":"An optional component name","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"The type of logs to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"follow","in":"query","description":"Whether the logs should follow live updates","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"pod_connection_timeout","in":"query","description":"An optional time duration to wait if the underlying component instance is not immediately available","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/components/{component_name}/logs"},"summary":"Retrieve Active Deployment Logs","description":"Retrieve the logs of the active deployment if one exists.","security":[{"bearerAuth":[]}]}},"/v2/apps/{app_id}/deployments":{"get":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/deployments"},"summary":"List App Deployments","description":"List all deployments of an app.","security":[{"bearerAuth":[]}]},"post":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/deployments"},"summary":"Create an App Deployment","description":"Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"force_build":{"type":"boolean","enum":[true,false]}}},"example":{"force_build":""}}}}}},"/v2/apps/{app_id}/deployments/{deployment_id}":{"get":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}},{"name":"deployment_id","in":"path","description":"The deployment ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/deployments/{deployment_id}"},"summary":"Retrieve an App Deployment","description":"Retrieve information about an app deployment.","security":[{"bearerAuth":[]}]}},"/v2/apps/{app_id}/deployments/{deployment_id}/cancel":{"post":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}},{"name":"deployment_id","in":"path","description":"The deployment ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/deployments/{deployment_id}/cancel"},"summary":"Cancel a Deployment","description":"Immediately cancel an in-progress deployment.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs":{"get":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}},{"name":"component_name","in":"path","description":"An optional component name","required":true,"schema":{"type":"string","example":""}},{"name":"deployment_id","in":"path","description":"The deployment ID","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"The type of logs to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"follow","in":"query","description":"Whether the logs should follow live updates","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"pod_connection_timeout","in":"query","description":"An optional time duration to wait if the underlying component instance is not immediately available","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs"},"summary":"Retrieve Deployment Logs","description":"Retrieve the logs of a past in-progress or active deployment.","security":[{"bearerAuth":[]}]}},"/v2/apps/{app_id}/deployments/{deployment_id}/logs":{"get":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}},{"name":"deployment_id","in":"path","description":"The deployment ID","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"The type of logs to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"follow","in":"query","description":"Whether the logs should follow live updates","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"pod_connection_timeout","in":"query","description":"An optional time duration to wait if the underlying component instance is not immediately available","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/deployments/{deployment_id}/logs"},"summary":"Retrieve Aggregate Deployment Logs","description":"Retrieve the logs of a past in-progress or active deployment.","security":[{"bearerAuth":[]}]}},"/v2/apps/{app_id}/logs":{"get":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"The type of logs to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"follow","in":"query","description":"Whether the logs should follow live updates","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"pod_connection_timeout","in":"query","description":"An optional time duration to wait if the underlying component instance is not immediately available","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/logs"},"summary":"Retrieve Active Deployment Aggregate Logs","description":"Retrieve the logs of the active deployment if one exists.","security":[{"bearerAuth":[]}]}},"/v2/apps/tiers":{"get":{"tags":["Apps"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/tiers"},"summary":"List App Tiers","description":"List all app tiers.","security":[{"bearerAuth":[]}]}},"/v2/apps/tiers/{slug}":{"get":{"tags":["Apps"],"parameters":[{"name":"slug","in":"path","description":"The slug of the tier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/tiers/{slug}"},"summary":"Retrieve an App Tier","description":"Retrieve information about a specific app tier.","security":[{"bearerAuth":[]}]}},"/v2/apps/tiers/instance_sizes":{"get":{"tags":["Apps"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/tiers/instance_sizes"},"summary":"List Instance Sizes","description":"List all instance sizes for `service` `worker` and `job` components.","security":[{"bearerAuth":[]}]}},"/v2/apps/tiers/instance_sizes/{slug}":{"get":{"tags":["Apps"],"parameters":[{"name":"slug","in":"path","description":"The slug of the instance size","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/tiers/instance_sizes/{slug}"},"summary":"Retrieve an Instance Size","description":"Retrieve information about a specific instance size for `service` `worker` and `job` components.","security":[{"bearerAuth":[]}]}},"/v2/apps/regions":{"get":{"tags":["Apps"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/regions"},"summary":"List App Regions","description":"List all regions supported by App Platform.","security":[{"bearerAuth":[]}]}},"/v2/apps/propose":{"post":{"tags":["Apps"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/propose"},"summary":"Propose an App Spec","description":"To propose and validate a spec for a new or existing app send a POST request to the `/v2/apps/propose` endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"app_id":{"type":"string","description":"An optional ID of an existing app"},"spec":{"type":"object","description":"The desired configuration of an application","required":true,"properties":{}}}},"example":{"app_id":"","spec":{}}}}}}},"/v2/apps/{app_id}/alerts":{"get":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/alerts"},"summary":"List all app alerts","description":"List alerts associated to the app and any components.","security":[{"bearerAuth":[]}]}},"/v2/apps/{app_id}/alerts/{alert_id}/destinations":{"post":{"tags":["Apps"],"parameters":[{"name":"alert_id","in":"path","description":"The alert ID","required":true,"schema":{"type":"string","example":""}},{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/alerts/{alert_id}/destinations"},"summary":"Update destinations for alerts","description":"Updates the emails and slack webhook destinations for app alerts.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","items":{"type":"string"}},"slack_webhooks":{"type":"array","items":{"type":"string"}}}},"example":{"emails":[],"slack_webhooks":[]}}}}}},"/v2/apps/{app_id}/rollback":{"post":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/rollback"},"summary":"Rollback App","description":"Rollback an app to a previous deployment.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deployment_id":{"type":"string","description":"The ID of the deployment to rollback to"},"skip_pin":{"type":"boolean","description":"Whether to skip pinning the rollback deployment","enum":[true,false]}}},"example":{"deployment_id":"","skip_pin":""}}}}}},"/v2/apps/{app_id}/rollback/validate":{"post":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/rollback/validate"},"summary":"Validate App Rollback","description":"Check whether an app can be rolled back to a specific deployment.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deployment_id":{"type":"string","description":"The ID of the deployment to rollback to"},"skip_pin":{"type":"boolean","description":"Whether to skip pinning the rollback deployment","enum":[true,false]}}},"example":{"deployment_id":"","skip_pin":""}}}}}},"/v2/apps/{app_id}/rollback/commit":{"post":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/rollback/commit"},"summary":"Commit App Rollback","description":"Commit an app rollback.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/apps/{app_id}/rollback/revert":{"post":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/rollback/revert"},"summary":"Revert App Rollback","description":"Revert an app rollback.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/apps/{app_id}/metrics/bandwidth_daily":{"get":{"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app ID","required":true,"schema":{"type":"string","example":""}},{"name":"date","in":"query","description":"Optional day to query","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/{app_id}/metrics/bandwidth_daily"},"summary":"Retrieve App Daily Bandwidth Metrics","description":"Retrieve daily bandwidth usage metrics for a single app.","security":[{"bearerAuth":[]}]}},"/v2/apps/metrics/bandwidth_daily":{"post":{"tags":["Apps"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/apps/metrics/bandwidth_daily"},"summary":"Retrieve Multiple Apps' Daily Bandwidth Metrics","description":"Retrieve daily bandwidth usage metrics for multiple apps.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"app_ids":{"type":"array","description":"A list of app IDs to query bandwidth metrics for","required":true,"items":{"type":"string"}},"date":{"type":"string","description":"Optional day to query"}}},"example":{"app_ids":[],"date":""}}}}}},"/v2/customers/my/balance":{"get":{"tags":["Billing"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/customers/my/balance"},"summary":"Get Customer Balance","description":"To retrieve the balances on a customer's account send a GET request to `/v2/customers/my/balance`.","security":[{"bearerAuth":[]}]}},"/v2/customers/my/billing_history":{"get":{"tags":["Billing"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/customers/my/billing_history"},"summary":"List Billing History","description":"To retrieve a list of all billing history entries send a GET request to `/v2/customers/my/billing_history`.","security":[{"bearerAuth":[]}]}},"/v2/customers/my/invoices":{"get":{"tags":["Billing"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/customers/my/invoices"},"summary":"List All Invoices","description":"To retrieve a list of all invoices send a GET request to `/v2/customers/my/invoices`.","security":[{"bearerAuth":[]}]}},"/v2/customers/my/invoices/{invoice_uuid}":{"get":{"tags":["Billing"],"parameters":[{"name":"invoice_uuid","in":"path","description":"UUID of the invoice","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/customers/my/invoices/{invoice_uuid}"},"summary":"Retrieve an Invoice by UUID","description":"To retrieve the invoice items for an invoice send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID`.","security":[{"bearerAuth":[]}]}},"/v2/customers/my/invoices/{invoice_uuid}/csv":{"get":{"tags":["Billing"],"parameters":[{"name":"invoice_uuid","in":"path","description":"UUID of the invoice","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/customers/my/invoices/{invoice_uuid}/csv"},"summary":"Retrieve an Invoice CSV by UUID","description":"To retrieve a CSV for an invoice send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/csv`.","security":[{"bearerAuth":[]}]}},"/v2/customers/my/invoices/{invoice_uuid}/pdf":{"get":{"tags":["Billing"],"parameters":[{"name":"invoice_uuid","in":"path","description":"UUID of the invoice","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/customers/my/invoices/{invoice_uuid}/pdf"},"summary":"Retrieve an Invoice PDF by UUID","description":"To retrieve a PDF for an invoice send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/pdf`.","security":[{"bearerAuth":[]}]}},"/v2/customers/my/invoices/{invoice_uuid}/summary":{"get":{"tags":["Billing"],"parameters":[{"name":"invoice_uuid","in":"path","description":"UUID of the invoice","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/customers/my/invoices/{invoice_uuid}/summary"},"summary":"Retrieve an Invoice Summary by UUID","description":"To retrieve a summary for an invoice send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/summary`.","security":[{"bearerAuth":[]}]}},"/v2/volumes":{"get":{"tags":["Block Storage"],"parameters":[{"name":"name","in":"query","description":"The block storage volume's name","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}},{"name":"region","in":"query","description":"The slug identifier for the region where the resource is available","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes"},"summary":"List All Block Storage Volumes","description":"To list all of the block storage volumes available on your account send a GET request to `/v2/volumes`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Block Storage"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes"},"summary":"Create a New Block Storage Volume","description":"To create a new volume send a POST request to `/v2/volumes`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Block Storage"],"parameters":[{"name":"name","in":"query","description":"The block storage volume's name","schema":{"type":"string","example":""}},{"name":"region","in":"query","description":"The slug identifier for the region where the resource is available","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes"},"summary":"Delete a Block Storage Volume by Name","description":"Block storage volumes may also be deleted by name by sending a DELETE request with the volume's **name** and the **region slug** for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME&region=nyc1`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/volumes/snapshots/{snapshot_id}":{"get":{"tags":["Block Storage"],"parameters":[{"name":"snapshot_id","in":"path","description":"Either the ID of an existing snapshot","required":true,"schema":{"type":"","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes/snapshots/{snapshot_id}"},"summary":"Retrieve an Existing Volume Snapshot","description":"To retrieve the details of a snapshot that has been created from a volume send a GET request to `/v2/volumes/snapshots/$SNAPSHOT_ID`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Block Storage"],"parameters":[{"name":"snapshot_id","in":"path","description":"Either the ID of an existing snapshot","required":true,"schema":{"type":"","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes/snapshots/{snapshot_id}"},"summary":"Delete a Volume Snapshot","description":"To delete a volume snapshot send a DELETE request to\n`/v2/snapshots/$SNAPSHOT_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/volumes/{volume_id}":{"get":{"tags":["Block Storage"],"parameters":[{"name":"volume_id","in":"path","description":"The ID of the block storage volume","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes/{volume_id}"},"summary":"Retrieve an Existing Block Storage Volume","description":"To show information about a block storage volume send a GET request to `/v2/volumes/$VOLUME_ID`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Block Storage"],"parameters":[{"name":"volume_id","in":"path","description":"The ID of the block storage volume","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes/{volume_id}"},"summary":"Delete a Block Storage Volume","description":"To delete a block storage volume destroying all data and removing it from your account send a DELETE request to `/v2/volumes/$VOLUME_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/volumes/{volume_id}/snapshots":{"get":{"tags":["Block Storage"],"parameters":[{"name":"volume_id","in":"path","description":"The ID of the block storage volume","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes/{volume_id}/snapshots"},"summary":"List Snapshots for a Volume","description":"To retrieve the snapshots that have been created from a volume send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Block Storage"],"parameters":[{"name":"volume_id","in":"path","description":"The ID of the block storage volume","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes/{volume_id}/snapshots"},"summary":"Create Snapshot from a Volume","description":"To create a snapshot from a volume sent a POST request to `/v2/volumes/$VOLUME_ID/snapshots`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"A human-readable name for the volume snapshot","required":true},"tags":{"type":"array","description":"A flat array of tag names as strings to be applied to the resource","items":{"type":"string"}}}},"example":{"name":"","tags":[]}}}}}},"/v2/volumes/actions":{"post":{"tags":["Block Storage Actions"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes/actions"},"summary":"Initiate A Block Storage Action By Volume Name","description":"To initiate an action on a block storage volume by Name send a POST request to\n`~/v2/volumes/actions`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/volumes/{volume_id}/actions":{"get":{"tags":["Block Storage Actions"],"parameters":[{"name":"volume_id","in":"path","description":"The ID of the block storage volume","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes/{volume_id}/actions"},"summary":"List All Actions for a Volume","description":"To retrieve all actions that have been executed on a volume send a GET request to `/v2/volumes/$VOLUME_ID/actions`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Block Storage Actions"],"parameters":[{"name":"volume_id","in":"path","description":"The ID of the block storage volume","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes/{volume_id}/actions"},"summary":"Initiate A Block Storage Action By Volume Id","description":"To initiate an action on a block storage volume by Id send a POST request to\n`~/v2/volumes/$VOLUME_ID/actions`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/volumes/{volume_id}/actions/{action_id}":{"get":{"tags":["Block Storage Actions"],"parameters":[{"name":"action_id","in":"path","description":"A unique numeric ID that can be used to identify and reference an action","required":true,"schema":{"type":"number","example":""}},{"name":"volume_id","in":"path","description":"The ID of the block storage volume","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/volumes/{volume_id}/actions/{action_id}"},"summary":"Retrieve an Existing Volume Action","description":"To retrieve the status of a volume action send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`.","security":[{"bearerAuth":[]}]}},"/v2/cdn/endpoints":{"get":{"tags":["CDN Endpoints"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/cdn/endpoints"},"summary":"List All CDN Endpoints","description":"To list all of the CDN endpoints available on your account send a GET request to `/v2/cdn/endpoints`.","security":[{"bearerAuth":[]}]},"post":{"tags":["CDN Endpoints"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/cdn/endpoints"},"summary":"Create a New CDN Endpoint","description":"To create a new CDN endpoint send a POST request to `/v2/cdn/endpoints`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"certificate_id":{"type":"string","description":"The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided"},"created_at":{"type":"string","description":"A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created"},"custom_domain":{"type":"string","description":"The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint"},"endpoint":{"type":"string","description":"The fully qualified domain name (FQDN) from which the CDN-backed content is served"},"id":{"type":"string","description":"A unique ID that can be used to identify and reference a CDN endpoint"},"origin":{"type":"string","description":"The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN","required":true},"ttl":{"type":"number","description":"The amount of time the content is cached by the CDN's edge servers in seconds"}}},"example":{"certificate_id":"","created_at":"","custom_domain":"","endpoint":"","id":"","origin":"","ttl":""}}}}}},"/v2/cdn/endpoints/{cdn_id}":{"get":{"tags":["CDN Endpoints"],"parameters":[{"name":"cdn_id","in":"path","description":"A unique identifier for a CDN endpoint","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/cdn/endpoints/{cdn_id}"},"summary":"Retrieve an Existing CDN Endpoint","description":"To show information about an existing CDN endpoint send a GET request to `/v2/cdn/endpoints/$ENDPOINT_ID`.","security":[{"bearerAuth":[]}]},"put":{"tags":["CDN Endpoints"],"parameters":[{"name":"cdn_id","in":"path","description":"A unique identifier for a CDN endpoint","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/cdn/endpoints/{cdn_id}"},"summary":"Update a CDN Endpoint","description":"To update the TTL certificate ID or the FQDN of the custom subdomain for an existing CDN endpoint send a PUT request to `/v2/cdn/endpoints/$ENDPOINT_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"certificate_id":{"type":"string","description":"The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided"},"custom_domain":{"type":"string","description":"The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint"},"ttl":{"type":"number","description":"The amount of time the content is cached by the CDN's edge servers in seconds"}}},"example":{"certificate_id":"","custom_domain":"","ttl":""}}}}},"delete":{"tags":["CDN Endpoints"],"parameters":[{"name":"cdn_id","in":"path","description":"A unique identifier for a CDN endpoint","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/cdn/endpoints/{cdn_id}"},"summary":"Delete a CDN Endpoint","description":"To delete a specific CDN endpoint send a DELETE request to\n`/v2/cdn/endpoints/$ENDPOINT_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/cdn/endpoints/{cdn_id}/cache":{"delete":{"tags":["CDN Endpoints"],"parameters":[{"name":"cdn_id","in":"path","description":"A unique identifier for a CDN endpoint","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/cdn/endpoints/{cdn_id}/cache"},"summary":"Purge the Cache for an Existing CDN Endpoint","description":"To purge cached content from a CDN endpoint send a DELETE request to\n`/v2/cdn/endpoints/$ENDPOINT_ID/cache`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"files":{"type":"array","description":"An array of strings containing the path to the content to be purged from the CDN cache","required":true,"items":{"type":"string"}}}},"example":{"files":[]}}}}}},"/v2/certificates":{"get":{"tags":["Certificates"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/certificates"},"summary":"List All Certificates","description":"To list all of the certificates available on your account send a GET request to `/v2/certificates`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Certificates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/certificates"},"summary":"Create a New Certificate","description":"To upload new SSL certificate which you have previously generated send a POST\nrequest to `/v2/certificates`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/certificates/{certificate_id}":{"get":{"tags":["Certificates"],"parameters":[{"name":"certificate_id","in":"path","description":"A unique identifier for a certificate","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/certificates/{certificate_id}"},"summary":"Retrieve an Existing Certificate","description":"To show information about an existing certificate send a GET request to `/v2/certificates/$CERTIFICATE_ID`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Certificates"],"parameters":[{"name":"certificate_id","in":"path","description":"A unique identifier for a certificate","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/certificates/{certificate_id}"},"summary":"Delete a Certificate","description":"To delete a specific certificate send a DELETE request to\n`/v2/certificates/$CERTIFICATE_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/registry":{"get":{"tags":["Container Registry"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry"},"summary":"Get Container Registry Information","description":"To get information about your container registry send a GET request to `/v2/registry`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Container Registry"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry"},"summary":"Create Container Registry","description":"To create your container registry send a POST request to `/v2/registry`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"A globally unique name for the container registry","required":true},"region":{"type":"string","description":"Slug of the region where registry data is stored"},"subscription_tier_slug":{"type":"string","description":"The slug of the subscription tier to sign up for","required":true}}},"example":{"name":"","region":"","subscription_tier_slug":""}}}}},"delete":{"tags":["Container Registry"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry"},"summary":"Delete Container Registry","description":"To delete your container registry destroying all container image data stored in it send a DELETE request to `/v2/registry`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/registry/subscription":{"get":{"tags":["Container Registry"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/subscription"},"summary":"Get Subscription Information","description":"A subscription is automatically created when you configure your container registry.","security":[{"bearerAuth":[]}]},"post":{"tags":["Container Registry"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/subscription"},"summary":"Update Subscription Tier","description":"After creating your registry you can switch to a different subscription tier to better suit your needs.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tier_slug":{"type":"string","description":"The slug of the subscription tier to sign up for"}}},"example":{"tier_slug":""}}}}}},"/v2/registry/docker-credentials":{"get":{"tags":["Container Registry"],"parameters":[{"name":"expiry_seconds","in":"query","description":"The duration in seconds that the returned registry credentials will be valid","schema":{"type":"number","example":""}},{"name":"read_write","in":"query","description":"By default the registry credentials allow for read-only access","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/docker-credentials"},"summary":"Get Docker Credentials for Container Registry","description":"In order to access your container registry with the Docker client or from a\nKubernetes cluster you will need to configure authentication.","security":[{"bearerAuth":[]}]}},"/v2/registry/validate-name":{"post":{"tags":["Container Registry"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/validate-name"},"summary":"Validate a Container Registry Name","description":"To validate that a container registry name is available for use send a POST\nrequest to `/v2/registry/validate-name`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"A globally unique name for the container registry","required":true}}},"example":{"name":""}}}}}},"/v2/registry/{registry_name}/repositories":{"get":{"tags":["Container Registry"],"parameters":[{"name":"registry_name","in":"path","description":"The name of a container registry","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/{registry_name}/repositories"},"summary":"List All Container Registry Repositories","description":"This endpoint has been deprecated in favor of the _List All Container Registry Repositories [V2]_ endpoint.","security":[{"bearerAuth":[]}]}},"/v2/registry/{registry_name}/repositoriesV2":{"get":{"tags":["Container Registry"],"parameters":[{"name":"registry_name","in":"path","description":"The name of a container registry","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"page_token","in":"query","description":"Token to retrieve of the next or previous set of results more quickly than using 'page'","schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/{registry_name}/repositoriesV2"},"summary":"List All Container Registry Repositories (V2)","description":"To list all repositories in your container registry send a GET request to `/v2/registry/$REGISTRY_NAME/repositoriesV2`.","security":[{"bearerAuth":[]}]}},"/v2/registry/{registry_name}/{repository_name}/tags":{"get":{"tags":["Container Registry"],"parameters":[{"name":"registry_name","in":"path","description":"The name of a container registry","required":true,"schema":{"type":"string","example":""}},{"name":"repository_name","in":"path","description":"The name of a container registry repository","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/{registry_name}/{repository_name}/tags"},"summary":"List All Container Registry Repository Tags","description":"To list all tags in your container registry repository send a GET\nrequest to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`.","security":[{"bearerAuth":[]}]}},"/v2/registry/{registry_name}/{repository_name}/tags/{repository_tag}":{"delete":{"tags":["Container Registry"],"parameters":[{"name":"registry_name","in":"path","description":"The name of a container registry","required":true,"schema":{"type":"string","example":""}},{"name":"repository_name","in":"path","description":"The name of a container registry repository","required":true,"schema":{"type":"string","example":""}},{"name":"repository_tag","in":"path","description":"The name of a container registry repository tag","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/{registry_name}/{repository_name}/tags/{repository_tag}"},"summary":"Delete Container Registry Repository Tag","description":"To delete a container repository tag send a DELETE request to\n`/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/registry/{registry_name}/{repository_name}/digests":{"get":{"tags":["Container Registry"],"parameters":[{"name":"registry_name","in":"path","description":"The name of a container registry","required":true,"schema":{"type":"string","example":""}},{"name":"repository_name","in":"path","description":"The name of a container registry repository","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/{registry_name}/{repository_name}/digests"},"summary":"List All Container Registry Repository Manifests","description":"To list all manifests in your container registry repository send a GET\nrequest to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`.","security":[{"bearerAuth":[]}]}},"/v2/registry/{registry_name}/{repository_name}/digests/{manifest_digest}":{"delete":{"tags":["Container Registry"],"parameters":[{"name":"manifest_digest","in":"path","description":"The manifest digest of a container registry repository tag","required":true,"schema":{"type":"string","example":""}},{"name":"registry_name","in":"path","description":"The name of a container registry","required":true,"schema":{"type":"string","example":""}},{"name":"repository_name","in":"path","description":"The name of a container registry repository","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/{registry_name}/{repository_name}/digests/{manifest_digest}"},"summary":"Delete Container Registry Repository Manifest","description":"To delete a container repository manifest by digest send a DELETE request to\n`/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/registry/{registry_name}/garbage-collection":{"post":{"tags":["Container Registry"],"parameters":[{"name":"registry_name","in":"path","description":"The name of a container registry","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/{registry_name}/garbage-collection"},"summary":"Start Garbage Collection","description":"Garbage collection enables users to clear out unreferenced blobs (layer &\nmanifest data) after deleting one or more manifests from a repository.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Container Registry"],"parameters":[{"name":"registry_name","in":"path","description":"The name of a container registry","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/{registry_name}/garbage-collection"},"summary":"Get Active Garbage Collection","description":"To get information about the currently-active garbage collection for a registry send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`.","security":[{"bearerAuth":[]}]}},"/v2/registry/{registry_name}/garbage-collections":{"get":{"tags":["Container Registry"],"parameters":[{"name":"registry_name","in":"path","description":"The name of a container registry","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/{registry_name}/garbage-collections"},"summary":"List Garbage Collections","description":"To get information about past garbage collections for a registry send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`.","security":[{"bearerAuth":[]}]}},"/v2/registry/{registry_name}/garbage-collection/{garbage_collection_uuid}":{"put":{"tags":["Container Registry"],"parameters":[{"name":"garbage_collection_uuid","in":"path","description":"The UUID of a garbage collection run","required":true,"schema":{"type":"string","example":""}},{"name":"registry_name","in":"path","description":"The name of a container registry","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/{registry_name}/garbage-collection/{garbage_collection_uuid}"},"summary":"Update Garbage Collection","description":"To cancel the currently-active garbage collection for a registry send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cancel":{"type":"boolean","description":"A boolean value indicating that the garbage collection should be cancelled","enum":[true,false]}}},"example":{"cancel":""}}}}}},"/v2/registry/options":{"get":{"tags":["Container Registry"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/registry/options"},"summary":"List Registry Options (Subscription Tiers and Available Regions)","description":"This endpoint serves to provide additional information as to which option values are available when creating a container registry.","security":[{"bearerAuth":[]}]}},"/v2/databases/options":{"get":{"tags":["Databases"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/options"},"summary":"List Database Options","description":"To list all of the options available for the offered database engines send a GET request to `/v2/databases/options`.","security":[{"bearerAuth":[]}]}},"/v2/databases":{"get":{"tags":["Databases"],"parameters":[{"name":"tag_name","in":"query","description":"Limits the results to database clusters with a specific tag","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases"},"summary":"List All Database Clusters","description":"To list all of the database clusters available on your account send a GET request to `/v2/databases`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Databases"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases"},"summary":"Create a New Database Cluster","description":"To create a database cluster send a POST request to `/v2/databases`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/databases/{database_cluster_uuid}":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}"},"summary":"Retrieve an Existing Database Cluster","description":"To show information about an existing database cluster send a GET request to `/v2/databases/$DATABASE_ID`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}"},"summary":"Destroy a Database Cluster","description":"To destroy a specific database send a DELETE request to `/v2/databases/$DATABASE_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/databases/{database_cluster_uuid}/config":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/config"},"summary":"Retrieve an Existing Database Cluster Configuration","description":"Shows configuration parameters for an existing database cluster by sending a GET request to\n`/v2/databases/$DATABASE_ID/config`.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/config"},"summary":"Update the Database Configuration for an Existing Database","description":"To update the configuration for an existing database cluster send a PATCH request to\n`/v2/databases/$DATABASE_ID/config`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"config":{"type":"string"}}},"example":{"config":""}}}}}},"/v2/databases/{database_cluster_uuid}/ca":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/ca"},"summary":"Retrieve the Public Certificate","description":"To retrieve the public certificate used to secure the connection to the database cluster send a GET request to\n`/v2/databases/$DATABASE_ID/ca`.","security":[{"bearerAuth":[]}]}},"/v2/databases/{database_cluster_uuid}/online-migration":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/online-migration"},"summary":"Retrieve the Status of an Online Migration","description":"To retrieve the status of the most recent online migration send a GET request to `/v2/databases/$DATABASE_ID/online-migration`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/online-migration"},"summary":"Start an Online Migration","description":"To start an online migration send a PUT request to `/v2/databases/$DATABASE_ID/online-migration` endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"disable_ssl":{"type":"boolean","description":"Enables SSL encryption when connecting to the source database","enum":[true,false]},"source":{"type":"object","properties":{}}}},"example":{"disable_ssl":"","source":{}}}}}}},"/v2/databases/{database_cluster_uuid}/online-migration/{migration_id}":{"delete":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"migration_id","in":"path","description":"A unique identifier assigned to the online migration","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/online-migration/{migration_id}"},"summary":"Stop an Online Migration","description":"To stop an online migration send a DELETE request to `/v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/databases/{database_cluster_uuid}/migrate":{"put":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/migrate"},"summary":"Migrate a Database Cluster to a New Region","description":"To migrate a database cluster to a new region send a `PUT` request to\n`/v2/databases/$DATABASE_ID/migrate`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"region":{"type":"string","description":"A slug identifier for the region to which the database cluster will be migrated","required":true}}},"example":{"region":""}}}}}},"/v2/databases/{database_cluster_uuid}/resize":{"put":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/resize"},"summary":"Resize a Database Cluster","description":"To resize a database cluster send a PUT request to `/v2/databases/$DATABASE_ID/resize`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"num_nodes":{"type":"number","description":"The number of nodes in the database cluster","required":true},"size":{"type":"string","description":"A slug identifier representing desired the size of the nodes in the database cluster","required":true}}},"example":{"num_nodes":"","size":""}}}}}},"/v2/databases/{database_cluster_uuid}/firewall":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/firewall"},"summary":"List Firewall Rules (Trusted Sources) for a Database Cluster","description":"To list all of a database cluster's firewall rules (known as \"trusted sources\" in the control panel) send a GET request to `/v2/databases/$DATABASE_ID/firewall`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/firewall"},"summary":"Update Firewall Rules (Trusted Sources) for a Database","description":"To update a database cluster's firewall rules (known as \"trusted sources\" in the control panel) send a PUT request to `/v2/databases/$DATABASE_ID/firewall` specifying which resources should be able to open connections to the database.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"rules":{"type":"array","items":{"type":"string"}}}},"example":{"rules":[]}}}}}},"/v2/databases/{database_cluster_uuid}/maintenance":{"put":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/maintenance"},"summary":"Configure a Database Cluster's Maintenance Window","description":"To configure the window when automatic maintenance should be performed for a database cluster send a PUT request to `/v2/databases/$DATABASE_ID/maintenance`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"day":{"type":"string","description":"The day of the week on which to apply maintenance updates","required":true},"description":{"type":"array","description":"A list of strings each containing information about a pending maintenance update","items":{"type":"string"}},"hour":{"type":"string","description":"The hour in UTC at which maintenance updates will be applied in 24 hour format","required":true},"pending":{"type":"boolean","description":"A boolean value indicating whether any maintenance is scheduled to be performed in the next window","enum":[true,false]}}},"example":{"day":"","description":[],"hour":"","pending":""}}}}}},"/v2/databases/{database_cluster_uuid}/backups":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/backups"},"summary":"List Backups for a Database Cluster","description":"To list all of the available backups of a PostgreSQL or MySQL database cluster send a GET request to `/v2/databases/$DATABASE_ID/backups`.","security":[{"bearerAuth":[]}]}},"/v2/databases/{database_cluster_uuid}/replicas":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/replicas"},"summary":"List All Read-only Replicas","description":"To list all of the read-only replicas associated with a database cluster send a GET request to `/v2/databases/$DATABASE_ID/replicas`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/replicas"},"summary":"Create a Read-only Replica","description":"To create a read-only replica for a PostgreSQL or MySQL database cluster send a POST request to `/v2/databases/$DATABASE_ID/replicas` specifying the name it should be given the size of the node to be used and the region where it will be located.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/databases/{database_cluster_uuid}/replicas/{replica_name}":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"replica_name","in":"path","description":"The name of the database replica","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/replicas/{replica_name}"},"summary":"Retrieve an Existing Read-only Replica","description":"To show information about an existing database replica send a GET request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"replica_name","in":"path","description":"The name of the database replica","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/replicas/{replica_name}"},"summary":"Destroy a Read-only Replica","description":"To destroy a specific read-only replica send a DELETE request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/databases/{database_cluster_uuid}/replicas/{replica_name}/promote":{"put":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"replica_name","in":"path","description":"The name of the database replica","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/replicas/{replica_name}/promote"},"summary":"Promote a Read-only Replica to become a Primary Cluster","description":"To promote a specific read-only replica send a PUT request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/databases/{database_cluster_uuid}/users":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/users"},"summary":"List all Database Users","description":"To list all of the users for your database cluster send a GET request to\n`/v2/databases/$DATABASE_ID/users`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/users"},"summary":"Add a Database User","description":"To add a new database user send a POST request to `/v2/databases/$DATABASE_ID/users`\nwith the desired username.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"mysql_settings":{"type":"object","properties":{}},"name":{"type":"string","description":"The name of a database user","required":true},"password":{"type":"string","description":"A randomly generated password for the database user"},"role":{"type":"string","description":"A string representing the database user's role"}}},"example":{"mysql_settings":{},"name":"","password":"","role":""}}}}}},"/v2/databases/{database_cluster_uuid}/users/{username}":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The name of the database user","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/users/{username}"},"summary":"Retrieve an Existing Database User","description":"To show information about an existing database user send a GET request to\n`/v2/databases/$DATABASE_ID/users/$USERNAME`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The name of the database user","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/users/{username}"},"summary":"Remove a Database User","description":"To remove a specific database user send a DELETE request to\n`/v2/databases/$DATABASE_ID/users/$USERNAME`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/databases/{database_cluster_uuid}/users/{username}/reset_auth":{"post":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The name of the database user","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/users/{username}/reset_auth"},"summary":"Reset a Database User's Password or Authentication Method","description":"To reset the password for a database user send a POST request to\n`/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"mysql_settings":{"type":"object","properties":{}}}},"example":{"mysql_settings":{}}}}}}},"/v2/databases/{database_cluster_uuid}/dbs":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/dbs"},"summary":"List All Databases","description":"To list all of the databases in a clusters send a GET request to\n`/v2/databases/$DATABASE_ID/dbs`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/dbs"},"summary":"Add a New Database","description":"To add a new database to an existing cluster send a POST request to\n`/v2/databases/$DATABASE_ID/dbs`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the database","required":true}}},"example":{"name":""}}}}}},"/v2/databases/{database_cluster_uuid}/dbs/{database_name}":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"database_name","in":"path","description":"The name of the database","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/dbs/{database_name}"},"summary":"Retrieve an Existing Database","description":"To show information about an existing database cluster send a GET request to\n`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"database_name","in":"path","description":"The name of the database","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/dbs/{database_name}"},"summary":"Delete a Database","description":"To delete a specific database send a DELETE request to\n`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/databases/{database_cluster_uuid}/pools":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/pools"},"summary":"List Connection Pools (PostgreSQL)","description":"To list all of the connection pools available to a PostgreSQL database cluster send a GET request to `/v2/databases/$DATABASE_ID/pools`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/pools"},"summary":"Add a New Connection Pool (PostgreSQL)","description":"For PostgreSQL database clusters connection pools can be used to allow a\ndatabase to share its idle connections.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"connection":{"type":"string"},"db":{"type":"string","description":"The database for use with the connection pool","required":true},"mode":{"type":"string","description":"The PGBouncer transaction mode for the connection pool","required":true},"name":{"type":"string","description":"A unique name for the connection pool","required":true},"private_connection":{"type":"string"},"size":{"type":"number","description":"The desired size of the PGBouncer connection pool","required":true},"user":{"type":"string","description":"The name of the user for use with the connection pool"}}},"example":{"connection":"","db":"","mode":"","name":"","private_connection":"","size":"","user":""}}}}}},"/v2/databases/{database_cluster_uuid}/pools/{pool_name}":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"pool_name","in":"path","description":"The name used to identify the connection pool","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/pools/{pool_name}"},"summary":"Retrieve Existing Connection Pool (PostgreSQL)","description":"To show information about an existing connection pool for a PostgreSQL database cluster send a GET request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"pool_name","in":"path","description":"The name used to identify the connection pool","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/pools/{pool_name}"},"summary":"Update Connection Pools (PostgreSQL)","description":"To update a connection pool for a PostgreSQL database cluster send a PUT request to  `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"db":{"type":"string","description":"The database for use with the connection pool","required":true},"mode":{"type":"string","description":"The PGBouncer transaction mode for the connection pool","required":true},"size":{"type":"number","description":"The desired size of the PGBouncer connection pool","required":true},"user":{"type":"string","description":"The name of the user for use with the connection pool"}}},"example":{"db":"","mode":"","size":"","user":""}}}}},"delete":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}},{"name":"pool_name","in":"path","description":"The name used to identify the connection pool","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/pools/{pool_name}"},"summary":"Delete a Connection Pool (PostgreSQL)","description":"To delete a specific connection pool for a PostgreSQL database cluster send\na DELETE request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/databases/{database_cluster_uuid}/eviction_policy":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/eviction_policy"},"summary":"Retrieve the Eviction Policy for a Redis Cluster","description":"To retrieve the configured eviction policy for an existing Redis cluster send a GET request to `/v2/databases/$DATABASE_ID/eviction_policy`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/eviction_policy"},"summary":"Configure the Eviction Policy for a Redis Cluster","description":"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"eviction_policy":{"type":"string","description":"A string specifying the desired eviction policy for the Redis cluster","required":true}}},"example":{"eviction_policy":""}}}}}},"/v2/databases/{database_cluster_uuid}/sql_mode":{"get":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/sql_mode"},"summary":"Retrieve the SQL Modes for a MySQL Cluster","description":"To retrieve the configured SQL modes for an existing MySQL cluster send a GET request to `/v2/databases/$DATABASE_ID/sql_mode`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/sql_mode"},"summary":"Update SQL Mode for a Cluster","description":"To configure the SQL modes for an existing MySQL cluster send a PUT request to `/v2/databases/$DATABASE_ID/sql_mode` specifying the desired modes.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sql_mode":{"type":"string","description":"A string specifying the configured SQL modes for the MySQL cluster","required":true}}},"example":{"sql_mode":""}}}}}},"/v2/databases/{database_cluster_uuid}/upgrade":{"put":{"tags":["Databases"],"parameters":[{"name":"database_cluster_uuid","in":"path","description":"A unique identifier for a database cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/databases/{database_cluster_uuid}/upgrade"},"summary":"Upgrade Major Version for a Database","description":"To upgrade the major version of a database send a PUT request to `/v2/databases/$DATABASE_ID/upgrade` specifying the target version.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"version":{"type":"string","description":"A string representing the version of the database engine in use for the cluster"}}},"example":{"version":""}}}}}},"/v2/domains/{domain_name}/records":{"get":{"tags":["Domain Records"],"parameters":[{"name":"domain_name","in":"path","description":"The name of the domain itself","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"The type of the DNS record","schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"A fully qualified record name","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/domains/{domain_name}/records"},"summary":"List All Domain Records","description":"To get a listing of all records configured for a domain send a GET request to `/v2/domains/$DOMAIN_NAME/records`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Domain Records"],"parameters":[{"name":"domain_name","in":"path","description":"The name of the domain itself","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/domains/{domain_name}/records"},"summary":"Create a New Domain Record","description":"To create a new record to a domain send a POST request to\n`/v2/domains/$DOMAIN_NAME/records`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/domains/{domain_name}/records/{domain_record_id}":{"get":{"tags":["Domain Records"],"parameters":[{"name":"domain_name","in":"path","description":"The name of the domain itself","required":true,"schema":{"type":"string","example":""}},{"name":"domain_record_id","in":"path","description":"The unique identifier of the domain record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/domains/{domain_name}/records/{domain_record_id}"},"summary":"Retrieve an Existing Domain Record","description":"To retrieve a specific domain record send a GET request to `/v2/domains/$DOMAIN_NAME/records/$RECORD_ID`.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Domain Records"],"parameters":[{"name":"domain_name","in":"path","description":"The name of the domain itself","required":true,"schema":{"type":"string","example":""}},{"name":"domain_record_id","in":"path","description":"The unique identifier of the domain record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/domains/{domain_name}/records/{domain_record_id}"},"summary":"Update a Domain Record","description":"To update an existing record send a PATCH request to\n`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"The type of the DNS record","required":true},"data":{"type":"string","description":"Variable data depending on record type"},"flags":{"type":"number","description":"An unsigned integer between 0-255 used for CAA records"},"id":{"type":"number","description":"A unique identifier for each domain record"},"name":{"type":"string","description":"The host name alias or service being defined by the record"},"port":{"type":"number","description":"The port for SRV records"},"priority":{"type":"number","description":"The priority for SRV and MX records"},"tag":{"type":"string","description":"The parameter tag for CAA records"},"ttl":{"type":"number","description":"This value is the time to live for the record in seconds"},"weight":{"type":"number","description":"The weight for SRV records"}}},"example":{"type":"","data":"","flags":"","id":"","name":"","port":"","priority":"","tag":"","ttl":"","weight":""}}}}},"put":{"tags":["Domain Records"],"parameters":[{"name":"domain_name","in":"path","description":"The name of the domain itself","required":true,"schema":{"type":"string","example":""}},{"name":"domain_record_id","in":"path","description":"The unique identifier of the domain record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/domains/{domain_name}/records/{domain_record_id}"},"summary":"Update a Domain Record","description":"To update an existing record send a PUT request to\n`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"The type of the DNS record","required":true},"data":{"type":"string","description":"Variable data depending on record type"},"flags":{"type":"number","description":"An unsigned integer between 0-255 used for CAA records"},"id":{"type":"number","description":"A unique identifier for each domain record"},"name":{"type":"string","description":"The host name alias or service being defined by the record"},"port":{"type":"number","description":"The port for SRV records"},"priority":{"type":"number","description":"The priority for SRV and MX records"},"tag":{"type":"string","description":"The parameter tag for CAA records"},"ttl":{"type":"number","description":"This value is the time to live for the record in seconds"},"weight":{"type":"number","description":"The weight for SRV records"}}},"example":{"type":"","data":"","flags":"","id":"","name":"","port":"","priority":"","tag":"","ttl":"","weight":""}}}}},"delete":{"tags":["Domain Records"],"parameters":[{"name":"domain_name","in":"path","description":"The name of the domain itself","required":true,"schema":{"type":"string","example":""}},{"name":"domain_record_id","in":"path","description":"The unique identifier of the domain record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/domains/{domain_name}/records/{domain_record_id}"},"summary":"Delete a Domain Record","description":"To delete a record for a domain send a DELETE request to\n`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/domains":{"get":{"tags":["Domains"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/domains"},"summary":"List All Domains","description":"To retrieve a list of all of the domains in your account send a GET request to `/v2/domains`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/domains"},"summary":"Create a New Domain","description":"To create a new domain send a POST request to `/v2/domains`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ip_address":{"type":"string","description":"This optional attribute may contain an IP address"},"name":{"type":"string","description":"The name of the domain itself"},"ttl":{"type":"number","description":"This value is the time to live for the records on this domain in seconds"},"zone_file":{"type":"string","description":"This attribute contains the complete contents of the zone file for the selected domain"}}},"example":{"ip_address":"","name":"","ttl":"","zone_file":""}}}}}},"/v2/domains/{domain_name}":{"get":{"tags":["Domains"],"parameters":[{"name":"domain_name","in":"path","description":"The name of the domain itself","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/domains/{domain_name}"},"summary":"Retrieve an Existing Domain","description":"To get details about a specific domain send a GET request to `/v2/domains/$DOMAIN_NAME`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Domains"],"parameters":[{"name":"domain_name","in":"path","description":"The name of the domain itself","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/domains/{domain_name}"},"summary":"Delete a Domain","description":"To delete a domain send a DELETE request to `/v2/domains/$DOMAIN_NAME`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/droplets/{droplet_id}/actions":{"get":{"tags":["Droplet Actions"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/actions"},"summary":"List Actions for a Droplet","description":"To retrieve a list of all actions that have been executed for a Droplet send\na GET request to `/v2/droplets/$DROPLET_ID/actions`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Droplet Actions"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/actions"},"summary":"Initiate a Droplet Action","description":"To initiate an action on a Droplet send a POST request to\n`/v2/droplets/$DROPLET_ID/actions`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/droplets/actions":{"post":{"tags":["Droplet Actions"],"parameters":[{"name":"tag_name","in":"query","description":"Used to filter Droplets by a specific tag","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/actions"},"summary":"Acting on Tagged Droplets","description":"Some actions can be performed in bulk on tagged Droplets.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/droplets/{droplet_id}/actions/{action_id}":{"get":{"tags":["Droplet Actions"],"parameters":[{"name":"action_id","in":"path","description":"A unique numeric ID that can be used to identify and reference an action","required":true,"schema":{"type":"number","example":""}},{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/actions/{action_id}"},"summary":"Retrieve a Droplet Action","description":"To retrieve a Droplet action send a GET request to\n`/v2/droplets/$DROPLET_ID/actions/$ACTION_ID`.","security":[{"bearerAuth":[]}]}},"/v2/droplets":{"get":{"tags":["Droplets"],"parameters":[{"name":"name","in":"query","description":"Used to filter list response by Droplet name returning only exact matches","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}},{"name":"tag_name","in":"query","description":"Used to filter Droplets by a specific tag","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets"},"summary":"List All Droplets","description":"To list all Droplets in your account send a GET request to `/v2/droplets`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Droplets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets"},"summary":"Create a New Droplet","description":"To create a new Droplet send a POST request to `/v2/droplets` setting the\nrequired attributes.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Droplets"],"parameters":[{"name":"tag_name","in":"query","description":"Specifies Droplets to be deleted by tag","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets"},"summary":"Deleting Droplets by Tag","description":"To delete **all** Droplets assigned to a specific tag include the `tag_name`\nquery parameter set to the name of the tag in your DELETE request.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/droplets/{droplet_id}":{"get":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}"},"summary":"Retrieve an Existing Droplet","description":"To show information about an individual Droplet send a GET request to\n`/v2/droplets/$DROPLET_ID`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}"},"summary":"Delete an Existing Droplet","description":"To delete a Droplet send a DELETE request to `/v2/droplets/$DROPLET_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/droplets/{droplet_id}/backups":{"get":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/backups"},"summary":"List Backups for a Droplet","description":"To retrieve any backups associated with a Droplet send a GET request to\n`/v2/droplets/$DROPLET_ID/backups`.","security":[{"bearerAuth":[]}]}},"/v2/droplets/{droplet_id}/snapshots":{"get":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/snapshots"},"summary":"List Snapshots for a Droplet","description":"To retrieve the snapshots that have been created from a Droplet send a GET\nrequest to `/v2/droplets/$DROPLET_ID/snapshots`.","security":[{"bearerAuth":[]}]}},"/v2/droplets/{droplet_id}/kernels":{"get":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/kernels"},"summary":"List All Available Kernels for a Droplet","description":"To retrieve a list of all kernels available to a Droplet send a GET request\nto `/v2/droplets/$DROPLET_ID/kernels`\n\nThe response will be a JSON object that has a key called `kernels`.","security":[{"bearerAuth":[]}]}},"/v2/droplets/{droplet_id}/firewalls":{"get":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/firewalls"},"summary":"List all Firewalls Applied to a Droplet","description":"To retrieve a list of all firewalls available to a Droplet send a GET request\nto `/v2/droplets/$DROPLET_ID/firewalls`\n\nThe response will be a JSON object that has a key called `firewalls`.","security":[{"bearerAuth":[]}]}},"/v2/droplets/{droplet_id}/neighbors":{"get":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/neighbors"},"summary":"List Neighbors for a Droplet","description":"To retrieve a list of any \"neighbors\" (i.","security":[{"bearerAuth":[]}]}},"/v2/droplets/{droplet_id}/destroy_with_associated_resources":{"get":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/destroy_with_associated_resources"},"summary":"List Associated Resources for a Droplet","description":"To list the associated billable resources that can be destroyed along with a\nDroplet send a GET request to the\n`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources` endpoint.","security":[{"bearerAuth":[]}]}},"/v2/droplets/{droplet_id}/destroy_with_associated_resources/selective":{"delete":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/destroy_with_associated_resources/selective"},"summary":"Selectively Destroy a Droplet and its Associated Resources","description":"To destroy a Droplet along with a sub-set of its associated resources send a\nDELETE request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/selective`\nendpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"floating_ips":{"type":"array","description":"An array of unique identifiers for the floating IPs to be scheduled for deletion","items":{"type":"string"}},"reserved_ips":{"type":"array","description":"An array of unique identifiers for the reserved IPs to be scheduled for deletion","items":{"type":"string"}},"snapshots":{"type":"array","description":"An array of unique identifiers for the snapshots to be scheduled for deletion","items":{"type":"string"}},"volume_snapshots":{"type":"array","description":"An array of unique identifiers for the volume snapshots to be scheduled for deletion","items":{"type":"string"}},"volumes":{"type":"array","description":"An array of unique identifiers for the volumes to be scheduled for deletion","items":{"type":"string"}}}},"example":{"floating_ips":[],"reserved_ips":[],"snapshots":[],"volume_snapshots":[],"volumes":[]}}}}}},"/v2/droplets/{droplet_id}/destroy_with_associated_resources/dangerous":{"delete":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/destroy_with_associated_resources/dangerous"},"summary":"Destroy a Droplet and All of its Associated Resources (Dangerous)","description":"To destroy a Droplet along with all of its associated resources send a DELETE\nrequest to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/dangerous`\nendpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/droplets/{droplet_id}/destroy_with_associated_resources/status":{"get":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/destroy_with_associated_resources/status"},"summary":"Check Status of a Droplet Destroy with Associated Resources Request","description":"To check on the status of a request to destroy a Droplet with its associated\nresources send a GET request to the\n`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status` endpoint.","security":[{"bearerAuth":[]}]}},"/v2/droplets/{droplet_id}/destroy_with_associated_resources/retry":{"post":{"tags":["Droplets"],"parameters":[{"name":"droplet_id","in":"path","description":"A unique identifier for a Droplet instance","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/droplets/{droplet_id}/destroy_with_associated_resources/retry"},"summary":"Retry a Droplet Destroy with Associated Resources Request","description":"If the status of a request to destroy a Droplet with its associated resources\nreported any errors it can be retried by sending a POST request to the\n`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry` endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/reports/droplet_neighbors_ids":{"get":{"tags":["Droplets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/reports/droplet_neighbors_ids"},"summary":"List All Droplet Neighbors","description":"To retrieve a list of all Droplets that are co-located on the same physical\nhardware send a GET request to `/v2/reports/droplet_neighbors_ids`.","security":[{"bearerAuth":[]}]}},"/v2/firewalls":{"get":{"tags":["Firewalls"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls"},"summary":"List All Firewalls","description":"To list all of the firewalls available on your account send a GET request to `/v2/firewalls`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Firewalls"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls"},"summary":"Create a New Firewall","description":"To create a new firewall send a POST request to `/v2/firewalls`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/firewalls/{firewall_id}":{"get":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"A unique ID that can be used to identify and reference a firewall","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls/{firewall_id}"},"summary":"Retrieve an Existing Firewall","description":"To show information about an existing firewall send a GET request to `/v2/firewalls/$FIREWALL_ID`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"A unique ID that can be used to identify and reference a firewall","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls/{firewall_id}"},"summary":"Update a Firewall","description":"To update the configuration of an existing firewall send a PUT request to\n`/v2/firewalls/$FIREWALL_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"A unique ID that can be used to identify and reference a firewall","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls/{firewall_id}"},"summary":"Delete a Firewall","description":"To delete a firewall send a DELETE request to `/v2/firewalls/$FIREWALL_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/firewalls/{firewall_id}/droplets":{"post":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"A unique ID that can be used to identify and reference a firewall","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls/{firewall_id}/droplets"},"summary":"Add Droplets to a Firewall","description":"To assign a Droplet to a firewall send a POST request to\n`/v2/firewalls/$FIREWALL_ID/droplets`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"droplet_ids":{"type":"array","description":"An array containing the IDs of the Droplets to be assigned to the firewall","required":true,"items":{"type":"string"}}}},"example":{"droplet_ids":[]}}}}},"delete":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"A unique ID that can be used to identify and reference a firewall","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls/{firewall_id}/droplets"},"summary":"Remove Droplets from a Firewall","description":"To remove a Droplet from a firewall send a DELETE request to\n`/v2/firewalls/$FIREWALL_ID/droplets`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"droplet_ids":{"type":"array","description":"An array containing the IDs of the Droplets to be removed from the firewall","required":true,"items":{"type":"string"}}}},"example":{"droplet_ids":[]}}}}}},"/v2/firewalls/{firewall_id}/tags":{"post":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"A unique ID that can be used to identify and reference a firewall","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls/{firewall_id}/tags"},"summary":"Add Tags to a Firewall","description":"To assign a tag representing a group of Droplets to a firewall send a POST\nrequest to `/v2/firewalls/$FIREWALL_ID/tags`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tags":{"type":"string","required":true}}},"example":{"tags":""}}}}},"delete":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"A unique ID that can be used to identify and reference a firewall","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls/{firewall_id}/tags"},"summary":"Remove Tags from a Firewall","description":"To remove a tag representing a group of Droplets from a firewall send a\nDELETE request to `/v2/firewalls/$FIREWALL_ID/tags`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tags":{"type":"string","required":true}}},"example":{"tags":""}}}}}},"/v2/firewalls/{firewall_id}/rules":{"post":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"A unique ID that can be used to identify and reference a firewall","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls/{firewall_id}/rules"},"summary":"Add Rules to a Firewall","description":"To add additional access rules to a firewall send a POST request to\n`/v2/firewalls/$FIREWALL_ID/rules`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"A unique ID that can be used to identify and reference a firewall","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/firewalls/{firewall_id}/rules"},"summary":"Remove Rules from a Firewall","description":"To remove access rules from a firewall send a DELETE request to\n`/v2/firewalls/$FIREWALL_ID/rules`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/floating_ips/{floating_ip}/actions":{"get":{"tags":["Floating IP Actions"],"parameters":[{"name":"floating_ip","in":"path","description":"A floating IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/floating_ips/{floating_ip}/actions"},"summary":"List All Actions for a Floating IP","description":"To retrieve all actions that have been executed on a floating IP send a GET request to `/v2/floating_ips/$FLOATING_IP/actions`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Floating IP Actions"],"parameters":[{"name":"floating_ip","in":"path","description":"A floating IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/floating_ips/{floating_ip}/actions"},"summary":"Initiate a Floating IP Action","description":"To initiate an action on a floating IP send a POST request to\n`/v2/floating_ips/$FLOATING_IP/actions`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/floating_ips/{floating_ip}/actions/{action_id}":{"get":{"tags":["Floating IP Actions"],"parameters":[{"name":"action_id","in":"path","description":"A unique numeric ID that can be used to identify and reference an action","required":true,"schema":{"type":"number","example":""}},{"name":"floating_ip","in":"path","description":"A floating IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/floating_ips/{floating_ip}/actions/{action_id}"},"summary":"Retrieve an Existing Floating IP Action","description":"To retrieve the status of a floating IP action send a GET request to `/v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID`.","security":[{"bearerAuth":[]}]}},"/v2/floating_ips":{"get":{"tags":["Floating IPs"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/floating_ips"},"summary":"List All Floating IPs","description":"To list all of the floating IPs available on your account send a GET request to `/v2/floating_ips`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Floating IPs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/floating_ips"},"summary":"Create a New Floating IP","description":"On creation a floating IP must be either assigned to a Droplet or reserved to a region.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/floating_ips/{floating_ip}":{"get":{"tags":["Floating IPs"],"parameters":[{"name":"floating_ip","in":"path","description":"A floating IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/floating_ips/{floating_ip}"},"summary":"Retrieve an Existing Floating IP","description":"To show information about a floating IP send a GET request to `/v2/floating_ips/$FLOATING_IP_ADDR`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Floating IPs"],"parameters":[{"name":"floating_ip","in":"path","description":"A floating IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/floating_ips/{floating_ip}"},"summary":"Delete a Floating IP","description":"To delete a floating IP and remove it from your account send a DELETE request\nto `/v2/floating_ips/$FLOATING_IP_ADDR`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/functions/namespaces":{"get":{"tags":["Functions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/functions/namespaces"},"summary":"List Namespaces","description":"Returns a list of namespaces associated with the current user.","security":[{"bearerAuth":[]}]},"post":{"tags":["Functions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/functions/namespaces"},"summary":"Create Namespace","description":"Creates a new serverless functions namespace in the desired region and associates it with the provided label.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"label":{"type":"string","description":"The namespace's unique name","required":true},"region":{"type":"string","description":"The [datacenter region](https//docs","required":true}}},"example":{"label":"","region":""}}}}}},"/v2/functions/namespaces/{namespace_id}":{"get":{"tags":["Functions"],"parameters":[{"name":"namespace_id","in":"path","description":"The ID of the namespace to be managed","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/functions/namespaces/{namespace_id}"},"summary":"Get Namespace","description":"Gets the namespace details for the given namespace UUID.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Functions"],"parameters":[{"name":"namespace_id","in":"path","description":"The ID of the namespace to be managed","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/functions/namespaces/{namespace_id}"},"summary":"Delete Namespace","description":"Deletes the given namespace.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/functions/namespaces/{namespace_id}/triggers":{"get":{"tags":["Functions"],"parameters":[{"name":"namespace_id","in":"path","description":"The ID of the namespace to be managed","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/functions/namespaces/{namespace_id}/triggers"},"summary":"List Triggers","description":"Returns a list of triggers associated with the current user and namespace.","security":[{"bearerAuth":[]}]},"post":{"tags":["Functions"],"parameters":[{"name":"namespace_id","in":"path","description":"The ID of the namespace to be managed","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/functions/namespaces/{namespace_id}/triggers"},"summary":"Create Trigger","description":"Creates a new trigger for a given function in a namespace.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"One of different type of triggers","required":true},"function":{"type":"string","description":"Name of function(action) that exists in the given namespace","required":true},"is_enabled":{"type":"boolean","description":"Indicates weather the trigger is paused or unpaused","required":true,"enum":[true,false]},"name":{"type":"string","description":"The trigger's unique name within the namespace","required":true},"scheduled_details":{"type":"object","description":"Trigger details for SCHEDULED type where body is optional","required":true,"properties":{}}}},"example":{"type":"","function":"","is_enabled":"","name":"","scheduled_details":{}}}}}}},"/v2/functions/namespaces/{namespace_id}/triggers/{trigger_name}":{"get":{"tags":["Functions"],"parameters":[{"name":"namespace_id","in":"path","description":"The ID of the namespace to be managed","required":true,"schema":{"type":"string","example":""}},{"name":"trigger_name","in":"path","description":"The name of the trigger to be managed","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/functions/namespaces/{namespace_id}/triggers/{trigger_name}"},"summary":"Get Trigger","description":"Gets the trigger details.","security":[{"bearerAuth":[]}]},"put":{"tags":["Functions"],"parameters":[{"name":"namespace_id","in":"path","description":"The ID of the namespace to be managed","required":true,"schema":{"type":"string","example":""}},{"name":"trigger_name","in":"path","description":"The name of the trigger to be managed","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/functions/namespaces/{namespace_id}/triggers/{trigger_name}"},"summary":"Update Trigger","description":"Updates the details of the given trigger.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"is_enabled":{"type":"boolean","description":"Indicates weather the trigger is paused or unpaused","enum":[true,false]},"scheduled_details":{"type":"object","description":"Trigger details for SCHEDULED type where body is optional","properties":{}}}},"example":{"is_enabled":"","scheduled_details":{}}}}}},"delete":{"tags":["Functions"],"parameters":[{"name":"namespace_id","in":"path","description":"The ID of the namespace to be managed","required":true,"schema":{"type":"string","example":""}},{"name":"trigger_name","in":"path","description":"The name of the trigger to be managed","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/functions/namespaces/{namespace_id}/triggers/{trigger_name}"},"summary":"Delete Trigger","description":"Deletes the given trigger.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/images/{image_id}/actions":{"get":{"tags":["Image Actions"],"parameters":[{"name":"image_id","in":"path","description":"A unique number that can be used to identify and reference a specific image","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/images/{image_id}/actions"},"summary":"List All Actions for an Image","description":"To retrieve all actions that have been executed on an image send a GET request to `/v2/images/$IMAGE_ID/actions`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Image Actions"],"parameters":[{"name":"image_id","in":"path","description":"A unique number that can be used to identify and reference a specific image","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/images/{image_id}/actions"},"summary":"Initiate an Image Action","description":"The following actions are available on an Image.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/images/{image_id}/actions/{action_id}":{"get":{"tags":["Image Actions"],"parameters":[{"name":"action_id","in":"path","description":"A unique numeric ID that can be used to identify and reference an action","required":true,"schema":{"type":"number","example":""}},{"name":"image_id","in":"path","description":"A unique number that can be used to identify and reference a specific image","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/images/{image_id}/actions/{action_id}"},"summary":"Retrieve an Existing Action","description":"To retrieve the status of an image action send a GET request to `/v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID`.","security":[{"bearerAuth":[]}]}},"/v2/images":{"get":{"tags":["Images"],"parameters":[{"name":"type","in":"query","description":"Filters results based on image type which can be either `application` or `distribution`","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}},{"name":"private","in":"query","description":"Used to filter only user images","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"tag_name","in":"query","description":"Used to filter images by a specific tag","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/images"},"summary":"List All Images","description":"To list all of the images available on your account send a GET request to /v2/images.","security":[{"bearerAuth":[]}]},"post":{"tags":["Images"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/images"},"summary":"Create a Custom Image","description":"To create a new custom image send a POST request to /v2/images.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/images/{image_id}":{"get":{"tags":["Images"],"parameters":[{"name":"image_id","in":"path","description":"A unique number (id) or string (slug) used to identify and reference a","required":true,"schema":{"type":"","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/images/{image_id}"},"summary":"Retrieve an Existing Image","description":"To retrieve information about an image send a `GET` request to\n`/v2/images/$IDENTIFIER`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Images"],"parameters":[{"name":"image_id","in":"path","description":"A unique number that can be used to identify and reference a specific image","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/images/{image_id}"},"summary":"Update an Image","description":"To update an image send a `PUT` request to `/v2/images/$IMAGE_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"An optional free-form text field to describe an image"},"distribution":{"type":"string","description":"The name of a custom image's distribution"},"name":{"type":"string","description":"The display name that has been given to an image"}}},"example":{"description":"","distribution":"","name":""}}}}},"delete":{"tags":["Images"],"parameters":[{"name":"image_id","in":"path","description":"A unique number that can be used to identify and reference a specific image","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/images/{image_id}"},"summary":"Delete an Image","description":"To delete a snapshot or custom image send a `DELETE` request to `/v2/images/$IMAGE_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/kubernetes/clusters":{"get":{"tags":["Kubernetes"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters"},"summary":"List All Kubernetes Clusters","description":"To list all of the Kubernetes clusters on your account send a GET request\nto `/v2/kubernetes/clusters`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Kubernetes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters"},"summary":"Create a New Kubernetes Cluster","description":"To create a new Kubernetes cluster send a POST request to\n`/v2/kubernetes/clusters`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"auto_upgrade":{"type":"boolean","description":"A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window","enum":[true,false]},"cluster_subnet":{"type":"string","description":"The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation"},"created_at":{"type":"string","description":"A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created"},"endpoint":{"type":"string","description":"The base URL of the API server on the Kubernetes master node"},"ha":{"type":"boolean","description":"A boolean value indicating whether the control plane is run in a highly available configuration in the cluster","enum":[true,false]},"id":{"type":"string","description":"A unique ID that can be used to identify and reference a Kubernetes cluster"},"ipv4":{"type":"string","description":"The public IPv4 address of the Kubernetes master node"},"maintenance_policy":{"type":"object","description":"An object specifying the maintenance window policy for the Kubernetes cluster","properties":{}},"name":{"type":"string","description":"A human-readable name for a Kubernetes cluster","required":true},"node_pools":{"type":"array","description":"An object specifying the details of the worker nodes available to the Kubernetes cluster","required":true,"items":{"type":"string"}},"region":{"type":"string","description":"The slug identifier for the region where the Kubernetes cluster is located","required":true},"registry_enabled":{"type":"boolean","description":"A read-only boolean value indicating if a container registry is integrated with the cluster","enum":[true,false]},"service_subnet":{"type":"string","description":"The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation"},"status":{"type":"object","description":"An object containing a `state` attribute whose value is set to a string indicating the current status of the cluster","properties":{}},"surge_upgrade":{"type":"boolean","description":"A boolean value indicating whether surge upgrade is enabled/disabled for the cluster","enum":[true,false]},"tags":{"type":"array","description":"An array of tags applied to the Kubernetes cluster","items":{"type":"string"}},"version":{"type":"string","description":"The slug identifier for the version of Kubernetes used for the cluster","required":true},"vpc_uuid":{"type":"string","description":"A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned"},"updated_at":{"type":"string","description":"A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated"}}},"example":{"auto_upgrade":"","cluster_subnet":"","created_at":"","endpoint":"","ha":"","id":"","ipv4":"","maintenance_policy":{},"name":"","node_pools":[],"region":"","registry_enabled":"","service_subnet":"","status":{},"surge_upgrade":"","tags":[],"version":"","vpc_uuid":"","updated_at":""}}}}}},"/v2/kubernetes/clusters/{cluster_id}":{"get":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}"},"summary":"Retrieve an Existing Kubernetes Cluster","description":"To show information about an existing Kubernetes cluster send a GET request\nto `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}"},"summary":"Update a Kubernetes Cluster","description":"To update a Kubernetes cluster send a PUT request to\n`/v2/kubernetes/clusters/$K8S_CLUSTER_ID` and specify one or more of the\nattributes below.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"auto_upgrade":{"type":"boolean","description":"A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window","enum":[true,false]},"ha":{"type":"boolean","description":"A boolean value indicating whether the control plane is run in a highly available configuration in the cluster","enum":[true,false]},"maintenance_policy":{"type":"object","description":"An object specifying the maintenance window policy for the Kubernetes cluster","properties":{}},"name":{"type":"string","description":"A human-readable name for a Kubernetes cluster","required":true},"surge_upgrade":{"type":"boolean","description":"A boolean value indicating whether surge upgrade is enabled/disabled for the cluster","enum":[true,false]},"tags":{"type":"array","description":"An array of tags applied to the Kubernetes cluster","items":{"type":"string"}}}},"example":{"auto_upgrade":"","ha":"","maintenance_policy":{},"name":"","surge_upgrade":"","tags":[]}}}}},"delete":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}"},"summary":"Delete a Kubernetes Cluster","description":"To delete a Kubernetes cluster and all services deployed to it send a DELETE\nrequest to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/kubernetes/clusters/{cluster_id}/destroy_with_associated_resources":{"get":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/destroy_with_associated_resources"},"summary":"List Associated Resources for Cluster Deletion","description":"To list the associated billable resources that can be destroyed along with a cluster send a GET request to the `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources` endpoint.","security":[{"bearerAuth":[]}]}},"/v2/kubernetes/clusters/{cluster_id}/destroy_with_associated_resources/selective":{"delete":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/destroy_with_associated_resources/selective"},"summary":"Selectively Delete a Cluster and its Associated Resources","description":"To delete a Kubernetes cluster along with a subset of its associated resources\nsend a DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/selective`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"load_balancers":{"type":"array","description":"A list of IDs for associated load balancers to destroy along with the cluster","items":{"type":"string"}},"volume_snapshots":{"type":"array","description":"A list of IDs for associated volume snapshots to destroy along with the cluster","items":{"type":"string"}},"volumes":{"type":"array","description":"A list of IDs for associated volumes to destroy along with the cluster","items":{"type":"string"}}}},"example":{"load_balancers":[],"volume_snapshots":[],"volumes":[]}}}}}},"/v2/kubernetes/clusters/{cluster_id}/destroy_with_associated_resources/dangerous":{"delete":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/destroy_with_associated_resources/dangerous"},"summary":"Delete a Cluster and All of its Associated Resources (Dangerous)","description":"To delete a Kubernetes cluster with all of its associated resources send a\nDELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/dangerous`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/kubernetes/clusters/{cluster_id}/kubeconfig":{"get":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}},{"name":"expiry_seconds","in":"query","description":"The duration in seconds that the returned Kubernetes credentials will be valid","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/kubeconfig"},"summary":"Retrieve the kubeconfig for a Kubernetes Cluster","description":"This endpoint returns a kubeconfig file in YAML format.","security":[{"bearerAuth":[]}]}},"/v2/kubernetes/clusters/{cluster_id}/credentials":{"get":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}},{"name":"expiry_seconds","in":"query","description":"The duration in seconds that the returned Kubernetes credentials will be valid","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/credentials"},"summary":"Retrieve Credentials for a Kubernetes Cluster","description":"This endpoint returns a JSON object .","security":[{"bearerAuth":[]}]}},"/v2/kubernetes/clusters/{cluster_id}/upgrades":{"get":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/upgrades"},"summary":"Retrieve Available Upgrades for an Existing Kubernetes Cluster","description":"To determine whether a cluster can be upgraded and the versions to which it\ncan be upgraded send a GET request to\n`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades`.","security":[{"bearerAuth":[]}]}},"/v2/kubernetes/clusters/{cluster_id}/upgrade":{"post":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/upgrade"},"summary":"Upgrade a Kubernetes Cluster","description":"To immediately upgrade a Kubernetes cluster to a newer patch release of\nKubernetes send a POST request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"version":{"type":"string","description":"The slug identifier for the version of Kubernetes that the cluster will be upgraded to"}}},"example":{"version":""}}}}}},"/v2/kubernetes/clusters/{cluster_id}/node_pools":{"get":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/node_pools"},"summary":"List All Node Pools in a Kubernetes Clusters","description":"To list all of the node pools in a Kubernetes clusters send a GET request to\n`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/node_pools"},"summary":"Add a Node Pool to a Kubernetes Cluster","description":"To add an additional node pool to a Kubernetes clusters send a POST request\nto `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools` with the following\nattributes.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}":{"get":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}},{"name":"node_pool_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes node pool","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}"},"summary":"Retrieve a Node Pool for a Kubernetes Cluster","description":"To show information about a specific node pool in a Kubernetes cluster send\na GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}},{"name":"node_pool_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes node pool","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}"},"summary":"Update a Node Pool in a Kubernetes Cluster","description":"To update the name of a node pool edit the tags applied to it or adjust its\nnumber of nodes send a PUT request to\n`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID` with the\nfollowing attributes.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}},{"name":"node_pool_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes node pool","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}"},"summary":"Delete a Node Pool in a Kubernetes Cluster","description":"To delete a node pool send a DELETE request to\n`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}/nodes/{node_id}":{"delete":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}},{"name":"node_id","in":"path","description":"A unique ID that can be used to reference a node in a Kubernetes node pool","required":true,"schema":{"type":"string","example":""}},{"name":"node_pool_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes node pool","required":true,"schema":{"type":"string","example":""}},{"name":"replace","in":"query","description":"Specifies whether or not to replace a node after it has been deleted","schema":{"type":"number","example":""}},{"name":"skip_drain","in":"query","description":"Specifies whether or not to drain workloads from a node before it is deleted","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}/nodes/{node_id}"},"summary":"Delete a Node in a Kubernetes Cluster","description":"To delete a single node in a pool send a DELETE request to\n`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}/recycle":{"post":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}},{"name":"node_pool_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes node pool","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}/recycle"},"summary":"Recycle a Kubernetes Node Pool","description":"The endpoint has been deprecated.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"nodes":{"type":"array","items":{"type":"string"}}}},"example":{"nodes":[]}}}}}},"/v2/kubernetes/clusters/{cluster_id}/user":{"get":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/user"},"summary":"Retrieve User Information for a Kubernetes Cluster","description":"To show information the user associated with a Kubernetes cluster send a GET\nrequest to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/user`.","security":[{"bearerAuth":[]}]}},"/v2/kubernetes/options":{"get":{"tags":["Kubernetes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/options"},"summary":"List Available Regions Node Sizes and Versions of Kubernetes","description":"To list the versions of Kubernetes available for use the regions that support Kubernetes and the available node sizes send a GET request to `/v2/kubernetes/options`.","security":[{"bearerAuth":[]}]}},"/v2/kubernetes/clusters/{cluster_id}/clusterlint":{"post":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/clusterlint"},"summary":"Run Clusterlint Checks on a Kubernetes Cluster","description":"Clusterlint helps operators conform to Kubernetes best practices around\nresources security and reliability to avoid common problems while operating\nor upgrading the clusters.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"exclude_checks":{"type":"array","description":"An array of checks that will be run when clusterlint executes checks","items":{"type":"string"}},"exclude_groups":{"type":"array","description":"An array of check groups that will be omitted when clusterlint executes checks","items":{"type":"string"}},"include_checks":{"type":"array","description":"An array of checks that will be run when clusterlint executes checks","items":{"type":"string"}},"include_groups":{"type":"array","description":"An array of check groups that will be run when clusterlint executes checks","items":{"type":"string"}}}},"example":{"exclude_checks":[],"exclude_groups":[],"include_checks":[],"include_groups":[]}}}}},"get":{"tags":["Kubernetes"],"parameters":[{"name":"cluster_id","in":"path","description":"A unique ID that can be used to reference a Kubernetes cluster","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"query","description":"Specifies the clusterlint run whose results will be retrieved","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/clusters/{cluster_id}/clusterlint"},"summary":"Fetch Clusterlint Diagnostics for a Kubernetes Cluster","description":"To request clusterlint diagnostics for your cluster send a GET request to\n`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint`.","security":[{"bearerAuth":[]}]}},"/v2/kubernetes/registry":{"post":{"tags":["Kubernetes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/registry"},"summary":"Add Container Registry to Kubernetes Clusters","description":"To integrate the container registry with Kubernetes clusters send a POST request to `/v2/kubernetes/registry`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cluster_uuids":{"type":"array","description":"An array containing the UUIDs of Kubernetes clusters","items":{"type":"string"}}}},"example":{"cluster_uuids":[]}}}}},"delete":{"tags":["Kubernetes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/kubernetes/registry"},"summary":"Remove Container Registry from Kubernetes Clusters","description":"To remove the container registry from Kubernetes clusters send a DELETE request to `/v2/kubernetes/registry`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cluster_uuids":{"type":"array","description":"An array containing the UUIDs of Kubernetes clusters","items":{"type":"string"}}}},"example":{"cluster_uuids":[]}}}}}},"/v2/load_balancers":{"post":{"tags":["Load Balancers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/load_balancers"},"summary":"Create a New Load Balancer","description":"To create a new load balancer instance send a POST request to\n`/v2/load_balancers`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Load Balancers"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/load_balancers"},"summary":"List All Load Balancers","description":"To list all of the load balancer instances on your account send a GET request\nto `/v2/load_balancers`.","security":[{"bearerAuth":[]}]}},"/v2/load_balancers/{lb_id}":{"get":{"tags":["Load Balancers"],"parameters":[{"name":"lb_id","in":"path","description":"A unique identifier for a load balancer","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/load_balancers/{lb_id}"},"summary":"Retrieve an Existing Load Balancer","description":"To show information about a load balancer instance send a GET request to\n`/v2/load_balancers/$LOAD_BALANCER_ID`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Load Balancers"],"parameters":[{"name":"lb_id","in":"path","description":"A unique identifier for a load balancer","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/load_balancers/{lb_id}"},"summary":"Update a Load Balancer","description":"To update a load balancer's settings send a PUT request to\n`/v2/load_balancers/$LOAD_BALANCER_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Load Balancers"],"parameters":[{"name":"lb_id","in":"path","description":"A unique identifier for a load balancer","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/load_balancers/{lb_id}"},"summary":"Delete a Load Balancer","description":"To delete a load balancer instance disassociating any Droplets assigned to it\nand removing it from your account send a DELETE request to\n`/v2/load_balancers/$LOAD_BALANCER_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/load_balancers/{lb_id}/droplets":{"post":{"tags":["Load Balancers"],"parameters":[{"name":"lb_id","in":"path","description":"A unique identifier for a load balancer","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/load_balancers/{lb_id}/droplets"},"summary":"Add Droplets to a Load Balancer","description":"To assign a Droplet to a load balancer instance send a POST request to\n`/v2/load_balancers/$LOAD_BALANCER_ID/droplets`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"droplet_ids":{"type":"array","description":"An array containing the IDs of the Droplets assigned to the load balancer","required":true,"items":{"type":"string"}}}},"example":{"droplet_ids":[]}}}}},"delete":{"tags":["Load Balancers"],"parameters":[{"name":"lb_id","in":"path","description":"A unique identifier for a load balancer","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/load_balancers/{lb_id}/droplets"},"summary":"Remove Droplets from a Load Balancer","description":"To remove a Droplet from a load balancer instance send a DELETE request to\n`/v2/load_balancers/$LOAD_BALANCER_ID/droplets`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"droplet_ids":{"type":"array","description":"An array containing the IDs of the Droplets assigned to the load balancer","required":true,"items":{"type":"string"}}}},"example":{"droplet_ids":[]}}}}}},"/v2/load_balancers/{lb_id}/forwarding_rules":{"post":{"tags":["Load Balancers"],"parameters":[{"name":"lb_id","in":"path","description":"A unique identifier for a load balancer","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/load_balancers/{lb_id}/forwarding_rules"},"summary":"Add Forwarding Rules to a Load Balancer","description":"To add an additional forwarding rule to a load balancer instance send a POST\nrequest to `/v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"forwarding_rules":{"type":"array","required":true,"items":{"type":"string"}}}},"example":{"forwarding_rules":[]}}}}},"delete":{"tags":["Load Balancers"],"parameters":[{"name":"lb_id","in":"path","description":"A unique identifier for a load balancer","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/load_balancers/{lb_id}/forwarding_rules"},"summary":"Remove Forwarding Rules from a Load Balancer","description":"To remove forwarding rules from a load balancer instance send a DELETE\nrequest to `/v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"forwarding_rules":{"type":"array","required":true,"items":{"type":"string"}}}},"example":{"forwarding_rules":[]}}}}}},"/v2/monitoring/alerts":{"get":{"tags":["Monitoring"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/alerts"},"summary":"List Alert Policies","description":"Returns all alert policies that are configured for the given account.","security":[{"bearerAuth":[]}]},"post":{"tags":["Monitoring"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/alerts"},"summary":"Create Alert Policy","description":"To create a new alert send a POST request to `/v2/monitoring/alerts`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","required":true},"alerts":{"type":"object","required":true,"properties":{}},"compare":{"type":"string","required":true},"description":{"type":"string","required":true},"enabled":{"type":"boolean","required":true,"enum":[true,false]},"entities":{"type":"array","required":true,"items":{"type":"string"}},"tags":{"type":"array","required":true,"items":{"type":"string"}},"value":{"type":"number","required":true},"window":{"type":"string","required":true}}},"example":{"type":"","alerts":{},"compare":"","description":"","enabled":"","entities":[],"tags":[],"value":"","window":""}}}}}},"/v2/monitoring/alerts/{alert_uuid}":{"get":{"tags":["Monitoring"],"parameters":[{"name":"alert_uuid","in":"path","description":"A unique identifier for an alert policy","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/alerts/{alert_uuid}"},"summary":"Retrieve an Existing Alert Policy","description":"To retrieve a given alert policy send a GET request to `/v2/monitoring/alerts/{alert_uuid}`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Monitoring"],"parameters":[{"name":"alert_uuid","in":"path","description":"A unique identifier for an alert policy","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/alerts/{alert_uuid}"},"summary":"Update an Alert Policy","description":"To update en existing policy send a PUT request to `v2/monitoring/alerts/{alert_uuid}`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","required":true},"alerts":{"type":"object","required":true,"properties":{}},"compare":{"type":"string","required":true},"description":{"type":"string","required":true},"enabled":{"type":"boolean","required":true,"enum":[true,false]},"entities":{"type":"array","required":true,"items":{"type":"string"}},"tags":{"type":"array","required":true,"items":{"type":"string"}},"value":{"type":"number","required":true},"window":{"type":"string","required":true}}},"example":{"type":"","alerts":{},"compare":"","description":"","enabled":"","entities":[],"tags":[],"value":"","window":""}}}}},"delete":{"tags":["Monitoring"],"parameters":[{"name":"alert_uuid","in":"path","description":"A unique identifier for an alert policy","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/alerts/{alert_uuid}"},"summary":"Delete an Alert Policy","description":"To delete an alert policy send a DELETE request to `/v2/monitoring/alerts/{alert_uuid}`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/monitoring/metrics/droplet/bandwidth":{"get":{"tags":["Monitoring"],"parameters":[{"name":"direction","in":"query","description":"The traffic direction","required":true,"schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"interface","in":"query","description":"The network interface","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/bandwidth"},"summary":"Get Droplet Bandwidth Metrics","description":"To retrieve bandwidth metrics for a given Droplet send a GET request to `/v2/monitoring/metrics/droplet/bandwidth`.","security":[{"bearerAuth":[]}]}},"/v2/monitoring/metrics/droplet/cpu":{"get":{"tags":["Monitoring"],"parameters":[{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/cpu"},"summary":"Get Droplet CPU Metrics","description":"To retrieve CPU metrics for a given droplet send a GET request to `/v2/monitoring/metrics/droplet/cpu`.","security":[{"bearerAuth":[]}]}},"/v2/monitoring/metrics/droplet/filesystem_free":{"get":{"tags":["Monitoring"],"parameters":[{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/filesystem_free"},"summary":"Get Droplet Filesystem Free Metrics","description":"To retrieve filesystem free metrics for a given droplet send a GET request to `/v2/monitoring/metrics/droplet/filesystem_free`.","security":[{"bearerAuth":[]}]}},"/v2/monitoring/metrics/droplet/filesystem_size":{"get":{"tags":["Monitoring"],"parameters":[{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/filesystem_size"},"summary":"Get Droplet Filesystem Size Metrics","description":"To retrieve filesystem size metrics for a given droplet send a GET request to `/v2/monitoring/metrics/droplet/filesystem_size`.","security":[{"bearerAuth":[]}]}},"/v2/monitoring/metrics/droplet/load_1":{"get":{"tags":["Monitoring"],"parameters":[{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/load_1"},"summary":"Get Droplet Load1 Metrics","description":"To retrieve 1 minute load average metrics for a given droplet send a GET request to `/v2/monitoring/metrics/droplet/load_1`.","security":[{"bearerAuth":[]}]}},"/v2/monitoring/metrics/droplet/load_5":{"get":{"tags":["Monitoring"],"parameters":[{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/load_5"},"summary":"Get Droplet Load5 Metrics","description":"To retrieve 5 minute load average metrics for a given droplet send a GET request to `/v2/monitoring/metrics/droplet/load_5`.","security":[{"bearerAuth":[]}]}},"/v2/monitoring/metrics/droplet/load_15":{"get":{"tags":["Monitoring"],"parameters":[{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/load_15"},"summary":"Get Droplet Load15 Metrics","description":"To retrieve 15 minute load average metrics for a given droplet send a GET request to `/v2/monitoring/metrics/droplet/load_15`.","security":[{"bearerAuth":[]}]}},"/v2/monitoring/metrics/droplet/memory_cached":{"get":{"tags":["Monitoring"],"parameters":[{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/memory_cached"},"summary":"Get Droplet Cached Memory Metrics","description":"To retrieve cached memory metrics for a given droplet send a GET request to `/v2/monitoring/metrics/droplet/memory_cached`.","security":[{"bearerAuth":[]}]}},"/v2/monitoring/metrics/droplet/memory_free":{"get":{"tags":["Monitoring"],"parameters":[{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/memory_free"},"summary":"Get Droplet Free Memory Metrics","description":"To retrieve free memory metrics for a given droplet send a GET request to `/v2/monitoring/metrics/droplet/memory_free`.","security":[{"bearerAuth":[]}]}},"/v2/monitoring/metrics/droplet/memory_total":{"get":{"tags":["Monitoring"],"parameters":[{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/memory_total"},"summary":"Get Droplet Total Memory Metrics","description":"To retrieve total memory metrics for a given droplet send a GET request to `/v2/monitoring/metrics/droplet/memory_total`.","security":[{"bearerAuth":[]}]}},"/v2/monitoring/metrics/droplet/memory_available":{"get":{"tags":["Monitoring"],"parameters":[{"name":"end","in":"query","description":"Timestamp to end metric window","required":true,"schema":{"type":"string","example":""}},{"name":"host_id","in":"query","description":"The droplet ID","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"Timestamp to start metric window","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/monitoring/metrics/droplet/memory_available"},"summary":"Get Droplet Available Memory Metrics","description":"To retrieve available memory metrics for a given droplet send a GET request to `/v2/monitoring/metrics/droplet/memory_available`.","security":[{"bearerAuth":[]}]}},"/v2/projects/{project_id}/resources":{"get":{"tags":["Project Resources"],"parameters":[{"name":"project_id","in":"path","description":"A unique identifier for a project","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/{project_id}/resources"},"summary":"List Project Resources","description":"To list all your resources in a project send a GET request to `/v2/projects/$PROJECT_ID/resources`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Project Resources"],"parameters":[{"name":"project_id","in":"path","description":"A unique identifier for a project","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/{project_id}/resources"},"summary":"Assign Resources to a Project","description":"To assign resources to a project send a POST request to `/v2/projects/$PROJECT_ID/resources`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resources":{"type":"array","description":"A list of uniform resource names (URNs) to be added to a project","items":{"type":"string"}}}},"example":{"resources":[]}}}}}},"/v2/projects/default/resources":{"get":{"tags":["Project Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/default/resources"},"summary":"List Default Project Resources","description":"To list all your resources in your default project send a GET request to `/v2/projects/default/resources`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Project Resources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/default/resources"},"summary":"Assign Resources to Default Project","description":"To assign resources to your default project send a POST request to `/v2/projects/default/resources`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resources":{"type":"array","description":"A list of uniform resource names (URNs) to be added to a project","items":{"type":"string"}}}},"example":{"resources":[]}}}}}},"/v2/projects":{"get":{"tags":["Projects"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects"},"summary":"List All Projects","description":"To list all your projects send a GET request to `/v2/projects`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Projects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects"},"summary":"Create a Project","description":"To create a project send a POST request to `/v2/projects`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/projects/default":{"get":{"tags":["Projects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/default"},"summary":"Retrieve the Default Project","description":"To get your default project send a GET request to `/v2/projects/default`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Projects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/default"},"summary":"Update the Default Project","description":"To update you default project send a PUT request to `/v2/projects/default`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"patch":{"tags":["Projects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/default"},"summary":"Patch the Default Project","description":"To update only specific attributes of your default project send a PATCH request to `/v2/projects/default`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/projects/{project_id}":{"get":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"A unique identifier for a project","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/{project_id}"},"summary":"Retrieve an Existing Project","description":"To get a project send a GET request to `/v2/projects/$PROJECT_ID`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"A unique identifier for a project","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/{project_id}"},"summary":"Update a Project","description":"To update a project send a PUT request to `/v2/projects/$PROJECT_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"patch":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"A unique identifier for a project","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/{project_id}"},"summary":"Patch a Project","description":"To update only specific attributes of a project send a PATCH request to `/v2/projects/$PROJECT_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"A unique identifier for a project","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/projects/{project_id}"},"summary":"Delete an Existing Project","description":"To delete a project send a DELETE request to `/v2/projects/$PROJECT_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/regions":{"get":{"tags":["Regions"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/regions"},"summary":"List All Data Center Regions","description":"To list all of the regions that are available send a GET request to `/v2/regions`.","security":[{"bearerAuth":[]}]}},"/v2/reserved_ips/{reserved_ip}/actions":{"get":{"tags":["Reserved IP Actions"],"parameters":[{"name":"reserved_ip","in":"path","description":"A reserved IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/reserved_ips/{reserved_ip}/actions"},"summary":"List All Actions for a Reserved IP","description":"To retrieve all actions that have been executed on a reserved IP send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Reserved IP Actions"],"parameters":[{"name":"reserved_ip","in":"path","description":"A reserved IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/reserved_ips/{reserved_ip}/actions"},"summary":"Initiate a Reserved IP Action","description":"To initiate an action on a reserved IP send a POST request to\n`/v2/reserved_ips/$RESERVED_IP/actions`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/reserved_ips/{reserved_ip}/actions/{action_id}":{"get":{"tags":["Reserved IP Actions"],"parameters":[{"name":"action_id","in":"path","description":"A unique numeric ID that can be used to identify and reference an action","required":true,"schema":{"type":"number","example":""}},{"name":"reserved_ip","in":"path","description":"A reserved IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/reserved_ips/{reserved_ip}/actions/{action_id}"},"summary":"Retrieve an Existing Reserved IP Action","description":"To retrieve the status of a reserved IP action send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`.","security":[{"bearerAuth":[]}]}},"/v2/reserved_ips":{"get":{"tags":["Reserved IPs"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/reserved_ips"},"summary":"List All Reserved IPs","description":"To list all of the reserved IPs available on your account send a GET request to `/v2/reserved_ips`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Reserved IPs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/reserved_ips"},"summary":"Create a New Reserved IP","description":"On creation a reserved IP must be either assigned to a Droplet or reserved to a region.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/reserved_ips/{reserved_ip}":{"get":{"tags":["Reserved IPs"],"parameters":[{"name":"reserved_ip","in":"path","description":"A reserved IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/reserved_ips/{reserved_ip}"},"summary":"Retrieve an Existing Reserved IP","description":"To show information about a reserved IP send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Reserved IPs"],"parameters":[{"name":"reserved_ip","in":"path","description":"A reserved IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/reserved_ips/{reserved_ip}"},"summary":"Delete a Reserved IP","description":"To delete a reserved IP and remove it from your account send a DELETE request\nto `/v2/reserved_ips/$RESERVED_IP_ADDR`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/account/keys":{"get":{"tags":["SSH Keys"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/account/keys"},"summary":"List All SSH Keys","description":"To list all of the keys in your account send a GET request to `/v2/account/keys`.","security":[{"bearerAuth":[]}]},"post":{"tags":["SSH Keys"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/account/keys"},"summary":"Create a New SSH Key","description":"To add a new SSH public key to your DigitalOcean account send a POST request to `/v2/account/keys`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fingerprint":{"type":"string","description":"A unique identifier that differentiates this key from other keys using  a format that SSH recognizes"},"id":{"type":"number","description":"A unique identification number for this key"},"name":{"type":"string","description":"A human-readable display name for this key used to easily identify the SSH keys when they are displayed","required":true},"public_key":{"type":"string","description":"The entire public key string that was uploaded","required":true}}},"example":{"fingerprint":"","id":"","name":"","public_key":""}}}}}},"/v2/account/keys/{ssh_key_identifier}":{"get":{"tags":["SSH Keys"],"parameters":[{"name":"ssh_key_identifier","in":"path","description":"Either the ID or the fingerprint of an existing SSH key","required":true,"schema":{"type":"","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/account/keys/{ssh_key_identifier}"},"summary":"Retrieve an Existing SSH Key","description":"To get information about a key send a GET request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.","security":[{"bearerAuth":[]}]},"put":{"tags":["SSH Keys"],"parameters":[{"name":"ssh_key_identifier","in":"path","description":"Either the ID or the fingerprint of an existing SSH key","required":true,"schema":{"type":"","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/account/keys/{ssh_key_identifier}"},"summary":"Update an SSH Key's Name","description":"To update the name of an SSH key send a PUT request to either `/v2/account/keys/$SSH_KEY_ID` or `/v2/account/keys/$SSH_KEY_FINGERPRINT`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"A human-readable display name for this key used to easily identify the SSH keys when they are displayed"}}},"example":{"name":""}}}}},"delete":{"tags":["SSH Keys"],"parameters":[{"name":"ssh_key_identifier","in":"path","description":"Either the ID or the fingerprint of an existing SSH key","required":true,"schema":{"type":"","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/account/keys/{ssh_key_identifier}"},"summary":"Delete an SSH Key","description":"To destroy a public SSH key that you have in your account send a DELETE request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/sizes":{"get":{"tags":["Sizes"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/sizes"},"summary":"List All Droplet Sizes","description":"To list all of available Droplet sizes send a GET request to `/v2/sizes`.","security":[{"bearerAuth":[]}]}},"/v2/snapshots":{"get":{"tags":["Snapshots"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}},{"name":"resource_type","in":"query","description":"Used to filter snapshots by a resource type","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/snapshots"},"summary":"List All Snapshots","description":"To list all of the snapshots available on your account send a GET request to\n`/v2/snapshots`.","security":[{"bearerAuth":[]}]}},"/v2/snapshots/{snapshot_id}":{"get":{"tags":["Snapshots"],"parameters":[{"name":"snapshot_id","in":"path","description":"Either the ID of an existing snapshot","required":true,"schema":{"type":"","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/snapshots/{snapshot_id}"},"summary":"Retrieve an Existing Snapshot","description":"To retrieve information about a snapshot send a GET request to\n`/v2/snapshots/$SNAPSHOT_ID`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Snapshots"],"parameters":[{"name":"snapshot_id","in":"path","description":"Either the ID of an existing snapshot","required":true,"schema":{"type":"","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/snapshots/{snapshot_id}"},"summary":"Delete a Snapshot","description":"Both Droplet and volume snapshots are managed through the `/v2/snapshots/`\nendpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/tags":{"get":{"tags":["Tags"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/tags"},"summary":"List All Tags","description":"To list all of your tags you can send a GET request to `/v2/tags`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/tags"},"summary":"Create a New Tag","description":"To create a tag you can send a POST request to `/v2/tags` with a `name` attribute.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the tag"},"resources":{"type":"object","description":"An embedded object containing key value pairs of resource type and resource statistics","properties":{}}}},"example":{"name":"","resources":{}}}}}}},"/v2/tags/{tag_id}":{"get":{"tags":["Tags"],"parameters":[{"name":"tag_id","in":"path","description":"The name of the tag","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/tags/{tag_id}"},"summary":"Retrieve a Tag","description":"To retrieve an individual tag you can send a `GET` request to `/v2/tags/$TAG_NAME`.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Tags"],"parameters":[{"name":"tag_id","in":"path","description":"The name of the tag","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/tags/{tag_id}"},"summary":"Delete a Tag","description":"A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/tags/{tag_id}/resources":{"post":{"tags":["Tags"],"parameters":[{"name":"tag_id","in":"path","description":"The name of the tag","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/tags/{tag_id}/resources"},"summary":"Tag a Resource","description":"Resources can be tagged by sending a POST request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resources":{"type":"array","description":"An array of objects containing resource_id and resource_type  attributes","required":true,"items":{"type":"string"}}}},"example":{"resources":[]}}}}},"delete":{"tags":["Tags"],"parameters":[{"name":"tag_id","in":"path","description":"The name of the tag","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/tags/{tag_id}/resources"},"summary":"Untag a Resource","description":"Resources can be untagged by sending a DELETE request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resources":{"type":"array","description":"An array of objects containing resource_id and resource_type  attributes","required":true,"items":{"type":"string"}}}},"example":{"resources":[]}}}}}},"/v2/uptime/checks":{"get":{"tags":["Uptime"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks"},"summary":"List All Checks","description":"To list all of the Uptime checks on your account send a GET request to `/v2/uptime/checks`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Uptime"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks"},"summary":"Create a New Check","description":"To create an Uptime check send a POST request to `/v2/uptime/checks` specifying the attributes\nin the table below in the JSON body.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/uptime/checks/{check_id}":{"get":{"tags":["Uptime"],"parameters":[{"name":"check_id","in":"path","description":"A unique identifier for a check","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks/{check_id}"},"summary":"Retrieve an Existing Check","description":"To show information about an existing check send a GET request to `/v2/uptime/checks/$CHECK_ID`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Uptime"],"parameters":[{"name":"check_id","in":"path","description":"A unique identifier for a check","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks/{check_id}"},"summary":"Update a Check","description":"To update the settings of an Uptime check send a PUT request to `/v2/uptime/checks/$CHECK_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Uptime"],"parameters":[{"name":"check_id","in":"path","description":"A unique identifier for a check","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks/{check_id}"},"summary":"Delete a Check","description":"To delete an Uptime check send a DELETE request to `/v2/uptime/checks/$CHECK_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/uptime/checks/{check_id}/state":{"get":{"tags":["Uptime"],"parameters":[{"name":"check_id","in":"path","description":"A unique identifier for a check","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks/{check_id}/state"},"summary":"Retrieve Check State","description":"To show information about an existing check's state send a GET request to `/v2/uptime/checks/$CHECK_ID/state`.","security":[{"bearerAuth":[]}]}},"/v2/uptime/checks/{check_id}/alerts":{"get":{"tags":["Uptime"],"parameters":[{"name":"check_id","in":"path","description":"A unique identifier for a check","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks/{check_id}/alerts"},"summary":"List All Alerts","description":"To list all of the alerts for an Uptime check send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Uptime"],"parameters":[{"name":"check_id","in":"path","description":"A unique identifier for a check","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks/{check_id}/alerts"},"summary":"Create a New Alert","description":"To create an Uptime alert send a POST request to `/v2/uptime/checks/$CHECK_ID/alerts` specifying the attributes\nin the table below in the JSON body.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/uptime/checks/{check_id}/alerts/{alert_id}":{"get":{"tags":["Uptime"],"parameters":[{"name":"alert_id","in":"path","description":"A unique identifier for an alert","required":true,"schema":{"type":"string","example":""}},{"name":"check_id","in":"path","description":"A unique identifier for a check","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks/{check_id}/alerts/{alert_id}"},"summary":"Retrieve an Existing Alert","description":"To show information about an existing alert send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Uptime"],"parameters":[{"name":"alert_id","in":"path","description":"A unique identifier for an alert","required":true,"schema":{"type":"string","example":""}},{"name":"check_id","in":"path","description":"A unique identifier for a check","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks/{check_id}/alerts/{alert_id}"},"summary":"Update an Alert","description":"To update the settings of an Uptime alert send a PUT request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Uptime"],"parameters":[{"name":"alert_id","in":"path","description":"A unique identifier for an alert","required":true,"schema":{"type":"string","example":""}},{"name":"check_id","in":"path","description":"A unique identifier for a check","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/uptime/checks/{check_id}/alerts/{alert_id}"},"summary":"Delete an Alert","description":"To delete an Uptime alert send a DELETE request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/vpc_nat_gateways":{"get":{"tags":["VPC NAT Gateways"],"parameters":[{"name":"type","in":"query","description":"The type of the VPC NAT gateway.","schema":{"type":"string","example":"","items":{"type":"string","enum":["public"]}}},{"name":"name","in":"query","description":"The name of the VPC NAT gateway.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}},{"name":"region","in":"query","description":"The region where the VPC NAT gateway is located.","schema":{"type":"string","example":"","items":{"type":"string","enum":["nyc1","nyc2","nyc3","ams2","ams3","sfo1","sfo2","sfo3","sgp1","lon1","fra1","tor1","blr1","syd1","atl1"]}}},{"name":"state","in":"query","description":"The current state of the VPC NAT gateway.","schema":{"type":"string","example":"","items":{"type":"string","enum":["new","provisioning","active","deleting","error","invalid"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/api/api-reference/#tag/VPC-NAT-Gateways/operation/vpcnatgateways_list","api_endpoint":"https://api.digitalocean.com/v2/vpc_nat_gateways"},"summary":"List All VPC NAT Gateways","description":"To list all VPC NAT gateways in your team send a GET request to `/v2/vpc_nat_gateways`.","security":[{"bearerAuth":[]}]},"post":{"tags":["VPC NAT Gateways"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/api/api-reference/#tag/VPC-NAT-Gateways/operation/vpcnatgateways_create","api_endpoint":"https://api.digitalocean.com/v2/vpc_nat_gateways"},"summary":"Create a New VPC NAT Gateway","description":"To create a new VPC NAT gateway send a POST request to `/v2/vpc_nat_gateways` with the required attributes.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"The type of the VPC NAT gateway.","required":true,"enum":["PUBLIC"]},"icmp_timeout_seconds":{"type":"number","description":"The ICMP timeout in seconds for the VPC NAT gateway."},"name":{"type":"string","description":"The human-readable name of the VPC NAT gateway.","required":true},"region":{"type":"string","description":"The region in which the VPC NAT gateway is created.","required":true,"enum":["nyc1","nyc2","nyc3","ams2","ams3","sfo1","sfo2","sfo3","sgp1","lon1","fra1","tor1","blr1","syd1","atl1"]},"size":{"type":"number","description":"The size of the VPC NAT gateway.","required":true},"tcp_timeout_seconds":{"type":"number","description":"The TCP timeout in seconds for the VPC NAT gateway."},"udp_timeout_seconds":{"type":"number","description":"The UDP timeout in seconds for the VPC NAT gateway."},"vpcs":{"type":"array","description":"An array of VPCs associated with the VPC NAT gateway. Each object must include `vpc_uuid` and can set `default_gateway`.","required":true,"items":{"type":"string"}}}},"example":{"type":"","icmp_timeout_seconds":"","name":"","region":"","size":"","tcp_timeout_seconds":"","udp_timeout_seconds":"","vpcs":[]}}}}}},"/v2/vpc_nat_gateways/{id}":{"get":{"tags":["VPC NAT Gateways"],"parameters":[{"name":"id","in":"path","description":"The unique identifier of the VPC NAT gateway.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/api/api-reference/#tag/VPC-NAT-Gateways/operation/vpcnatgateways_get","api_endpoint":"https://api.digitalocean.com/v2/vpc_nat_gateways/{id}"},"summary":"Retrieve an Existing VPC NAT Gateway","description":"To show information about an individual VPC NAT gateway send a GET request to `/v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID`.","security":[{"bearerAuth":[]}]},"put":{"tags":["VPC NAT Gateways"],"parameters":[{"name":"id","in":"path","description":"The unique identifier of the VPC NAT gateway.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/api/api-reference/#tag/VPC-NAT-Gateways/operation/vpcnatgateways_update","api_endpoint":"https://api.digitalocean.com/v2/vpc_nat_gateways/{id}"},"summary":"Update VPC NAT Gateway","description":"To update the configuration of an existing VPC NAT gateway send a PUT request to `/v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID` with a full representation of the resource.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"icmp_timeout_seconds":{"type":"number","description":"The ICMP timeout in seconds for the VPC NAT gateway."},"name":{"type":"string","description":"The human-readable name of the VPC NAT gateway.","required":true},"size":{"type":"number","description":"The size of the VPC NAT gateway.","required":true},"tcp_timeout_seconds":{"type":"number","description":"The TCP timeout in seconds for the VPC NAT gateway."},"udp_timeout_seconds":{"type":"number","description":"The UDP timeout in seconds for the VPC NAT gateway."},"vpcs":{"type":"array","description":"An array of VPCs associated with the VPC NAT gateway. Each object should include `vpc_uuid` and can set `default_gateway`.","items":{"type":"string"}}}},"example":{"icmp_timeout_seconds":"","name":"","size":"","tcp_timeout_seconds":"","udp_timeout_seconds":"","vpcs":[]}}}}},"delete":{"tags":["VPC NAT Gateways"],"parameters":[{"name":"id","in":"path","description":"The unique identifier of the VPC NAT gateway.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.digitalocean.com/reference/api/api-reference/#tag/VPC-NAT-Gateways/operation/vpcnatgateways_delete","api_endpoint":"https://api.digitalocean.com/v2/vpc_nat_gateways/{id}"},"summary":"Delete VPC NAT Gateway","description":"To destroy a VPC NAT gateway send a DELETE request to `/v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/vpcs":{"get":{"tags":["VPCs"],"parameters":[{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/vpcs"},"summary":"List All VPCs","description":"To list all of the VPCs on your account send a GET request to `/v2/vpcs`.","security":[{"bearerAuth":[]}]},"post":{"tags":["VPCs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/vpcs"},"summary":"Create a New VPC","description":"To create a VPC send a POST request to `/v2/vpcs` specifying the attributes\nin the table below in the JSON body.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/vpcs/{vpc_id}":{"get":{"tags":["VPCs"],"parameters":[{"name":"vpc_id","in":"path","description":"A unique identifier for a VPC","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/vpcs/{vpc_id}"},"summary":"Retrieve an Existing VPC","description":"To show information about an existing VPC send a GET request to `/v2/vpcs/$VPC_ID`.","security":[{"bearerAuth":[]}]},"put":{"tags":["VPCs"],"parameters":[{"name":"vpc_id","in":"path","description":"A unique identifier for a VPC","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/vpcs/{vpc_id}"},"summary":"Update a VPC","description":"To update information about a VPC send a PUT request to `/v2/vpcs/$VPC_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"patch":{"tags":["VPCs"],"parameters":[{"name":"vpc_id","in":"path","description":"A unique identifier for a VPC","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/vpcs/{vpc_id}"},"summary":"Partially Update a VPC","description":"To update a subset of information about a VPC send a PATCH request to\n`/v2/vpcs/$VPC_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["VPCs"],"parameters":[{"name":"vpc_id","in":"path","description":"A unique identifier for a VPC","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/vpcs/{vpc_id}"},"summary":"Delete a VPC","description":"To delete a VPC send a DELETE request to `/v2/vpcs/$VPC_ID`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/vpcs/{vpc_id}/members":{"get":{"tags":["VPCs"],"parameters":[{"name":"vpc_id","in":"path","description":"A unique identifier for a VPC","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Which 'page' of paginated results to return","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of items returned per page","schema":{"type":"number","example":""}},{"name":"resource_type","in":"query","description":"Used to filter VPC members by a resource type","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.digitalocean.com/v2/vpcs/{vpc_id}/members"},"summary":"List the Member Resources of a VPC","description":"To list all of the resources that are members of a VPC send a GET request to\n`/v2/vpcs/$VPC_ID/members`.","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}