id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
api_score
float64
0
10
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d79b2c9b-0720-4d52-b6bd-3247e1d799a1/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_options
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.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d79b2c9b-0720-4d52-b6bd-3247e1d799a1/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_options
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.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d79b2c9b-0720-4d52-b6bd-3247e1d799a1/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_options
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.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ba8cdc75-625a-43c3-91a8-a2e77147cfc3/0/0
Digital Ocean
Digital Ocean Public API
null
functions_update_trigger
Updates the details of the given trigger. To update a trigger, send a PUT request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME with new values for the is_enabled or scheduled_details properties.
404
null
{"id": "not_found", "message": "namespace not found", "request_id": "88d17b7a-630b-4083-99ce-5b91045efdb4"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ba8cdc75-625a-43c3-91a8-a2e77147cfc3/0/1
Digital Ocean
Digital Ocean Public API
null
functions_update_trigger
Updates the details of the given trigger. To update a trigger, send a PUT request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME with new values for the is_enabled or scheduled_details properties.
404
null
{"id": "not_found", "message": "trigger not found", "request_id": "88d17b7a-630b-4083-99ce-5b91045efdb4"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ba8cdc75-625a-43c3-91a8-a2e77147cfc3/1/0
Digital Ocean
Digital Ocean Public API
null
functions_update_trigger
Updates the details of the given trigger. To update a trigger, send a PUT request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME with new values for the is_enabled or scheduled_details properties.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ba8cdc75-625a-43c3-91a8-a2e77147cfc3/2/0
Digital Ocean
Digital Ocean Public API
null
functions_update_trigger
Updates the details of the given trigger. To update a trigger, send a PUT request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME with new values for the is_enabled or scheduled_details properties.
200
null
{"trigger": {"namespace": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "name": "my trigger", "function": "hello", "type": "SCHEDULED", "is_enabled": true, "created_at": "2022-11-11T04:16:45Z", "updated_at": "2022-11-11T04:16:45Z", "scheduled_details": {"cron": "* * * * *", "body": {"name": "Welcome to DO!"}}, "scheduled_runs": {"last_run_at": "2022-11-11T04:16:45Z", "next_run_at": "2022-11-11T04:16:45Z"}}}
{"type": "object", "properties": {"trigger": {"type": "object", "properties": {"namespace": {"type": "string", "description": "A unique string format of UUID with a prefix fn-."}, "name": {"type": "string", "description": "The trigger's unique name within the namespace."}, "function": {"type": "string", "description": "Name of function(action) that exists in the given namespace."}, "type": {"type": "string", "description": "String which indicates the type of trigger source like SCHEDULED."}, "is_enabled": {"type": "boolean", "description": "Indicates weather the trigger is paused or unpaused."}, "created_at": {"type": "string", "description": "UTC time string."}, "updated_at": {"type": "string", "description": "UTC time string."}, "scheduled_details": {"type": "object", "description": "Trigger details for SCHEDULED type, where body is optional.\n", "properties": {"cron": {"description": "valid cron expression string which is required for SCHEDULED type triggers.", "type": "string"}, "body": {"description": "Optional data to be sent to function while triggering the function.", "type": ["object", "null"], "properties": {"name": {"type": "string"}}}}, "required": ["cron"]}, "scheduled_runs": {"type": "object", "properties": {"last_run_at": {"description": "Indicates last run time. null value indicates trigger not run yet.", "type": ["string", "null"]}, "next_run_at": {"description": "Indicates next run time. null value indicates trigger will not run.", "type": ["string", "null"]}}}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ba8cdc75-625a-43c3-91a8-a2e77147cfc3/3/0
Digital Ocean
Digital Ocean Public API
null
functions_update_trigger
Updates the details of the given trigger. To update a trigger, send a PUT request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME with new values for the is_enabled or scheduled_details properties.
400
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ba8cdc75-625a-43c3-91a8-a2e77147cfc3/4/0
Digital Ocean
Digital Ocean Public API
null
functions_update_trigger
Updates the details of the given trigger. To update a trigger, send a PUT request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME with new values for the is_enabled or scheduled_details properties.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ba8cdc75-625a-43c3-91a8-a2e77147cfc3/5/0
Digital Ocean
Digital Ocean Public API
null
functions_update_trigger
Updates the details of the given trigger. To update a trigger, send a PUT request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME with new values for the is_enabled or scheduled_details properties.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1ca2b8b2-e661-4941-848a-d0c8cd77ff5f/0/0
Digital Ocean
Digital Ocean Public API
null
functions_get_namespace
Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID with no parameters.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1ca2b8b2-e661-4941-848a-d0c8cd77ff5f/1/0
Digital Ocean
Digital Ocean Public API
null
functions_get_namespace
Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID with no parameters.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1ca2b8b2-e661-4941-848a-d0c8cd77ff5f/2/0
Digital Ocean
Digital Ocean Public API
null
functions_get_namespace
Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID with no parameters.
200
null
{"namespace": {"api_host": "https://api_host.io", "namespace": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "created_at": "2022-09-14T04:16:45Z", "updated_at": "2022-09-14T04:16:45Z", "label": "my namespace", "region": "nyc1", "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "key": "d1zcd455h01mqjfs4s2eaewyejehi5f2uj4etqq3h7cera8iwkub6xg5of1wdde2"}}
{"type": "object", "properties": {"namespace": {"type": "object", "properties": {"api_host": {"type": "string", "description": "The namespace's API hostname. Each function in a namespace is provided an endpoint at the namespace's hostname."}, "namespace": {"type": "string", "description": "A unique string format of UUID with a prefix fn-."}, "created_at": {"type": "string", "description": "UTC time string."}, "updated_at": {"type": "string", "description": "UTC time string."}, "label": {"type": "string", "description": "The namespace's unique name."}, "region": {"type": "string", "description": "The namespace's datacenter region."}, "uuid": {"type": "string", "description": "The namespace's Universally Unique Identifier."}, "key": {"type": "string", "description": "A random alpha numeric string. This key is used in conjunction with the namespace's UUID to authenticate \na user to use the namespace via `doctl`, DigitalOcean's official CLI."}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1ca2b8b2-e661-4941-848a-d0c8cd77ff5f/3/0
Digital Ocean
Digital Ocean Public API
null
functions_get_namespace
Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID with no parameters.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1ca2b8b2-e661-4941-848a-d0c8cd77ff5f/4/0
Digital Ocean
Digital Ocean Public API
null
functions_get_namespace
Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID with no parameters.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1ca2b8b2-e661-4941-848a-d0c8cd77ff5f/5/0
Digital Ocean
Digital Ocean Public API
null
functions_get_namespace
Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID with no parameters.
403
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/39ea99c2-dd30-44a9-af30-db8ee005232e/0/0
Digital Ocean
Digital Ocean Public API
null
functions_create_trigger
Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to /v2/functions/namespaces/$NAMESPACE_ID/triggers with the name, function, type, is_enabled and scheduled_details properties.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/39ea99c2-dd30-44a9-af30-db8ee005232e/1/0
Digital Ocean
Digital Ocean Public API
null
functions_create_trigger
Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to /v2/functions/namespaces/$NAMESPACE_ID/triggers with the name, function, type, is_enabled and scheduled_details properties.
400
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/39ea99c2-dd30-44a9-af30-db8ee005232e/2/0
Digital Ocean
Digital Ocean Public API
null
functions_create_trigger
Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to /v2/functions/namespaces/$NAMESPACE_ID/triggers with the name, function, type, is_enabled and scheduled_details properties.
200
null
{"trigger": {"namespace": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "name": "my trigger", "function": "hello", "type": "SCHEDULED", "is_enabled": true, "created_at": "2022-11-11T04:16:45Z", "updated_at": "2022-11-11T04:16:45Z", "scheduled_details": {"cron": "* * * * *", "body": {"name": "Welcome to DO!"}}, "scheduled_runs": {"last_run_at": "2022-11-11T04:16:45Z", "next_run_at": "2022-11-11T04:16:45Z"}}}
{"type": "object", "properties": {"trigger": {"type": "object", "properties": {"namespace": {"type": "string", "description": "A unique string format of UUID with a prefix fn-."}, "name": {"type": "string", "description": "The trigger's unique name within the namespace."}, "function": {"type": "string", "description": "Name of function(action) that exists in the given namespace."}, "type": {"type": "string", "description": "String which indicates the type of trigger source like SCHEDULED."}, "is_enabled": {"type": "boolean", "description": "Indicates weather the trigger is paused or unpaused."}, "created_at": {"type": "string", "description": "UTC time string."}, "updated_at": {"type": "string", "description": "UTC time string."}, "scheduled_details": {"type": "object", "description": "Trigger details for SCHEDULED type, where body is optional.\n", "properties": {"cron": {"description": "valid cron expression string which is required for SCHEDULED type triggers.", "type": "string"}, "body": {"description": "Optional data to be sent to function while triggering the function.", "type": ["object", "null"], "properties": {"name": {"type": "string"}}}}, "required": ["cron"]}, "scheduled_runs": {"type": "object", "properties": {"last_run_at": {"description": "Indicates last run time. null value indicates trigger not run yet.", "type": ["string", "null"]}, "next_run_at": {"description": "Indicates next run time. null value indicates trigger will not run.", "type": ["string", "null"]}}}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/39ea99c2-dd30-44a9-af30-db8ee005232e/3/0
Digital Ocean
Digital Ocean Public API
null
functions_create_trigger
Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to /v2/functions/namespaces/$NAMESPACE_ID/triggers with the name, function, type, is_enabled and scheduled_details properties.
422
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/39ea99c2-dd30-44a9-af30-db8ee005232e/4/0
Digital Ocean
Digital Ocean Public API
null
functions_create_trigger
Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to /v2/functions/namespaces/$NAMESPACE_ID/triggers with the name, function, type, is_enabled and scheduled_details properties.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/39ea99c2-dd30-44a9-af30-db8ee005232e/5/0
Digital Ocean
Digital Ocean Public API
null
functions_create_trigger
Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to /v2/functions/namespaces/$NAMESPACE_ID/triggers with the name, function, type, is_enabled and scheduled_details properties.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/39ea99c2-dd30-44a9-af30-db8ee005232e/6/0
Digital Ocean
Digital Ocean Public API
null
functions_create_trigger
Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to /v2/functions/namespaces/$NAMESPACE_ID/triggers with the name, function, type, is_enabled and scheduled_details properties.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a57fc960-963a-4dd6-a0cd-41e499b9d5b2/0/0
Digital Ocean
Digital Ocean Public API
null
functions_get_trigger
Gets the trigger details. To get the trigger details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a57fc960-963a-4dd6-a0cd-41e499b9d5b2/1/0
Digital Ocean
Digital Ocean Public API
null
functions_get_trigger
Gets the trigger details. To get the trigger details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME.
200
null
{"trigger": {"namespace": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "name": "my trigger", "function": "hello", "type": "SCHEDULED", "is_enabled": true, "created_at": "2022-11-11T04:16:45Z", "updated_at": "2022-11-11T04:16:45Z", "scheduled_details": {"cron": "* * * * *", "body": {"name": "Welcome to DO!"}}, "scheduled_runs": {"last_run_at": "2022-11-11T04:16:45Z", "next_run_at": "2022-11-11T04:16:45Z"}}}
{"type": "object", "properties": {"trigger": {"type": "object", "properties": {"namespace": {"type": "string", "description": "A unique string format of UUID with a prefix fn-."}, "name": {"type": "string", "description": "The trigger's unique name within the namespace."}, "function": {"type": "string", "description": "Name of function(action) that exists in the given namespace."}, "type": {"type": "string", "description": "String which indicates the type of trigger source like SCHEDULED."}, "is_enabled": {"type": "boolean", "description": "Indicates weather the trigger is paused or unpaused."}, "created_at": {"type": "string", "description": "UTC time string."}, "updated_at": {"type": "string", "description": "UTC time string."}, "scheduled_details": {"type": "object", "description": "Trigger details for SCHEDULED type, where body is optional.\n", "properties": {"cron": {"description": "valid cron expression string which is required for SCHEDULED type triggers.", "type": "string"}, "body": {"description": "Optional data to be sent to function while triggering the function.", "type": ["object", "null"], "properties": {"name": {"type": "string"}}}}, "required": ["cron"]}, "scheduled_runs": {"type": "object", "properties": {"last_run_at": {"description": "Indicates last run time. null value indicates trigger not run yet.", "type": ["string", "null"]}, "next_run_at": {"description": "Indicates next run time. null value indicates trigger will not run.", "type": ["string", "null"]}}}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a57fc960-963a-4dd6-a0cd-41e499b9d5b2/2/0
Digital Ocean
Digital Ocean Public API
null
functions_get_trigger
Gets the trigger details. To get the trigger details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME.
404
null
{"id": "not_found", "message": "namespace not found", "request_id": "88d17b7a-630b-4083-99ce-5b91045efdb4"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a57fc960-963a-4dd6-a0cd-41e499b9d5b2/2/1
Digital Ocean
Digital Ocean Public API
null
functions_get_trigger
Gets the trigger details. To get the trigger details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME.
404
null
{"id": "not_found", "message": "trigger not found", "request_id": "88d17b7a-630b-4083-99ce-5b91045efdb4"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a57fc960-963a-4dd6-a0cd-41e499b9d5b2/3/0
Digital Ocean
Digital Ocean Public API
null
functions_get_trigger
Gets the trigger details. To get the trigger details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a57fc960-963a-4dd6-a0cd-41e499b9d5b2/4/0
Digital Ocean
Digital Ocean Public API
null
functions_get_trigger
Gets the trigger details. To get the trigger details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d93cd9a7-975c-4cae-ac91-1489c06a2275/0/0
Digital Ocean
Digital Ocean Public API
null
functions_list_triggers
Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d93cd9a7-975c-4cae-ac91-1489c06a2275/1/0
Digital Ocean
Digital Ocean Public API
null
functions_list_triggers
Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d93cd9a7-975c-4cae-ac91-1489c06a2275/2/0
Digital Ocean
Digital Ocean Public API
null
functions_list_triggers
Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d93cd9a7-975c-4cae-ac91-1489c06a2275/3/0
Digital Ocean
Digital Ocean Public API
null
functions_list_triggers
Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d93cd9a7-975c-4cae-ac91-1489c06a2275/4/0
Digital Ocean
Digital Ocean Public API
null
functions_list_triggers
Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers.
200
null
{"triggers": [{"namespace": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "name": "my trigger", "function": "hello", "type": "SCHEDULED", "is_enabled": true, "created_at": "2022-11-11T04:16:45Z", "updated_at": "2022-11-11T04:16:45Z", "scheduled_details": {"cron": "* * * * *", "body": {"name": "Welcome to DO!"}}, "scheduled_runs": {"last_run_at": "2022-11-11T04:16:45Z", "next_run_at": "2022-11-11T04:16:45Z"}}]}
{"allOf": [{"type": "object", "properties": {"triggers": {"type": "array", "items": {"type": "object", "properties": {"namespace": {"type": "string", "description": "A unique string format of UUID with a prefix fn-."}, "name": {"type": "string", "description": "The trigger's unique name within the namespace."}, "function": {"type": "string", "description": "Name of function(action) that exists in the given namespace."}, "type": {"type": "string", "description": "String which indicates the type of trigger source like SCHEDULED."}, "is_enabled": {"type": "boolean", "description": "Indicates weather the trigger is paused or unpaused."}, "created_at": {"type": "string", "description": "UTC time string."}, "updated_at": {"type": "string", "description": "UTC time string."}, "scheduled_details": {"type": "object", "description": "Trigger details for SCHEDULED type, where body is optional.\n", "properties": {"cron": {"description": "valid cron expression string which is required for SCHEDULED type triggers.", "type": "string"}, "body": {"description": "Optional data to be sent to function while triggering the function.", "type": ["object", "null"], "properties": {"name": {"type": "string"}}}}, "required": ["cron"]}, "scheduled_runs": {"type": "object", "properties": {"last_run_at": {"description": "Indicates last run time. null value indicates trigger not run yet.", "type": ["string", "null"]}, "next_run_at": {"description": "Indicates next run time. null value indicates trigger will not run.", "type": ["string", "null"]}}}}}}}}]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b0242b45-a9c8-47ab-b869-ae9bcb4af1d2/0/0
Digital Ocean
Digital Ocean Public API
null
functions_delete_namespace
Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and triggers. Deleting a namespace is a destructive operation and assets in the namespace are not recoverable after deletion. Some metadata is retained, such as activations, or soft deleted for reporting purposes. To delete namespace, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID. A successful deletion returns a 204 response.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b0242b45-a9c8-47ab-b869-ae9bcb4af1d2/1/0
Digital Ocean
Digital Ocean Public API
null
functions_delete_namespace
Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and triggers. Deleting a namespace is a destructive operation and assets in the namespace are not recoverable after deletion. Some metadata is retained, such as activations, or soft deleted for reporting purposes. To delete namespace, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID. A successful deletion returns a 204 response.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b0242b45-a9c8-47ab-b869-ae9bcb4af1d2/2/0
Digital Ocean
Digital Ocean Public API
null
functions_delete_namespace
Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and triggers. Deleting a namespace is a destructive operation and assets in the namespace are not recoverable after deletion. Some metadata is retained, such as activations, or soft deleted for reporting purposes. To delete namespace, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID. A successful deletion returns a 204 response.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b0242b45-a9c8-47ab-b869-ae9bcb4af1d2/3/0
Digital Ocean
Digital Ocean Public API
null
functions_delete_namespace
Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and triggers. Deleting a namespace is a destructive operation and assets in the namespace are not recoverable after deletion. Some metadata is retained, such as activations, or soft deleted for reporting purposes. To delete namespace, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID. A successful deletion returns a 204 response.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/35d128cb-8ba0-46e4-9c4d-3a08a4f28b6d/0/0
Digital Ocean
Digital Ocean Public API
null
apps_validate_appSpec
To propose and validate a spec for a new or existing app, send a POST request to the /v2/apps/propose endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/35d128cb-8ba0-46e4-9c4d-3a08a4f28b6d/1/0
Digital Ocean
Digital Ocean Public API
null
apps_validate_appSpec
To propose and validate a spec for a new or existing app, send a POST request to the /v2/apps/propose endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/35d128cb-8ba0-46e4-9c4d-3a08a4f28b6d/2/0
Digital Ocean
Digital Ocean Public API
null
apps_validate_appSpec
To propose and validate a spec for a new or existing app, send a POST request to the /v2/apps/propose endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/35d128cb-8ba0-46e4-9c4d-3a08a4f28b6d/3/0
Digital Ocean
Digital Ocean Public API
null
apps_validate_appSpec
To propose and validate a spec for a new or existing app, send a POST request to the /v2/apps/propose endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app.
200
null
{"app_name_available": true, "existing_static_apps": "2", "max_free_static_apps": "3", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "digitalocean/sample-golang", "branch": "branch"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "ams"}, "app_cost": 5, "app_tier_upgrade_cost": 17}
{"type": "object", "properties": {"app_is_static": {"type": "boolean", "description": "Indicates whether the app is a static app."}, "app_name_available": {"type": "boolean", "description": "Indicates whether the app name is available."}, "app_name_suggestion": {"type": "string", "description": "The suggested name if the proposed app name is unavailable."}, "existing_static_apps": {"type": "string", "description": "The maximum number of free static apps the account can have. We will charge you for any additional static apps."}, "spec": {"title": "AppSpec", "type": "object", "description": "The desired configuration of an application.", "properties": {"name": {"description": "**Omitted**"}, "region": {"description": "**Omitted**"}, "domains": {"description": "**Omitted**"}, "services": {"description": "**Omitted**"}, "static_sites": {"description": "**Omitted**"}, "jobs": {"description": "**Omitted**"}, "workers": {"description": "**Omitted**"}, "functions": {"description": "**Omitted**"}, "databases": {"description": "**Omitted**"}}, "required": ["name"]}, "app_cost": {"type": "integer", "format": "int32", "description": "The monthly cost of the proposed app in USD using the next pricing plan tier. For example, if you propose an app that uses the Basic tier, the `app_tier_upgrade_cost` field displays the monthly cost of the app if it were to use the Professional tier. If the proposed app already uses the most expensive tier, the field is empty.", "minimum": -2147483648, "maximum": 2147483647}, "app_tier_downgrade_cost": {"type": "integer", "format": "int32", "description": "The monthly cost of the proposed app in USD using the previous pricing plan tier. For example, if you propose an app that uses the Professional tier, the `app_tier_downgrade_cost` field displays the monthly cost of the app if it were to use the Basic tier. If the proposed app already uses the lest expensive tier, the field is empty.", "minimum": -2147483648, "maximum": 2147483647}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/80571747-41a2-48b3-98f5-c5bea152ff3a/0/0
Digital Ocean
Digital Ocean Public API
null
functions_list_namespaces
Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to /v2/functions/namespaces.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/80571747-41a2-48b3-98f5-c5bea152ff3a/1/0
Digital Ocean
Digital Ocean Public API
null
functions_list_namespaces
Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to /v2/functions/namespaces.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/80571747-41a2-48b3-98f5-c5bea152ff3a/2/0
Digital Ocean
Digital Ocean Public API
null
functions_list_namespaces
Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to /v2/functions/namespaces.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/80571747-41a2-48b3-98f5-c5bea152ff3a/3/0
Digital Ocean
Digital Ocean Public API
null
functions_list_namespaces
Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to /v2/functions/namespaces.
200
null
{"namespaces": [{"api_host": "https://api_host.io", "namespace": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "created_at": "2022-09-14T04:16:45Z", "updated_at": "2022-09-14T04:16:45Z", "label": "my namespace", "region": "nyc1", "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "key": "d1zcd455h01mqjfs4s2eaewyejehi5f2uj4etqq3h7cera8iwkub6xg5of1wdde2"}]}
{"allOf": [{"type": "object", "properties": {"namespaces": {"type": "array", "items": {"type": "object", "properties": {"api_host": {"type": "string", "description": "The namespace's API hostname. Each function in a namespace is provided an endpoint at the namespace's hostname."}, "namespace": {"type": "string", "description": "A unique string format of UUID with a prefix fn-."}, "created_at": {"type": "string", "description": "UTC time string."}, "updated_at": {"type": "string", "description": "UTC time string."}, "label": {"type": "string", "description": "The namespace's unique name."}, "region": {"type": "string", "description": "The namespace's datacenter region."}, "uuid": {"type": "string", "description": "The namespace's Universally Unique Identifier."}, "key": {"type": "string", "description": "A random alpha numeric string. This key is used in conjunction with the namespace's UUID to authenticate \na user to use the namespace via `doctl`, DigitalOcean's official CLI."}}}}}}]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/52bcb0eb-0176-4cbd-8b23-b29baf58fd9a/0/0
Digital Ocean
Digital Ocean Public API
null
firewalls_create
To create a new firewall, send a POST request to /v2/firewalls. The request must contain at least one inbound or outbound access rule.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/52bcb0eb-0176-4cbd-8b23-b29baf58fd9a/1/0
Digital Ocean
Digital Ocean Public API
null
firewalls_create
To create a new firewall, send a POST request to /v2/firewalls. The request must contain at least one inbound or outbound access rule.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/52bcb0eb-0176-4cbd-8b23-b29baf58fd9a/2/0
Digital Ocean
Digital Ocean Public API
null
firewalls_create
To create a new firewall, send a POST request to /v2/firewalls. The request must contain at least one inbound or outbound access rule.
202
null
{"firewall": {"inbound_rules": [], "outbound_rules": []}}
{"properties": {"firewall": {"type": "object", "allOf": [{"properties": {"id": {"type": "string", "description": "A unique ID that can be used to identify and reference a firewall."}, "status": {"type": "string", "description": "A status string indicating the current state of the firewall. This can be \"waiting\", \"succeeded\", or \"failed\".", "enum": ["waiting", "succeeded", "failed"]}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the firewall was created."}, "pending_changes": {"type": "array", "description": "An array of objects each containing the fields \"droplet_id\", \"removing\", and \"status\". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied.", "items": {"type": "object", "properties": {"droplet_id": {"description": "**Omitted**"}, "removing": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}}}}, "name": {"type": "string", "description": "A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\.-]+$"}, "droplet_ids": {"type": ["array", "null"], "description": "An array containing the IDs of the Droplets assigned to the firewall.", "items": {"type": "integer"}}, "tags": {"allOf": [{"type": ["array", "null"], "items": {"description": "**Omitted**"}, "description": "A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags."}, {"description": "An array containing the names of the Tags assigned to the firewall."}]}}}, {"type": "object", "properties": {"inbound_rules": {"type": ["array", "null"], "items": {"allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}, "outbound_rules": {"type": ["array", "null"], "items": {"allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/52bcb0eb-0176-4cbd-8b23-b29baf58fd9a/3/0
Digital Ocean
Digital Ocean Public API
null
firewalls_create
To create a new firewall, send a POST request to /v2/firewalls. The request must contain at least one inbound or outbound access rule.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/52bcb0eb-0176-4cbd-8b23-b29baf58fd9a/4/0
Digital Ocean
Digital Ocean Public API
null
firewalls_create
To create a new firewall, send a POST request to /v2/firewalls. The request must contain at least one inbound or outbound access rule.
400
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/50e8aeb2-98da-4f5b-b39f-726ee113ed72/0/0
Digital Ocean
Digital Ocean Public API
null
functions_create_namespace
Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to /v2/functions/namespaces with the region and label properties.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/50e8aeb2-98da-4f5b-b39f-726ee113ed72/1/0
Digital Ocean
Digital Ocean Public API
null
functions_create_namespace
Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to /v2/functions/namespaces with the region and label properties.
200
null
{"namespace": {"api_host": "https://api_host.io", "namespace": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "created_at": "2022-09-14T04:16:45Z", "updated_at": "2022-09-14T04:16:45Z", "label": "my namespace", "region": "nyc1", "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "key": "d1zcd455h01mqjfs4s2eaewyejehi5f2uj4etqq3h7cera8iwkub6xg5of1wdde2"}}
{"type": "object", "properties": {"namespace": {"type": "object", "properties": {"api_host": {"type": "string", "description": "The namespace's API hostname. Each function in a namespace is provided an endpoint at the namespace's hostname."}, "namespace": {"type": "string", "description": "A unique string format of UUID with a prefix fn-."}, "created_at": {"type": "string", "description": "UTC time string."}, "updated_at": {"type": "string", "description": "UTC time string."}, "label": {"type": "string", "description": "The namespace's unique name."}, "region": {"type": "string", "description": "The namespace's datacenter region."}, "uuid": {"type": "string", "description": "The namespace's Universally Unique Identifier."}, "key": {"type": "string", "description": "A random alpha numeric string. This key is used in conjunction with the namespace's UUID to authenticate \na user to use the namespace via `doctl`, DigitalOcean's official CLI."}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/50e8aeb2-98da-4f5b-b39f-726ee113ed72/2/0
Digital Ocean
Digital Ocean Public API
null
functions_create_namespace
Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to /v2/functions/namespaces with the region and label properties.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/50e8aeb2-98da-4f5b-b39f-726ee113ed72/3/0
Digital Ocean
Digital Ocean Public API
null
functions_create_namespace
Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to /v2/functions/namespaces with the region and label properties.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/50e8aeb2-98da-4f5b-b39f-726ee113ed72/4/0
Digital Ocean
Digital Ocean Public API
null
functions_create_namespace
Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to /v2/functions/namespaces with the region and label properties.
422
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/50e8aeb2-98da-4f5b-b39f-726ee113ed72/5/0
Digital Ocean
Digital Ocean Public API
null
functions_create_namespace
Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to /v2/functions/namespaces with the region and label properties.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c84f1326-03ce-4586-814c-fced31d45b12/1/0
Digital Ocean
Digital Ocean Public API
null
functions_delete_trigger
Deletes the given trigger. To delete trigger, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME. A successful deletion returns a 204 response.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c84f1326-03ce-4586-814c-fced31d45b12/2/0
Digital Ocean
Digital Ocean Public API
null
functions_delete_trigger
Deletes the given trigger. To delete trigger, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME. A successful deletion returns a 204 response.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c84f1326-03ce-4586-814c-fced31d45b12/3/0
Digital Ocean
Digital Ocean Public API
null
functions_delete_trigger
Deletes the given trigger. To delete trigger, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME. A successful deletion returns a 204 response.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c84f1326-03ce-4586-814c-fced31d45b12/4/0
Digital Ocean
Digital Ocean Public API
null
functions_delete_trigger
Deletes the given trigger. To delete trigger, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME. A successful deletion returns a 204 response.
404
null
{"id": "not_found", "message": "namespace not found", "request_id": "88d17b7a-630b-4083-99ce-5b91045efdb4"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c84f1326-03ce-4586-814c-fced31d45b12/4/1
Digital Ocean
Digital Ocean Public API
null
functions_delete_trigger
Deletes the given trigger. To delete trigger, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME. A successful deletion returns a 204 response.
404
null
{"id": "not_found", "message": "trigger not found", "request_id": "88d17b7a-630b-4083-99ce-5b91045efdb4"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6d9ae2ce-ce41-46d8-8557-fb6943527068/0/0
Digital Ocean
Digital Ocean Public API
null
domains_update_record
To update an existing record, send a PUT request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record. See the attribute table for details regarding record types and their respective attributes.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6d9ae2ce-ce41-46d8-8557-fb6943527068/1/0
Digital Ocean
Digital Ocean Public API
null
domains_update_record
To update an existing record, send a PUT request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record. See the attribute table for details regarding record types and their respective attributes.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6d9ae2ce-ce41-46d8-8557-fb6943527068/2/0
Digital Ocean
Digital Ocean Public API
null
domains_update_record
To update an existing record, send a PUT request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record. See the attribute table for details regarding record types and their respective attributes.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6d9ae2ce-ce41-46d8-8557-fb6943527068/3/0
Digital Ocean
Digital Ocean Public API
null
domains_update_record
To update an existing record, send a PUT request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record. See the attribute table for details regarding record types and their respective attributes.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6d9ae2ce-ce41-46d8-8557-fb6943527068/4/0
Digital Ocean
Digital Ocean Public API
null
domains_update_record
To update an existing record, send a PUT request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record. See the attribute table for details regarding record types and their respective attributes.
200
null
{"domain_record": {"id": 3352896, "type": "A", "name": "blog", "data": "162.10.66.0", "priority": null, "port": null, "ttl": 1800, "weight": null, "flags": null, "tag": null}}
{"properties": {"domain_record": {"type": "object", "required": ["type"], "properties": {"id": {"type": "integer", "description": "A unique identifier for each domain record."}, "type": {"type": "string", "description": "The type of the DNS record. For example: A, CNAME, TXT, ..."}, "name": {"type": "string", "description": "The host name, alias, or service being defined by the record."}, "data": {"type": "string", "description": "Variable data depending on record type. For example, the \"data\" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates."}, "priority": {"type": ["integer", "null"], "description": "The priority for SRV and MX records."}, "port": {"type": ["integer", "null"], "description": "The port for SRV records."}, "ttl": {"type": "integer", "description": "This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested."}, "weight": {"type": ["integer", "null"], "description": "The weight for SRV records."}, "flags": {"type": ["integer", "null"], "description": "An unsigned integer between 0-255 used for CAA records."}, "tag": {"type": ["string", "null"], "description": "The parameter tag for CAA records. Valid values are \"issue\", \"issuewild\", or \"iodef\""}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/06a57c4b-530d-4f06-a21b-448f16842225/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_delete
To delete an Uptime alert, send a DELETE request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID. A 204 status code with no body will be returned in response to a successful request.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/06a57c4b-530d-4f06-a21b-448f16842225/2/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_delete
To delete an Uptime alert, send a DELETE request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID. A 204 status code with no body will be returned in response to a successful request.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/06a57c4b-530d-4f06-a21b-448f16842225/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_delete
To delete an Uptime alert, send a DELETE request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID. A 204 status code with no body will be returned in response to a successful request.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/06a57c4b-530d-4f06-a21b-448f16842225/4/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_delete
To delete an Uptime alert, send a DELETE request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID. A 204 status code with no body will be returned in response to a successful request.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5a0ef9e8-f7c5-430f-898a-8b53610ba772/0/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_update
To update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK_ID.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5a0ef9e8-f7c5-430f-898a-8b53610ba772/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_update
To update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK_ID.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5a0ef9e8-f7c5-430f-898a-8b53610ba772/2/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_update
To update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK_ID.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5a0ef9e8-f7c5-430f-898a-8b53610ba772/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_update
To update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK_ID.
200
null
{"check": {"id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "Landing page check", "type": "ping", "target": "https://www.landingpage.com", "regions": ["us_east"], "enabled": true}}
{"type": "object", "properties": {"check": {"type": "object", "allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference the check."}}}, {"type": "object", "properties": {"name": {"type": "string", "description": "A human-friendly display name."}, "type": {"type": "string", "enum": ["ping", "http", "https"], "description": "The type of health check to perform."}, "target": {"type": "string", "format": "url", "description": "The endpoint to perform healthchecks on."}, "regions": {"type": "array", "items": {"type": "string", "enum": ["us_east", "us_west", "eu_west", "se_asia"]}, "description": "An array containing the selected regions to perform healthchecks from."}, "enabled": {"type": "boolean", "default": true, "description": "A boolean value indicating whether the check is enabled/disabled."}}}]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5a0ef9e8-f7c5-430f-898a-8b53610ba772/4/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_update
To update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK_ID.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17f42caf-637e-48f8-bcaf-a8a148484c1e/0/0
Digital Ocean
Digital Ocean Public API
null
projects_assign_resources_default
To assign resources to your default project, send a POST request to /v2/projects/default/resources.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17f42caf-637e-48f8-bcaf-a8a148484c1e/1/0
Digital Ocean
Digital Ocean Public API
null
projects_assign_resources_default
To assign resources to your default project, send a POST request to /v2/projects/default/resources.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17f42caf-637e-48f8-bcaf-a8a148484c1e/2/0
Digital Ocean
Digital Ocean Public API
null
projects_assign_resources_default
To assign resources to your default project, send a POST request to /v2/projects/default/resources.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17f42caf-637e-48f8-bcaf-a8a148484c1e/3/0
Digital Ocean
Digital Ocean Public API
null
projects_assign_resources_default
To assign resources to your default project, send a POST request to /v2/projects/default/resources.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17f42caf-637e-48f8-bcaf-a8a148484c1e/4/0
Digital Ocean
Digital Ocean Public API
null
projects_assign_resources_default
To assign resources to your default project, send a POST request to /v2/projects/default/resources.
200
null
{"resources": [{"urn": "do:droplet:13457723", "assigned_at": "2018-09-28T19:26:37Z", "links": {"self": "https://api.digitalocean.com/v2/droplets/13457723"}, "status": "ok"}, {"urn": "do:domain:example.com", "assigned_at": "2019-03-31T16:24:14Z", "links": {"self": "https://api.digitalocean.com/v2/domains/example.com"}, "status": "ok"}]}
{"type": "object", "properties": {"resources": {"type": "array", "items": {"type": "object", "properties": {"urn": {"type": "string", "pattern": "^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*", "description": "The uniform resource name (URN) for the resource in the format do:resource_type:resource_id."}, "assigned_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was created."}, "links": {"type": "object", "description": "The links object contains the `self` object, which contains the resource relationship.", "properties": {"self": {"type": "string", "format": "uri", "description": "A URI that can be used to retrieve the resource."}}}, "status": {"type": "string", "enum": ["ok", "not_found", "assigned", "already_assigned", "service_down"], "description": "The status of assigning and fetching the resources."}}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/bc514e95-e386-498c-92f1-fc60d0f11719/0/0
Digital Ocean
Digital Ocean Public API
null
certificates_create
To upload new SSL certificate which you have previously generated, send a POST request to /v2/certificates. When uploading a user-generated certificate, the private_key, leaf_certificate, and optionally the certificate_chain attributes should be provided. The type must be set to custom. When using Let's Encrypt to create a certificate, the dns_names attribute must be provided, and the type must be set to lets_encrypt.
201
null
{"certificate": {"id": "892071a0-bb95-49bc-8021-3afd67a210bf", "name": "web-cert-01", "not_after": "2017-02-22T00:23:00Z", "sha1_fingerprint": "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7", "created_at": "2017-02-08T16:02:37Z", "dns_names": [""], "state": "verified", "type": "custom"}}
{"type": "object", "properties": {"certificate": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a certificate."}, "name": {"type": "string", "description": "A unique human-readable name referring to a certificate."}, "not_after": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents the certificate's expiration date."}, "sha1_fingerprint": {"type": "string", "description": "A unique identifier generated from the SHA-1 fingerprint of the certificate."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the certificate was created."}, "dns_names": {"type": "array", "items": {"type": "string"}, "description": "An array of fully qualified domain names (FQDNs) for which the certificate was issued."}, "state": {"type": "string", "enum": ["pending", "verified", "error"], "description": "A string representing the current state of the certificate. It may be `pending`, `verified`, or `error`."}, "type": {"type": "string", "enum": ["custom", "lets_encrypt"], "description": "A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt."}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/bc514e95-e386-498c-92f1-fc60d0f11719/0/1
Digital Ocean
Digital Ocean Public API
null
certificates_create
To upload new SSL certificate which you have previously generated, send a POST request to /v2/certificates. When uploading a user-generated certificate, the private_key, leaf_certificate, and optionally the certificate_chain attributes should be provided. The type must be set to custom. When using Let's Encrypt to create a certificate, the dns_names attribute must be provided, and the type must be set to lets_encrypt.
201
null
{"certificate": {"id": "ba9b9c18-6c59-46c2-99df-70da170a42ba", "name": "web-cert-02", "not_after": "2018-06-07T17:44:12Z", "sha1_fingerprint": "479c82b5c63cb6d3e6fac4624d58a33b267e166c", "created_at": "2018-03-09T18:44:11Z", "dns_names": ["www.example.com", "example.com"], "state": "pending", "type": "lets_encrypt"}}
{"type": "object", "properties": {"certificate": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a certificate."}, "name": {"type": "string", "description": "A unique human-readable name referring to a certificate."}, "not_after": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents the certificate's expiration date."}, "sha1_fingerprint": {"type": "string", "description": "A unique identifier generated from the SHA-1 fingerprint of the certificate."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the certificate was created."}, "dns_names": {"type": "array", "items": {"type": "string"}, "description": "An array of fully qualified domain names (FQDNs) for which the certificate was issued."}, "state": {"type": "string", "enum": ["pending", "verified", "error"], "description": "A string representing the current state of the certificate. It may be `pending`, `verified`, or `error`."}, "type": {"type": "string", "enum": ["custom", "lets_encrypt"], "description": "A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt."}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/bc514e95-e386-498c-92f1-fc60d0f11719/1/0
Digital Ocean
Digital Ocean Public API
null
certificates_create
To upload new SSL certificate which you have previously generated, send a POST request to /v2/certificates. When uploading a user-generated certificate, the private_key, leaf_certificate, and optionally the certificate_chain attributes should be provided. The type must be set to custom. When using Let's Encrypt to create a certificate, the dns_names attribute must be provided, and the type must be set to lets_encrypt.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/bc514e95-e386-498c-92f1-fc60d0f11719/2/0
Digital Ocean
Digital Ocean Public API
null
certificates_create
To upload new SSL certificate which you have previously generated, send a POST request to /v2/certificates. When uploading a user-generated certificate, the private_key, leaf_certificate, and optionally the certificate_chain attributes should be provided. The type must be set to custom. When using Let's Encrypt to create a certificate, the dns_names attribute must be provided, and the type must be set to lets_encrypt.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/bc514e95-e386-498c-92f1-fc60d0f11719/3/0
Digital Ocean
Digital Ocean Public API
null
certificates_create
To upload new SSL certificate which you have previously generated, send a POST request to /v2/certificates. When uploading a user-generated certificate, the private_key, leaf_certificate, and optionally the certificate_chain attributes should be provided. The type must be set to custom. When using Let's Encrypt to create a certificate, the dns_names attribute must be provided, and the type must be set to lets_encrypt.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/68e20f1f-597a-45f4-aa5d-8f9ca87f66b6/0/0
Digital Ocean
Digital Ocean Public API
null
certificates_list
To list all of the certificates available on your account, send a GET request to /v2/certificates.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/68e20f1f-597a-45f4-aa5d-8f9ca87f66b6/1/0
Digital Ocean
Digital Ocean Public API
null
certificates_list
To list all of the certificates available on your account, send a GET request to /v2/certificates.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/68e20f1f-597a-45f4-aa5d-8f9ca87f66b6/2/0
Digital Ocean
Digital Ocean Public API
null
certificates_list
To list all of the certificates available on your account, send a GET request to /v2/certificates.
200
null
{"certificates": [{"id": "892071a0-bb95-49bc-8021-3afd67a210bf", "name": "web-cert-01", "not_after": "2017-02-22T00:23:00Z", "sha1_fingerprint": "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7", "created_at": "2017-02-08T16:02:37Z", "dns_names": [""], "state": "verified", "type": "custom"}, {"id": "ba9b9c18-6c59-46c2-99df-70da170a42ba", "name": "web-cert-02", "not_after": "2018-06-07T17:44:12Z", "sha1_fingerprint": "479c82b5c63cb6d3e6fac4624d58a33b267e166c", "created_at": "2018-03-09T18:44:11Z", "dns_names": ["www.example.com", "example.com"], "state": "verified", "type": "lets_encrypt"}], "links": {}, "meta": {"total": 2}}
{"allOf": [{"type": "object", "properties": {"certificates": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a certificate."}, "name": {"type": "string", "description": "A unique human-readable name referring to a certificate."}, "not_after": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents the certificate's expiration date."}, "sha1_fingerprint": {"type": "string", "description": "A unique identifier generated from the SHA-1 fingerprint of the certificate."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the certificate was created."}, "dns_names": {"type": "array", "items": {"type": "string"}, "description": "An array of fully qualified domain names (FQDNs) for which the certificate was issued."}, "state": {"type": "string", "enum": ["pending", "verified", "error"], "description": "A string representing the current state of the certificate. It may be `pending`, `verified`, or `error`."}, "type": {"type": "string", "enum": ["custom", "lets_encrypt"], "description": "A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt."}}}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/68e20f1f-597a-45f4-aa5d-8f9ca87f66b6/3/0
Digital Ocean
Digital Ocean Public API
null
certificates_list
To list all of the certificates available on your account, send a GET request to /v2/certificates.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/eff216d0-6c8a-4df9-809d-d12f8342a04d/0/0
Digital Ocean
Digital Ocean Public API
null
certificates_get
To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/eff216d0-6c8a-4df9-809d-d12f8342a04d/1/0
Digital Ocean
Digital Ocean Public API
null
certificates_get
To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/eff216d0-6c8a-4df9-809d-d12f8342a04d/2/0
Digital Ocean
Digital Ocean Public API
null
certificates_get
To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.
200
null
{"certificate": {"id": "892071a0-bb95-49bc-8021-3afd67a210bf", "name": "web-cert-01", "not_after": "2017-02-22T00:23:00Z", "sha1_fingerprint": "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7", "created_at": "2017-02-08T16:02:37Z", "dns_names": [""], "state": "verified", "type": "custom"}}
{"type": "object", "properties": {"certificate": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a certificate."}, "name": {"type": "string", "description": "A unique human-readable name referring to a certificate."}, "not_after": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents the certificate's expiration date."}, "sha1_fingerprint": {"type": "string", "description": "A unique identifier generated from the SHA-1 fingerprint of the certificate."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the certificate was created."}, "dns_names": {"type": "array", "items": {"type": "string"}, "description": "An array of fully qualified domain names (FQDNs) for which the certificate was issued."}, "state": {"type": "string", "enum": ["pending", "verified", "error"], "description": "A string representing the current state of the certificate. It may be `pending`, `verified`, or `error`."}, "type": {"type": "string", "enum": ["custom", "lets_encrypt"], "description": "A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt."}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/eff216d0-6c8a-4df9-809d-d12f8342a04d/2/1
Digital Ocean
Digital Ocean Public API
null
certificates_get
To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.
200
null
{"certificate": {"id": "ba9b9c18-6c59-46c2-99df-70da170a42ba", "name": "web-cert-02", "not_after": "2018-06-07T17:44:12Z", "sha1_fingerprint": "479c82b5c63cb6d3e6fac4624d58a33b267e166c", "created_at": "2018-03-09T18:44:11Z", "dns_names": ["www.example.com", "example.com"], "state": "verified", "type": "lets_encrypt"}}
{"type": "object", "properties": {"certificate": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a certificate."}, "name": {"type": "string", "description": "A unique human-readable name referring to a certificate."}, "not_after": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents the certificate's expiration date."}, "sha1_fingerprint": {"type": "string", "description": "A unique identifier generated from the SHA-1 fingerprint of the certificate."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the certificate was created."}, "dns_names": {"type": "array", "items": {"type": "string"}, "description": "An array of fully qualified domain names (FQDNs) for which the certificate was issued."}, "state": {"type": "string", "enum": ["pending", "verified", "error"], "description": "A string representing the current state of the certificate. It may be `pending`, `verified`, or `error`."}, "type": {"type": "string", "enum": ["custom", "lets_encrypt"], "description": "A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt."}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/eff216d0-6c8a-4df9-809d-d12f8342a04d/3/0
Digital Ocean
Digital Ocean Public API
null
certificates_get
To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/eff216d0-6c8a-4df9-809d-d12f8342a04d/4/0
Digital Ocean
Digital Ocean Public API
null
certificates_get
To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/92937944-8458-4a7c-a97d-fce87fd5bf60/0/0
Digital Ocean
Digital Ocean Public API
null
snapshots_get
To retrieve information about a snapshot, send a GET request to /v2/snapshots/$SNAPSHOT_ID. The response will be a JSON object with a key called snapshot. The value of this will be an snapshot object containing the standard snapshot attributes.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/92937944-8458-4a7c-a97d-fce87fd5bf60/1/0
Digital Ocean
Digital Ocean Public API
null
snapshots_get
To retrieve information about a snapshot, send a GET request to /v2/snapshots/$SNAPSHOT_ID. The response will be a JSON object with a key called snapshot. The value of this will be an snapshot object containing the standard snapshot attributes.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/92937944-8458-4a7c-a97d-fce87fd5bf60/2/0
Digital Ocean
Digital Ocean Public API
null
snapshots_get
To retrieve information about a snapshot, send a GET request to /v2/snapshots/$SNAPSHOT_ID. The response will be a JSON object with a key called snapshot. The value of this will be an snapshot object containing the standard snapshot attributes.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/92937944-8458-4a7c-a97d-fce87fd5bf60/3/0
Digital Ocean
Digital Ocean Public API
null
snapshots_get
To retrieve information about a snapshot, send a GET request to /v2/snapshots/$SNAPSHOT_ID. The response will be a JSON object with a key called snapshot. The value of this will be an snapshot object containing the standard snapshot attributes.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}