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/92937944-8458-4a7c-a97d-fce87fd5bf60/4/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.
200
null
{"snapshot": {"id": "6372321", "name": "web-01-1595954862243", "created_at": "2020-07-28T16:47:44Z", "regions": [], "min_disk_size": 25, "size_gigabytes": 2.34, "resource_id": "200776916", "resource_type": "droplet", "tags": []}}
{"properties": {"snapshot": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier for the snapshot."}}, "required": ["id"]}, {"type": "object", "properties": {"name": {"type": "string", "description": "A human-readable name for the snapshot."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the snapshot was created."}, "regions": {"type": "array", "items": {"type": "string"}, "description": "An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values."}, "min_disk_size": {"type": "integer", "description": "The minimum size in GB required for a volume or Droplet to use this snapshot."}, "size_gigabytes": {"type": "number", "format": "float", "description": "The billable size of the snapshot in gigabytes.", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38}}, "required": ["name", "created_at", "regions", "min_disk_size", "size_gigabytes"]}, {"type": "object", "properties": {"resource_id": {"type": "string", "description": "The unique identifier for the resource that the snapshot originated from."}, "resource_type": {"type": "string", "enum": ["droplet", "volume"], "description": "The type of resource that the snapshot originated from."}, "tags": {"description": "An array of Tags the snapshot has been tagged with.", "type": ["array", "null"], "items": {"type": "string"}}}, "required": ["resource_id", "resource_type", "tags"]}]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5bba5fa8-79b0-4625-9df8-4551b84fb360/0/0
Digital Ocean
Digital Ocean Public API
null
snapshots_delete
Both Droplet and volume snapshots are managed through the /v2/snapshots/ endpoint. To delete a snapshot, send a DELETE request to /v2/snapshots/$SNAPSHOT_ID. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
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/5bba5fa8-79b0-4625-9df8-4551b84fb360/1/0
Digital Ocean
Digital Ocean Public API
null
snapshots_delete
Both Droplet and volume snapshots are managed through the /v2/snapshots/ endpoint. To delete a snapshot, send a DELETE request to /v2/snapshots/$SNAPSHOT_ID. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
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/5bba5fa8-79b0-4625-9df8-4551b84fb360/3/0
Digital Ocean
Digital Ocean Public API
null
snapshots_delete
Both Droplet and volume snapshots are managed through the /v2/snapshots/ endpoint. To delete a snapshot, send a DELETE request to /v2/snapshots/$SNAPSHOT_ID. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
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/5bba5fa8-79b0-4625-9df8-4551b84fb360/4/0
Digital Ocean
Digital Ocean Public API
null
snapshots_delete
Both Droplet and volume snapshots are managed through the /v2/snapshots/ endpoint. To delete a snapshot, send a DELETE request to /v2/snapshots/$SNAPSHOT_ID. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
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/f24d2dd3-6764-4add-839b-a7cf44ba5a77/0/0
Digital Ocean
Digital Ocean Public API
null
certificates_delete
To delete a specific certificate, send a DELETE 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/f24d2dd3-6764-4add-839b-a7cf44ba5a77/2/0
Digital Ocean
Digital Ocean Public API
null
certificates_delete
To delete a specific certificate, send a DELETE 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/f24d2dd3-6764-4add-839b-a7cf44ba5a77/3/0
Digital Ocean
Digital Ocean Public API
null
certificates_delete
To delete a specific certificate, send a DELETE 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/f24d2dd3-6764-4add-839b-a7cf44ba5a77/4/0
Digital Ocean
Digital Ocean Public API
null
certificates_delete
To delete a specific certificate, send a DELETE 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/de45a23b-a402-4275-976e-667dfef36aef/0/0
Digital Ocean
Digital Ocean Public API
null
registry_delete
To delete your container registry, destroying all container image data stored in it, send a DELETE request to /v2/registry.
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/de45a23b-a402-4275-976e-667dfef36aef/1/0
Digital Ocean
Digital Ocean Public API
null
registry_delete
To delete your container registry, destroying all container image data stored in it, send a DELETE request to /v2/registry.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/de45a23b-a402-4275-976e-667dfef36aef/3/0
Digital Ocean
Digital Ocean Public API
null
registry_delete
To delete your container registry, destroying all container image data stored in it, send a DELETE request to /v2/registry.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/de45a23b-a402-4275-976e-667dfef36aef/4/0
Digital Ocean
Digital Ocean Public API
null
registry_delete
To delete your container registry, destroying all container image data stored in it, send a DELETE request to /v2/registry.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3e91f93d-8a02-4d78-8676-e8d07a81bd39/0/0
Digital Ocean
Digital Ocean Public API
null
registry_get_garbageCollection
To get information about the currently-active garbage collection for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collection.
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/3e91f93d-8a02-4d78-8676-e8d07a81bd39/1/0
Digital Ocean
Digital Ocean Public API
null
registry_get_garbageCollection
To get information about the currently-active garbage collection for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collection.
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/3e91f93d-8a02-4d78-8676-e8d07a81bd39/2/0
Digital Ocean
Digital Ocean Public API
null
registry_get_garbageCollection
To get information about the currently-active garbage collection for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collection.
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/3e91f93d-8a02-4d78-8676-e8d07a81bd39/3/0
Digital Ocean
Digital Ocean Public API
null
registry_get_garbageCollection
To get information about the currently-active garbage collection for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collection.
200
null
{"garbage_collection": {"uuid": "eff0feee-49c7-4e8f-ba5c-a320c109c8a8", "registry_name": "example", "status": "requested", "created_at": "2020-10-30T21:03:24Z", "updated_at": "2020-10-30T21:03:44Z", "blobs_deleted": 42, "freed_bytes": 667}}
{"type": "object", "properties": {"garbage_collection": {"type": "object", "properties": {"uuid": {"type": "string", "description": "A string specifying the UUID of the garbage collection."}, "registry_name": {"type": "string", "description": "The name of the container registry."}, "status": {"type": "string", "enum": ["requested", "waiting for write JWTs to expire", "scanning manifests", "deleting unreferenced blobs", "cancelling", "failed", "succeeded", "cancelled"], "description": "The current status of this garbage collection."}, "created_at": {"type": "string", "format": "date-time", "description": "The time the garbage collection was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "The time the garbage collection was last updated."}, "blobs_deleted": {"type": "integer", "description": "The number of blobs deleted as a result of this garbage collection."}, "freed_bytes": {"type": "integer", "description": "The number of bytes freed as a result of this garbage collection."}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3e91f93d-8a02-4d78-8676-e8d07a81bd39/4/0
Digital Ocean
Digital Ocean Public API
null
registry_get_garbageCollection
To get information about the currently-active garbage collection for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collection.
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/af5fd815-8e2b-44fb-858a-4ba99673e783/0/0
Digital Ocean
Digital Ocean Public API
null
registry_get
To get information about your container registry, send a GET request to /v2/registry.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/af5fd815-8e2b-44fb-858a-4ba99673e783/1/0
Digital Ocean
Digital Ocean Public API
null
registry_get
To get information about your container registry, send a GET request to /v2/registry.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/af5fd815-8e2b-44fb-858a-4ba99673e783/2/0
Digital Ocean
Digital Ocean Public API
null
registry_get
To get information about your container registry, send a GET request to /v2/registry.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/af5fd815-8e2b-44fb-858a-4ba99673e783/3/0
Digital Ocean
Digital Ocean Public API
null
registry_get
To get information about your container registry, send a GET request to /v2/registry.
200
null
{"registry": {"name": "example", "created_at": "2020-03-21T16:02:37Z", "region": "fra1", "storage_usage_bytes": 29393920, "storage_usage_bytes_updated_at": "2020-11-04T21:39:49.530562231Z", "subscription": {"tier": {"name": "Basic", "slug": "basic", "included_repositories": 5, "included_storage_bytes": 5368709120, "allow_storage_overage": true, "included_bandwidth_bytes": 5368709120, "monthly_price_in_cents": 500, "storage_overage_price_in_cents": 2}, "created_at": "2020-01-23T21:19:12Z", "updated_at": "2020-11-05T15:53:24Z"}}}
{"properties": {"registry": {"type": "object", "properties": {"name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9-]{1,63}$", "description": "A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the registry was created."}, "region": {"type": "string", "description": "Slug of the region where registry data is stored"}, "storage_usage_bytes": {"type": "integer", "description": "The amount of storage used in the registry in bytes."}, "storage_usage_bytes_updated_at": {"type": "string", "format": "date-time", "description": "The time at which the storage usage was updated. Storage usage is calculated asynchronously, and may not immediately reflect pushes to the registry."}, "subscription": {"allOf": [{}, {"type": "object", "properties": {"tier": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the subscription tier."}, "slug": {"type": "string", "description": "The slug identifier of the subscription tier."}, "included_repositories": {"type": "integer", "description": "The number of repositories included in the subscription tier. `0` indicates that the subscription tier includes unlimited repositories."}, "included_storage_bytes": {"type": "integer", "description": "The amount of storage included in the subscription tier in bytes."}, "allow_storage_overage": {"type": "boolean", "description": "A boolean indicating whether the subscription tier supports additional storage above what is included in the base plan at an additional cost per GiB used."}, "included_bandwidth_bytes": {"type": "integer", "description": "The amount of outbound data transfer included in the subscription tier in bytes."}, "monthly_price_in_cents": {"type": "integer", "description": "The monthly cost of the subscription tier in cents."}, "storage_overage_price_in_cents": {"type": "integer", "description": "The price paid in cents per GiB for additional storage beyond what is included in the subscription plan."}}}, "created_at": {"type": "string", "format": "date-time", "description": "The time at which the subscription was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "The time at which the subscription was last updated."}}}]}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/23b8eec3-1db9-439e-ae1c-b5aa70a15474/0/0
Digital Ocean
Digital Ocean Public API
null
registry_update_garbageCollection
To cancel the currently-active garbage collection for a registry, send a PUT request to /v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID and specify one or more of the attributes below.
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/23b8eec3-1db9-439e-ae1c-b5aa70a15474/1/0
Digital Ocean
Digital Ocean Public API
null
registry_update_garbageCollection
To cancel the currently-active garbage collection for a registry, send a PUT request to /v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID and specify one or more of the attributes below.
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/23b8eec3-1db9-439e-ae1c-b5aa70a15474/2/0
Digital Ocean
Digital Ocean Public API
null
registry_update_garbageCollection
To cancel the currently-active garbage collection for a registry, send a PUT request to /v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID and specify one or more of the attributes below.
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/23b8eec3-1db9-439e-ae1c-b5aa70a15474/3/0
Digital Ocean
Digital Ocean Public API
null
registry_update_garbageCollection
To cancel the currently-active garbage collection for a registry, send a PUT request to /v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID and specify one or more of the attributes below.
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/23b8eec3-1db9-439e-ae1c-b5aa70a15474/4/0
Digital Ocean
Digital Ocean Public API
null
registry_update_garbageCollection
To cancel the currently-active garbage collection for a registry, send a PUT request to /v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID and specify one or more of the attributes below.
200
null
{"garbage_collection": {"uuid": "eff0feee-49c7-4e8f-ba5c-a320c109c8a8", "registry_name": "example", "status": "requested", "created_at": "2020-10-30T21:03:24Z", "updated_at": "2020-10-30T21:03:44Z", "blobs_deleted": 42, "freed_bytes": 667}}
{"type": "object", "properties": {"garbage_collection": {"type": "object", "properties": {"uuid": {"type": "string", "description": "A string specifying the UUID of the garbage collection."}, "registry_name": {"type": "string", "description": "The name of the container registry."}, "status": {"type": "string", "enum": ["requested", "waiting for write JWTs to expire", "scanning manifests", "deleting unreferenced blobs", "cancelling", "failed", "succeeded", "cancelled"], "description": "The current status of this garbage collection."}, "created_at": {"type": "string", "format": "date-time", "description": "The time the garbage collection was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "The time the garbage collection was last updated."}, "blobs_deleted": {"type": "integer", "description": "The number of blobs deleted as a result of this garbage collection."}, "freed_bytes": {"type": "integer", "description": "The number of bytes freed as a result of this garbage collection."}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/857f4a4b-12df-4795-8d8c-f534992e04b6/0/0
Digital Ocean
Digital Ocean Public API
null
registry_get_subscription
A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to /v2/registry/subscription.
200
null
{"subscription": {"tier": {"name": "Basic", "slug": "basic", "included_repositories": 5, "included_storage_bytes": 5368709120, "allow_storage_overage": true, "included_bandwidth_bytes": 5368709120, "monthly_price_in_cents": 500, "storage_overage_price_in_cents": 2}, "created_at": "2020-01-23T21:19:12Z", "updated_at": "2020-11-05T15:53:24Z"}}
{"properties": {"subscription": {"type": "object", "properties": {"tier": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the subscription tier."}, "slug": {"type": "string", "description": "The slug identifier of the subscription tier."}, "included_repositories": {"type": "integer", "description": "The number of repositories included in the subscription tier. `0` indicates that the subscription tier includes unlimited repositories."}, "included_storage_bytes": {"type": "integer", "description": "The amount of storage included in the subscription tier in bytes."}, "allow_storage_overage": {"type": "boolean", "description": "A boolean indicating whether the subscription tier supports additional storage above what is included in the base plan at an additional cost per GiB used."}, "included_bandwidth_bytes": {"type": "integer", "description": "The amount of outbound data transfer included in the subscription tier in bytes."}, "monthly_price_in_cents": {"type": "integer", "description": "The monthly cost of the subscription tier in cents."}, "storage_overage_price_in_cents": {"type": "integer", "description": "The price paid in cents per GiB for additional storage beyond what is included in the subscription plan."}}}, "created_at": {"type": "string", "format": "date-time", "description": "The time at which the subscription was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "The time at which the subscription was last updated."}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/857f4a4b-12df-4795-8d8c-f534992e04b6/1/0
Digital Ocean
Digital Ocean Public API
null
registry_get_subscription
A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to /v2/registry/subscription.
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/857f4a4b-12df-4795-8d8c-f534992e04b6/2/0
Digital Ocean
Digital Ocean Public API
null
registry_get_subscription
A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to /v2/registry/subscription.
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/857f4a4b-12df-4795-8d8c-f534992e04b6/3/0
Digital Ocean
Digital Ocean Public API
null
registry_get_subscription
A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to /v2/registry/subscription.
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/847575b3-58e6-44b9-9fbc-746705cfbbb1/0/0
Digital Ocean
Digital Ocean Public API
null
registry_create
To create your container registry, send a POST request to /v2/registry. The name becomes part of the URL for images stored in the registry. For example, if your registry is called example, an image in it will have the URL registry.digitalocean.com/example/image:tag.
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/847575b3-58e6-44b9-9fbc-746705cfbbb1/1/0
Digital Ocean
Digital Ocean Public API
null
registry_create
To create your container registry, send a POST request to /v2/registry. The name becomes part of the URL for images stored in the registry. For example, if your registry is called example, an image in it will have the URL registry.digitalocean.com/example/image:tag.
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/847575b3-58e6-44b9-9fbc-746705cfbbb1/2/0
Digital Ocean
Digital Ocean Public API
null
registry_create
To create your container registry, send a POST request to /v2/registry. The name becomes part of the URL for images stored in the registry. For example, if your registry is called example, an image in it will have the URL registry.digitalocean.com/example/image:tag.
201
null
{"registry": {"name": "example", "created_at": "2020-03-21T16:02:37Z", "region": "fra1", "storage_usage_bytes": 29393920, "storage_usage_bytes_updated_at": "2020-11-04T21:39:49.530562231Z", "subscription": {"tier": {"name": "Basic", "slug": "basic", "included_repositories": 5, "included_storage_bytes": 5368709120, "allow_storage_overage": true, "included_bandwidth_bytes": 5368709120, "monthly_price_in_cents": 500, "storage_overage_price_in_cents": 2}, "created_at": "2020-01-23T21:19:12Z", "updated_at": "2020-11-05T15:53:24Z"}}}
{"properties": {"registry": {"type": "object", "properties": {"name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9-]{1,63}$", "description": "A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the registry was created."}, "region": {"type": "string", "description": "Slug of the region where registry data is stored"}, "storage_usage_bytes": {"type": "integer", "description": "The amount of storage used in the registry in bytes."}, "storage_usage_bytes_updated_at": {"type": "string", "format": "date-time", "description": "The time at which the storage usage was updated. Storage usage is calculated asynchronously, and may not immediately reflect pushes to the registry."}, "subscription": {"allOf": [{}, {"type": "object", "properties": {"tier": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the subscription tier."}, "slug": {"type": "string", "description": "The slug identifier of the subscription tier."}, "included_repositories": {"type": "integer", "description": "The number of repositories included in the subscription tier. `0` indicates that the subscription tier includes unlimited repositories."}, "included_storage_bytes": {"type": "integer", "description": "The amount of storage included in the subscription tier in bytes."}, "allow_storage_overage": {"type": "boolean", "description": "A boolean indicating whether the subscription tier supports additional storage above what is included in the base plan at an additional cost per GiB used."}, "included_bandwidth_bytes": {"type": "integer", "description": "The amount of outbound data transfer included in the subscription tier in bytes."}, "monthly_price_in_cents": {"type": "integer", "description": "The monthly cost of the subscription tier in cents."}, "storage_overage_price_in_cents": {"type": "integer", "description": "The price paid in cents per GiB for additional storage beyond what is included in the subscription plan."}}}, "created_at": {"type": "string", "format": "date-time", "description": "The time at which the subscription was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "The time at which the subscription was last updated."}}}]}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/847575b3-58e6-44b9-9fbc-746705cfbbb1/3/0
Digital Ocean
Digital Ocean Public API
null
registry_create
To create your container registry, send a POST request to /v2/registry. The name becomes part of the URL for images stored in the registry. For example, if your registry is called example, an image in it will have the URL registry.digitalocean.com/example/image:tag.
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/49253af8-eed5-4895-99d2-8b9e003a0ce1/0/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoryManifests
To list all manifests in your container registry repository, send a GET request to /v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests. Note that if your repository name contains / characters, it must be URL-encoded in the request URL. For example, to list manifests for registry.digitalocean.com/example/my/repo, the path would be /v2/registry/example/repositories/my%2Frepo/digests.
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/49253af8-eed5-4895-99d2-8b9e003a0ce1/1/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoryManifests
To list all manifests in your container registry repository, send a GET request to /v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests. Note that if your repository name contains / characters, it must be URL-encoded in the request URL. For example, to list manifests for registry.digitalocean.com/example/my/repo, the path would be /v2/registry/example/repositories/my%2Frepo/digests.
200
null
{"manifests": [{"digest": "sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221", "registry_name": "example", "repository": "repo-1", "compressed_size_bytes": 1972332, "size_bytes": 2816445, "updated_at": "2021-04-09T23:54:25Z", "tags": ["v1", "v2"], "blobs": [{"digest": "sha256:14119a10abf4669e8cdbdff324a9f9605d99697215a0d21c360fe8dfa8471bab", "compressed_size_bytes": 1471}, {"digest": "sha256:a0d0a0d46f8b52473982a3c466318f479767577551a53ffc9074c9fa7035982e", "compressed_size_byte": 2814446}, {"digest": "sha256:69704ef328d05a9f806b6b8502915e6a0a4faa4d72018dc42343f511490daf8a", "compressed_size_bytes": 528}]}], "meta": {"total": 3}, "links": {"pages": {"first": "https://api.digitalocean.com/v2/registry/example/repositories/repo-1/digests?page=1&per_page=1", "prev": "https://api.digitalocean.com/v2/registry/example/repositories/repo-1/digests?page=1&per_page=1", "next": "https://api.digitalocean.com/v2/registry/example/repositories/repo-1/digests?page=3&per_page=1", "last": "https://api.digitalocean.com/v2/registry/example/repositories/repo-1/digests?page=3&per_page=1"}}}
{"allOf": [{"type": "object", "properties": {"manifests": {"type": "array", "items": {"type": "object", "properties": {"registry_name": {"type": "string", "description": "The name of the container registry."}, "repository": {"type": "string", "description": "The name of the repository."}, "digest": {"type": "string", "description": "The manifest digest"}, "compressed_size_bytes": {"type": "integer", "description": "The compressed size of the manifest in bytes."}, "size_bytes": {"type": "integer", "description": "The uncompressed size of the manifest in bytes (this size is calculated asynchronously so it may not be immediately available)."}, "updated_at": {"type": "string", "format": "date-time", "description": "The time the manifest was last updated."}, "tags": {"type": "array", "items": {"type": "string"}, "description": "All tags associated with this manifest"}, "blobs": {"type": "array", "items": {"type": "object", "properties": {"digest": {"description": "**Omitted**"}, "compressed_size_bytes": {"description": "**Omitted**"}}}, "description": "All blobs associated with this manifest"}}}}}}, {"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/49253af8-eed5-4895-99d2-8b9e003a0ce1/2/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoryManifests
To list all manifests in your container registry repository, send a GET request to /v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests. Note that if your repository name contains / characters, it must be URL-encoded in the request URL. For example, to list manifests for registry.digitalocean.com/example/my/repo, the path would be /v2/registry/example/repositories/my%2Frepo/digests.
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/49253af8-eed5-4895-99d2-8b9e003a0ce1/3/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoryManifests
To list all manifests in your container registry repository, send a GET request to /v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests. Note that if your repository name contains / characters, it must be URL-encoded in the request URL. For example, to list manifests for registry.digitalocean.com/example/my/repo, the path would be /v2/registry/example/repositories/my%2Frepo/digests.
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/49253af8-eed5-4895-99d2-8b9e003a0ce1/4/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoryManifests
To list all manifests in your container registry repository, send a GET request to /v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests. Note that if your repository name contains / characters, it must be URL-encoded in the request URL. For example, to list manifests for registry.digitalocean.com/example/my/repo, the path would be /v2/registry/example/repositories/my%2Frepo/digests.
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/fb8da403-c5e8-46ee-8da3-0032738c6b65/0/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoriesV2
To list all repositories in your container registry, send a GET request to /v2/registry/$REGISTRY_NAME/repositoriesV2.
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/fb8da403-c5e8-46ee-8da3-0032738c6b65/1/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoriesV2
To list all repositories in your container registry, send a GET request to /v2/registry/$REGISTRY_NAME/repositoriesV2.
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/fb8da403-c5e8-46ee-8da3-0032738c6b65/2/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoriesV2
To list all repositories in your container registry, send a GET request to /v2/registry/$REGISTRY_NAME/repositoriesV2.
200
null
{"repositories": [{"registry_name": "example", "name": "repo-1", "tag_count": 57, "manifest_count": 82, "latest_manifest": {"digest": "sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221", "registry_name": "example", "repository": "repo-1", "compressed_size_bytes": 1972332, "size_bytes": 2816445, "updated_at": "2021-04-09T23:54:25Z", "tags": ["v1", "v2"], "blobs": [{"digest": "sha256:14119a10abf4669e8cdbdff324a9f9605d99697215a0d21c360fe8dfa8471bab", "compressed_size_bytes": 1471}, {"digest": "sha256:a0d0a0d46f8b52473982a3c466318f479767577551a53ffc9074c9fa7035982e", "compressed_size_byte": 2814446}, {"digest": "sha256:69704ef328d05a9f806b6b8502915e6a0a4faa4d72018dc42343f511490daf8a", "compressed_size_bytes": 528}]}}], "meta": {"total": 5}, "links": {"pages": {"next": "https://api.digitalocean.com/v2/registry/example/repositoriesV2?page=2&page_token=JPZmZzZXQiOjB9&per_page=1", "last": "https://api.digitalocean.com/v2/registry/example/repositoriesV2?page=5&per_page=1"}}}
{"allOf": [{"type": "object", "properties": {"repositories": {"type": "array", "items": {"type": "object", "properties": {"registry_name": {"type": "string", "description": "The name of the container registry."}, "name": {"type": "string", "description": "The name of the repository."}, "latest_manifest": {"type": "object", "properties": {"registry_name": {"type": "string", "description": "The name of the container registry."}, "repository": {"type": "string", "description": "The name of the repository."}, "digest": {"type": "string", "description": "The manifest digest"}, "compressed_size_bytes": {"type": "integer", "description": "The compressed size of the manifest in bytes."}, "size_bytes": {"type": "integer", "description": "The uncompressed size of the manifest in bytes (this size is calculated asynchronously so it may not be immediately available)."}, "updated_at": {"type": "string", "format": "date-time", "description": "The time the manifest was last updated."}, "tags": {"type": "array", "items": {"type": "string"}, "description": "All tags associated with this manifest"}, "blobs": {"type": "array", "items": {"type": "object", "properties": {"digest": {"description": "**Omitted**"}, "compressed_size_bytes": {"description": "**Omitted**"}}}, "description": "All blobs associated with this manifest"}}}, "tag_count": {"type": "integer", "description": "The number of tags in the repository."}, "manifest_count": {"type": "integer", "description": "The number of manifests in the repository."}}}}}}, {"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/fb8da403-c5e8-46ee-8da3-0032738c6b65/3/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoriesV2
To list all repositories in your container registry, send a GET request to /v2/registry/$REGISTRY_NAME/repositoriesV2.
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/fb8da403-c5e8-46ee-8da3-0032738c6b65/4/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoriesV2
To list all repositories in your container registry, send a GET request to /v2/registry/$REGISTRY_NAME/repositoriesV2.
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/fb8da403-c5e8-46ee-8da3-0032738c6b65/5/0
Digital Ocean
Digital Ocean Public API
null
registry_list_repositoriesV2
To list all repositories in your container registry, send a GET request to /v2/registry/$REGISTRY_NAME/repositoriesV2.
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/54463a3d-a20f-4470-9899-81a584107a00/1/0
Digital Ocean
Digital Ocean Public API
null
registry_validate_name
To validate that a container registry name is available for use, send a POST request to /v2/registry/validate-name. If the name is both formatted correctly and available, the response code will be 204 and contain no body. If the name is already in use, the response will be a 409 Conflict.
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/54463a3d-a20f-4470-9899-81a584107a00/2/0
Digital Ocean
Digital Ocean Public API
null
registry_validate_name
To validate that a container registry name is available for use, send a POST request to /v2/registry/validate-name. If the name is both formatted correctly and available, the response code will be 204 and contain no body. If the name is already in use, the response will be a 409 Conflict.
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/54463a3d-a20f-4470-9899-81a584107a00/3/0
Digital Ocean
Digital Ocean Public API
null
registry_validate_name
To validate that a container registry name is available for use, send a POST request to /v2/registry/validate-name. If the name is both formatted correctly and available, the response code will be 204 and contain no body. If the name is already in use, the response will be a 409 Conflict.
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/54463a3d-a20f-4470-9899-81a584107a00/4/0
Digital Ocean
Digital Ocean Public API
null
registry_validate_name
To validate that a container registry name is available for use, send a POST request to /v2/registry/validate-name. If the name is both formatted correctly and available, the response code will be 204 and contain no body. If the name is already in use, the response will be a 409 Conflict.
409
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/44de602d-0007-435e-b104-6f826f553089/0/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_remove_forwardingRules
To remove forwarding rules from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be removed. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/44de602d-0007-435e-b104-6f826f553089/1/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_remove_forwardingRules
To remove forwarding rules from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be removed. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
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/44de602d-0007-435e-b104-6f826f553089/2/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_remove_forwardingRules
To remove forwarding rules from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be removed. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/44de602d-0007-435e-b104-6f826f553089/4/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_remove_forwardingRules
To remove forwarding rules from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be removed. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
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/8c0bf282-7a40-475f-abbb-7e3b6d719c92/0/0
Digital Ocean
Digital Ocean Public API
null
apps_get_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for a single 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/8c0bf282-7a40-475f-abbb-7e3b6d719c92/1/0
Digital Ocean
Digital Ocean Public API
null
apps_get_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for a single app.
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/8c0bf282-7a40-475f-abbb-7e3b6d719c92/2/0
Digital Ocean
Digital Ocean Public API
null
apps_get_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for a single 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/8c0bf282-7a40-475f-abbb-7e3b6d719c92/3/0
Digital Ocean
Digital Ocean Public API
null
apps_get_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for a single app.
200
null
{"app_bandwidth_usage": [{"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf", "bandwidth_bytes": "513668"}], "date": "2023-01-17T00:00:00Z"}
{"type": "object", "properties": {"app_bandwidth_usage": {"type": "array", "items": {"type": "object", "properties": {"app_id": {"type": "string", "description": "The ID of the app."}, "bandwidth_bytes": {"type": "string", "format": "uint64", "description": "The used bandwidth amount in bytes."}}, "description": "Bandwidth usage for an app."}, "description": "A list of bandwidth usage details by app."}, "date": {"type": "string", "format": "date-time", "description": "The date for the metrics data."}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8c0bf282-7a40-475f-abbb-7e3b6d719c92/4/0
Digital Ocean
Digital Ocean Public API
null
apps_get_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for a single 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/61cd2f3b-25fb-4753-9ec5-45c9f470270a/0/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_active_deployment_aggregate
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment 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/61cd2f3b-25fb-4753-9ec5-45c9f470270a/1/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_active_deployment_aggregate
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id.
200
null
{"live_url": "https://logs-example/build.log", "url": "https://logs/build.log", "historic_logs": ["https://logs-example/archive/build.log"]}
{"properties": {"historic_urls": {"items": {"type": "string"}, "title": "A list of URLs to archived log files", "type": "array"}, "live_url": {"description": "A URL of the real-time live logs. This URL may use either the `https://` or `wss://` protocols and will keep pushing live logs as they become available.", "type": "string"}}, "type": "object"}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/61cd2f3b-25fb-4753-9ec5-45c9f470270a/2/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_active_deployment_aggregate
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment 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/61cd2f3b-25fb-4753-9ec5-45c9f470270a/3/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_active_deployment_aggregate
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment 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/61cd2f3b-25fb-4753-9ec5-45c9f470270a/4/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_active_deployment_aggregate
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment 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/1fddffa5-b554-4f19-be7e-1be6fe806826/0/0
Digital Ocean
Digital Ocean Public API
null
apps_update
Update an existing app by submitting a new app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
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/1fddffa5-b554-4f19-be7e-1be6fe806826/1/0
Digital Ocean
Digital Ocean Public API
null
apps_update
Update an existing app by submitting a new app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
200
null
{"app": {"id": "c2a93513-8d9b-4223-9d61-5e7272c81cf5", "owner_uuid": "a4e16f25-cdd1-4483-b246-d77f283c9209", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "ChiefMateStarbuck/sample-golang", "branch": "main"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "ams", "domains": [{"domain": "sample-golang.example.com", "zone": "example.com", "minimum_tls_version": "1.3"}]}, "default_ingress": "https://sample-golang-zyhgn.ondigitalocean.app", "created_at": "2021-02-10T16:45:14Z", "updated_at": "2021-02-10T17:06:56Z", "active_deployment": {"id": "991dfa59-6a23-459f-86d6-67dfa2c6f1e3", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "ChiefMateStarbuck/sample-golang", "branch": "main"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "ams", "domains": [{"domain": "sample-golang.example.com", "zone": "example.com", "minimum_tls_version": "1.3"}]}, "services": [{"name": "web", "source_commit_hash": "db6936cb46047c576962962eed81ad52c21f35d7"}], "phase_last_updated_at": "2021-02-10T17:06:53Z", "created_at": "2021-02-10T17:05:30Z", "updated_at": "2021-02-10T17:06:53Z", "cause": "manual", "progress": {"success_steps": 6, "total_steps": 6, "steps": [{"name": "build", "status": "SUCCESS", "steps": [{"name": "initialize", "status": "SUCCESS", "started_at": "2021-02-10T17:05:35.572347485Z", "ended_at": "2021-02-10T17:05:36.093995229Z"}, {"name": "components", "status": "SUCCESS", "steps": [{"name": "web", "status": "SUCCESS", "component_name": "web", "message_base": "Building service"}], "started_at": "2021-02-10T17:05:36.094015928Z", "ended_at": "2021-02-10T17:06:19.461737040Z"}], "started_at": "2021-02-10T17:05:35.572287990Z", "ended_at": "2021-02-10T17:06:19.807834070Z"}, {"name": "deploy", "status": "SUCCESS", "steps": [{"name": "initialize", "status": "SUCCESS", "started_at": "2021-02-10T17:06:25.143957508Z", "ended_at": "2021-02-10T17:06:26.120343872Z"}, {"name": "components", "status": "SUCCESS", "steps": [{"name": "web", "status": "SUCCESS", "steps": [{"name": "deploy", "status": "SUCCESS", "component_name": "web", "message_base": "Deploying service"}, {"name": "wait", "status": "SUCCESS", "component_name": "web", "message_base": "Waiting for service"}], "component_name": "web"}], "started_at": "2021-02-10T17:06:26.120385561Z", "ended_at": "2021-02-10T17:06:50.029695913Z"}, {"name": "finalize", "status": "SUCCESS", "started_at": "2021-02-10T17:06:50.348459495Z", "ended_at": "2021-02-10T17:06:53.404065961Z"}], "started_at": "2021-02-10T17:06:25.143932418Z", "ended_at": "2021-02-10T17:06:53.404104185Z"}]}, "phase": "ACTIVE", "tier_slug": "basic"}, "last_deployment_created_at": "2021-02-10T17:05:30Z", "live_url": "https://sample-golang-zyhgn.ondigitalocean.app", "pending_deployment": {"id": "3aa4d20e-5527-4c00-b496-601fbd22520a", "spec": {"name": "sample-php", "services": [{"name": "sample-php", "git": {"repo_clone_url": "https://github.com/digitalocean/sample-php.git", "branch": "main"}, "run_command": "heroku-php-apache2", "environment_slug": "php", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "fra", "domains": [{"domain": "sample-php.example.com", "type": "PRIMARY", "zone": "example.com", "minimum_tls_version": "1.3"}]}}, "region": {"slug": "ams", "label": "Amsterdam", "flag": "netherlands", "continent": "Europe", "data_centers": ["ams3"]}, "tier_slug": "basic", "live_url_base": "https://sample-golang-zyhgn.ondigitalocean.app", "live_domain": "sample-golang-zyhgn.ondigitalocean.app", "project_id": "88b72d1a-b78a-4d9f-9090-b53c4399073f", "domains": [{"id": "e206c64e-a1a3-11ed-9e6e-9b7b6dc9a52b", "phase": "CONFIGURING", "spec": {"domain": "sample-golang.example.com", "type": "PRIMARY", "zone": "example.com", "minimum_tls_version": "1.3"}, "rotate_validation_records": false, "certificate_expires_at": "2024-01-29T23:59:59Z", "progress": {"steps": [{"ended_at": "0001-01-01T00:00:00Z", "name": "default-ingress-ready", "started_at": "2023-01-30T22:15:45.021896292Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-zone", "started_at": "2023-01-30T22:15:45.022017004Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:42:28.50752065Z", "name": "ensure-ns-records", "started_at": "2023-01-30T22:15:45.025567874Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "verify-nameservers", "started_at": "2023-01-30T22:15:45.033591906Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-record", "started_at": "2023-01-30T22:15:45.156750604Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.258626422Z", "name": "ensure-alias-record", "started_at": "2023-01-30T22:15:45.165933869Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.258808279Z", "name": "ensure-wildcard-record", "started_at": "2023-01-30T22:15:45.166093422Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "verify-cname", "started_at": "2023-01-30T22:15:45.166205559Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.475903785Z", "name": "ensure-ssl-txt-record-saved", "started_at": "2023-01-30T22:15:45.295237186Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.476017236Z", "name": "ensure-ssl-txt-record", "started_at": "2023-01-30T22:15:45.295315291Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.476094058Z", "name": "ensure-renewal-email", "started_at": "2023-01-30T22:15:45.295374087Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-CA-authorization", "started_at": "2023-01-30T22:15:45.295428101Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-certificate", "started_at": "2023-01-30T22:15:45.978756406Z", "status": "RUNNING"}, {"ended_at": "0001-01-01T00:00:00", "name": "create-deployment", "started_at": "0001-01-01T00:00:00Z", "status": "PENDING"}, {"ended_at": "0001-01-01T00:00:00", "name": "configuration-alert", "started_at": "0001-01-01T00:00:00", "status": "PENDING"}]}}]}}
{"properties": {"app": {"description": "An application's configuration and status.", "properties": {"active_deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}, "created_at": {"format": "date-time", "title": "The creation time of the app", "type": "string"}, "default_ingress": {"title": "The default hostname on which the app is accessible", "type": "string"}, "domains": {"items": {"properties": {"id": {"title": "The ID of the domain", "type": "string"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING", "CONFIGURING", "ACTIVE", "ERROR"], "type": "string"}, "progress": {"properties": {"steps": {"description": "**Omitted**"}}, "type": "object"}, "spec": {"type": "object", "properties": {"domain": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "wildcard": {"description": "**Omitted**"}, "zone": {"description": "**Omitted**"}, "minimum_tls_version": {"description": "**Omitted**"}}, "required": ["domain"]}, "validations": {"title": "List of TXT validation records", "type": "array", "items": {"description": "**Omitted**"}}, "rotate_validation_records": {"title": "Validation values have changed and require manual intervention", "type": "boolean"}, "certificate_expires_at": {"title": "Current SSL certificate expiration time", "type": "string", "format": "date-time"}}, "type": "object"}, "title": "Contains all domains for the app", "type": "array"}, "id": {"title": "The ID of the application", "type": "string"}, "in_progress_deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}, "last_deployment_created_at": {"format": "date-time", "title": "The creation time of the last deployment", "type": "string"}, "live_domain": {"title": "The live domain of the app", "type": "string"}, "live_url": {"title": "The live URL of the app", "type": "string"}, "live_url_base": {"title": "The live URL base of the app, the URL excluding the path", "type": "string"}, "owner_uuid": {"title": "The ID of the account to which the application belongs", "type": "string"}, "pending_deployment": {"allOf": [{"description": "The most recent pending deployment. For CreateApp and UpdateApp transactions this is guaranteed to reflect the associated deployment."}, {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}]}, "project_id": {"type": "string", "title": "The ID of the project the app is assigned to. This will be empty if there is a lookup failure."}, "region": {"properties": {"continent": {"title": "The continent that this region is in", "type": "string"}, "data_centers": {"items": {"type": "string"}, "title": "Data centers that are in this region", "type": "array"}, "default": {"description": "Whether or not the region is presented as the default.", "type": "boolean"}, "disabled": {"title": "Whether or not the region is open for new apps", "type": "boolean"}, "flag": {"title": "The flag of this region", "type": "string"}, "label": {"title": "A human-readable name of the region", "type": "string"}, "reason": {"title": "Reason that this region is not available", "type": "string"}, "slug": {"title": "The slug form of the region name", "type": "string"}}, "title": "Geographical information about an app origin", "type": "object"}, "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"]}, "tier_slug": {"title": "The current pricing tier slug of the app", "type": "string"}, "updated_at": {"format": "date-time", "title": "Time of the app's last configuration update", "type": "string"}, "pinned_deployment": {"allOf": [{"description": "The deployment that the app is pinned to."}, {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}]}}, "required": ["spec"], "type": "object"}}, "type": "object"}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1fddffa5-b554-4f19-be7e-1be6fe806826/2/0
Digital Ocean
Digital Ocean Public API
null
apps_update
Update an existing app by submitting a new app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
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/1fddffa5-b554-4f19-be7e-1be6fe806826/3/0
Digital Ocean
Digital Ocean Public API
null
apps_update
Update an existing app by submitting a new app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
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/1fddffa5-b554-4f19-be7e-1be6fe806826/4/0
Digital Ocean
Digital Ocean Public API
null
apps_update
Update an existing app by submitting a new app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
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/32c11b79-143f-4f2f-bbbc-d255fa38ee31/0/0
Digital Ocean
Digital Ocean Public API
null
apps_get_deployment
Retrieve information about an app deployment.
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/32c11b79-143f-4f2f-bbbc-d255fa38ee31/1/0
Digital Ocean
Digital Ocean Public API
null
apps_get_deployment
Retrieve information about an app deployment.
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/32c11b79-143f-4f2f-bbbc-d255fa38ee31/2/0
Digital Ocean
Digital Ocean Public API
null
apps_get_deployment
Retrieve information about an app deployment.
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/32c11b79-143f-4f2f-bbbc-d255fa38ee31/3/0
Digital Ocean
Digital Ocean Public API
null
apps_get_deployment
Retrieve information about an app deployment.
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/32c11b79-143f-4f2f-bbbc-d255fa38ee31/4/0
Digital Ocean
Digital Ocean Public API
null
apps_get_deployment
Retrieve information about an app deployment.
200
null
{"deployment": {"id": "b6bdf840-2854-4f87-a36c-5f231c617c84", "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": 2, "routes": [{"path": "/"}]}], "region": "ams"}, "services": [{"name": "web", "source_commit_hash": "9a4df0b8e161e323bc3cdf1dc71878080fe144fa"}], "phase_last_updated_at": "0001-01-01T00:00:00Z", "created_at": "2020-07-28T18:00:00Z", "updated_at": "2020-07-28T18:00:00Z", "cause": "commit 9a4df0b pushed to github/digitalocean/sample-golang", "progress": {"pending_steps": 6, "total_steps": 6, "steps": [{"name": "build", "status": "PENDING", "steps": [{"name": "initialize", "status": "PENDING"}, {"name": "components", "status": "PENDING", "steps": [{"name": "web", "status": "PENDING", "component_name": "web", "message_base": "Building service"}]}]}, {"name": "deploy", "status": "PENDING", "steps": [{"name": "initialize", "status": "PENDING"}, {"name": "components", "status": "PENDING", "steps": [{"name": "web", "status": "PENDING", "steps": [{"name": "deploy", "status": "PENDING", "component_name": "web", "message_base": "Deploying service"}, {"name": "wait", "status": "PENDING", "component_name": "web", "message_base": "Waiting for service"}], "component_name": "web"}]}, {"name": "finalize", "status": "PENDING"}]}]}, "phase": "PENDING_BUILD", "tier_slug": "basic"}}
{"properties": {"deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}}, "type": "object"}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/11b0aef1-915d-4d95-9615-fabde398f369/0/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_active_deployment
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment 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/11b0aef1-915d-4d95-9615-fabde398f369/1/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_active_deployment
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment 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/11b0aef1-915d-4d95-9615-fabde398f369/2/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_active_deployment
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment 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/11b0aef1-915d-4d95-9615-fabde398f369/3/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_active_deployment
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id.
200
null
{"live_url": "https://logs-example/build.log", "url": "https://logs/build.log", "historic_logs": ["https://logs-example/archive/build.log"]}
{"properties": {"historic_urls": {"items": {"type": "string"}, "title": "A list of URLs to archived log files", "type": "array"}, "live_url": {"description": "A URL of the real-time live logs. This URL may use either the `https://` or `wss://` protocols and will keep pushing live logs as they become available.", "type": "string"}}, "type": "object"}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/11b0aef1-915d-4d95-9615-fabde398f369/4/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_active_deployment
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment 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/ab9f0092-e99e-4646-a366-47bb5be075b3/0/0
Digital Ocean
Digital Ocean Public API
null
apps_get_instanceSize
Retrieve information about a specific instance size for service, worker, and job components.
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/ab9f0092-e99e-4646-a366-47bb5be075b3/1/0
Digital Ocean
Digital Ocean Public API
null
apps_get_instanceSize
Retrieve information about a specific instance size for service, worker, and job components.
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/ab9f0092-e99e-4646-a366-47bb5be075b3/2/0
Digital Ocean
Digital Ocean Public API
null
apps_get_instanceSize
Retrieve information about a specific instance size for service, worker, and job components.
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/ab9f0092-e99e-4646-a366-47bb5be075b3/3/0
Digital Ocean
Digital Ocean Public API
null
apps_get_instanceSize
Retrieve information about a specific instance size for service, worker, and job components.
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/ab9f0092-e99e-4646-a366-47bb5be075b3/4/0
Digital Ocean
Digital Ocean Public API
null
apps_get_instanceSize
Retrieve information about a specific instance size for service, worker, and job components.
200
null
{"instance_size": {"name": "Basic XXS", "slug": "basic-xxs", "cpu_type": "SHARED", "cpus": "1", "memory_bytes": "536870912", "usd_per_month": "5.00", "usd_per_second": "0.000002066799", "tier_slug": "basic", "tier_upgrade_to": "professional-xs"}}
{"properties": {"instance_size": {"properties": {"cpu_type": {"default": "UNSPECIFIED", "enum": ["UNSPECIFIED", "SHARED", "DEDICATED"], "title": "- SHARED: Shared vCPU cores\n - DEDICATED: Dedicated vCPU cores", "type": "string"}, "cpus": {"format": "int64", "title": "The number of allotted vCPU cores", "type": "string", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memory_bytes": {"format": "int64", "title": "The allotted memory in bytes", "type": "string", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "name": {"title": "A human-readable name of the instance size", "type": "string"}, "slug": {"title": "The slug of the instance size", "type": "string"}, "tier_downgrade_to": {"title": "The slug of the corresponding downgradable instance size on the lower tier", "type": "string"}, "tier_slug": {"title": "The slug of the tier to which this instance size belongs", "type": "string"}, "tier_upgrade_to": {"title": "The slug of the corresponding upgradable instance size on the higher tier", "type": "string"}, "usd_per_month": {"title": "The cost of this instance size in USD per month", "type": "string"}, "usd_per_second": {"title": "The cost of this instance size in USD per second", "type": "string"}}, "type": "object"}}, "type": "object"}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/06810b04-9eba-45c6-b1dc-3ad01d03ea5d/0/0
Digital Ocean
Digital Ocean Public API
null
apps_create
Create a new app by submitting an app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
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/06810b04-9eba-45c6-b1dc-3ad01d03ea5d/1/0
Digital Ocean
Digital Ocean Public API
null
apps_create
Create a new app by submitting an app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
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/06810b04-9eba-45c6-b1dc-3ad01d03ea5d/2/0
Digital Ocean
Digital Ocean Public API
null
apps_create
Create a new app by submitting an app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
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/06810b04-9eba-45c6-b1dc-3ad01d03ea5d/3/0
Digital Ocean
Digital Ocean Public API
null
apps_create
Create a new app by submitting an app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
200
null
{"app": {"id": "c2a93513-8d9b-4223-9d61-5e7272c81cf5", "owner_uuid": "a4e16f25-cdd1-4483-b246-d77f283c9209", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "ChiefMateStarbuck/sample-golang", "branch": "main"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "ams", "domains": [{"domain": "sample-golang.example.com", "zone": "example.com", "minimum_tls_version": "1.3"}]}, "default_ingress": "https://sample-golang-zyhgn.ondigitalocean.app", "created_at": "2021-02-10T16:45:14Z", "updated_at": "2021-02-10T17:06:56Z", "active_deployment": {"id": "991dfa59-6a23-459f-86d6-67dfa2c6f1e3", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "ChiefMateStarbuck/sample-golang", "branch": "main"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "ams", "domains": [{"domain": "sample-golang.example.com", "zone": "example.com", "minimum_tls_version": "1.3"}]}, "services": [{"name": "web", "source_commit_hash": "db6936cb46047c576962962eed81ad52c21f35d7"}], "phase_last_updated_at": "2021-02-10T17:06:53Z", "created_at": "2021-02-10T17:05:30Z", "updated_at": "2021-02-10T17:06:53Z", "cause": "manual", "progress": {"success_steps": 6, "total_steps": 6, "steps": [{"name": "build", "status": "SUCCESS", "steps": [{"name": "initialize", "status": "SUCCESS", "started_at": "2021-02-10T17:05:35.572347485Z", "ended_at": "2021-02-10T17:05:36.093995229Z"}, {"name": "components", "status": "SUCCESS", "steps": [{"name": "web", "status": "SUCCESS", "component_name": "web", "message_base": "Building service"}], "started_at": "2021-02-10T17:05:36.094015928Z", "ended_at": "2021-02-10T17:06:19.461737040Z"}], "started_at": "2021-02-10T17:05:35.572287990Z", "ended_at": "2021-02-10T17:06:19.807834070Z"}, {"name": "deploy", "status": "SUCCESS", "steps": [{"name": "initialize", "status": "SUCCESS", "started_at": "2021-02-10T17:06:25.143957508Z", "ended_at": "2021-02-10T17:06:26.120343872Z"}, {"name": "components", "status": "SUCCESS", "steps": [{"name": "web", "status": "SUCCESS", "steps": [{"name": "deploy", "status": "SUCCESS", "component_name": "web", "message_base": "Deploying service"}, {"name": "wait", "status": "SUCCESS", "component_name": "web", "message_base": "Waiting for service"}], "component_name": "web"}], "started_at": "2021-02-10T17:06:26.120385561Z", "ended_at": "2021-02-10T17:06:50.029695913Z"}, {"name": "finalize", "status": "SUCCESS", "started_at": "2021-02-10T17:06:50.348459495Z", "ended_at": "2021-02-10T17:06:53.404065961Z"}], "started_at": "2021-02-10T17:06:25.143932418Z", "ended_at": "2021-02-10T17:06:53.404104185Z"}]}, "phase": "ACTIVE", "tier_slug": "basic"}, "last_deployment_created_at": "2021-02-10T17:05:30Z", "live_url": "https://sample-golang-zyhgn.ondigitalocean.app", "pending_deployment": {"id": "3aa4d20e-5527-4c00-b496-601fbd22520a", "spec": {"name": "sample-php", "services": [{"name": "sample-php", "git": {"repo_clone_url": "https://github.com/digitalocean/sample-php.git", "branch": "main"}, "run_command": "heroku-php-apache2", "environment_slug": "php", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "fra", "domains": [{"domain": "sample-php.example.com", "type": "PRIMARY", "zone": "example.com", "minimum_tls_version": "1.3"}]}}, "region": {"slug": "ams", "label": "Amsterdam", "flag": "netherlands", "continent": "Europe", "data_centers": ["ams3"]}, "tier_slug": "basic", "live_url_base": "https://sample-golang-zyhgn.ondigitalocean.app", "live_domain": "sample-golang-zyhgn.ondigitalocean.app", "project_id": "88b72d1a-b78a-4d9f-9090-b53c4399073f", "domains": [{"id": "e206c64e-a1a3-11ed-9e6e-9b7b6dc9a52b", "phase": "CONFIGURING", "spec": {"domain": "sample-golang.example.com", "type": "PRIMARY", "zone": "example.com", "minimum_tls_version": "1.3"}, "rotate_validation_records": false, "certificate_expires_at": "2024-01-29T23:59:59Z", "progress": {"steps": [{"ended_at": "0001-01-01T00:00:00Z", "name": "default-ingress-ready", "started_at": "2023-01-30T22:15:45.021896292Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-zone", "started_at": "2023-01-30T22:15:45.022017004Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:42:28.50752065Z", "name": "ensure-ns-records", "started_at": "2023-01-30T22:15:45.025567874Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "verify-nameservers", "started_at": "2023-01-30T22:15:45.033591906Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-record", "started_at": "2023-01-30T22:15:45.156750604Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.258626422Z", "name": "ensure-alias-record", "started_at": "2023-01-30T22:15:45.165933869Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.258808279Z", "name": "ensure-wildcard-record", "started_at": "2023-01-30T22:15:45.166093422Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "verify-cname", "started_at": "2023-01-30T22:15:45.166205559Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.475903785Z", "name": "ensure-ssl-txt-record-saved", "started_at": "2023-01-30T22:15:45.295237186Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.476017236Z", "name": "ensure-ssl-txt-record", "started_at": "2023-01-30T22:15:45.295315291Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.476094058Z", "name": "ensure-renewal-email", "started_at": "2023-01-30T22:15:45.295374087Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-CA-authorization", "started_at": "2023-01-30T22:15:45.295428101Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-certificate", "started_at": "2023-01-30T22:15:45.978756406Z", "status": "RUNNING"}, {"ended_at": "0001-01-01T00:00:00", "name": "create-deployment", "started_at": "0001-01-01T00:00:00Z", "status": "PENDING"}, {"ended_at": "0001-01-01T00:00:00", "name": "configuration-alert", "started_at": "0001-01-01T00:00:00", "status": "PENDING"}]}}]}}
{"properties": {"app": {"description": "An application's configuration and status.", "properties": {"active_deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}, "created_at": {"format": "date-time", "title": "The creation time of the app", "type": "string"}, "default_ingress": {"title": "The default hostname on which the app is accessible", "type": "string"}, "domains": {"items": {"properties": {"id": {"title": "The ID of the domain", "type": "string"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING", "CONFIGURING", "ACTIVE", "ERROR"], "type": "string"}, "progress": {"properties": {"steps": {"description": "**Omitted**"}}, "type": "object"}, "spec": {"type": "object", "properties": {"domain": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "wildcard": {"description": "**Omitted**"}, "zone": {"description": "**Omitted**"}, "minimum_tls_version": {"description": "**Omitted**"}}, "required": ["domain"]}, "validations": {"title": "List of TXT validation records", "type": "array", "items": {"description": "**Omitted**"}}, "rotate_validation_records": {"title": "Validation values have changed and require manual intervention", "type": "boolean"}, "certificate_expires_at": {"title": "Current SSL certificate expiration time", "type": "string", "format": "date-time"}}, "type": "object"}, "title": "Contains all domains for the app", "type": "array"}, "id": {"title": "The ID of the application", "type": "string"}, "in_progress_deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}, "last_deployment_created_at": {"format": "date-time", "title": "The creation time of the last deployment", "type": "string"}, "live_domain": {"title": "The live domain of the app", "type": "string"}, "live_url": {"title": "The live URL of the app", "type": "string"}, "live_url_base": {"title": "The live URL base of the app, the URL excluding the path", "type": "string"}, "owner_uuid": {"title": "The ID of the account to which the application belongs", "type": "string"}, "pending_deployment": {"allOf": [{"description": "The most recent pending deployment. For CreateApp and UpdateApp transactions this is guaranteed to reflect the associated deployment."}, {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}]}, "project_id": {"type": "string", "title": "The ID of the project the app is assigned to. This will be empty if there is a lookup failure."}, "region": {"properties": {"continent": {"title": "The continent that this region is in", "type": "string"}, "data_centers": {"items": {"type": "string"}, "title": "Data centers that are in this region", "type": "array"}, "default": {"description": "Whether or not the region is presented as the default.", "type": "boolean"}, "disabled": {"title": "Whether or not the region is open for new apps", "type": "boolean"}, "flag": {"title": "The flag of this region", "type": "string"}, "label": {"title": "A human-readable name of the region", "type": "string"}, "reason": {"title": "Reason that this region is not available", "type": "string"}, "slug": {"title": "The slug form of the region name", "type": "string"}}, "title": "Geographical information about an app origin", "type": "object"}, "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"]}, "tier_slug": {"title": "The current pricing tier slug of the app", "type": "string"}, "updated_at": {"format": "date-time", "title": "Time of the app's last configuration update", "type": "string"}, "pinned_deployment": {"allOf": [{"description": "The deployment that the app is pinned to."}, {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}]}}, "required": ["spec"], "type": "object"}}, "type": "object"}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/03c44641-1a09-445e-a7db-d03ee8908305/0/0
Digital Ocean
Digital Ocean Public API
null
apps_delete
Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time.
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/03c44641-1a09-445e-a7db-d03ee8908305/1/0
Digital Ocean
Digital Ocean Public API
null
apps_delete
Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time.
200
null
{"id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"}
{"properties": {"id": {"title": "The ID of the app that was deleted", "type": "string"}}, "type": "object"}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/03c44641-1a09-445e-a7db-d03ee8908305/2/0
Digital Ocean
Digital Ocean Public API
null
apps_delete
Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time.
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/03c44641-1a09-445e-a7db-d03ee8908305/3/0
Digital Ocean
Digital Ocean Public API
null
apps_delete
Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time.
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/03c44641-1a09-445e-a7db-d03ee8908305/4/0
Digital Ocean
Digital Ocean Public API
null
apps_delete
Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time.
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/e5161f97-0e6d-4b33-b62a-eb0ed1418d63/0/0
Digital Ocean
Digital Ocean Public API
null
apps_list
List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each 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/e5161f97-0e6d-4b33-b62a-eb0ed1418d63/1/0
Digital Ocean
Digital Ocean Public API
null
apps_list
List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each 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/e5161f97-0e6d-4b33-b62a-eb0ed1418d63/2/0
Digital Ocean
Digital Ocean Public API
null
apps_list
List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each 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/e5161f97-0e6d-4b33-b62a-eb0ed1418d63/3/0
Digital Ocean
Digital Ocean Public API
null
apps_list
List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app.
200
null
{"apps": [{"id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf", "owner_uuid": "ff36cbc6fd350fe12577f5123133bb5ba01a2419", "spec": {"name": "sample-php", "services": [{"name": "sample-php", "git": {"repo_clone_url": "https://github.com/digitalocean/sample-php.git", "branch": "main"}, "run_command": "heroku-php-apache2", "environment_slug": "php", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "domains": [{"domain": "sample-php.example.com", "type": "PRIMARY", "zone": "example.com", "minimum_tls_version": "1.3"}]}, "default_ingress": "https://sample-php-iaj87.ondigitalocean.app", "created_at": "2020-11-19T20:27:18Z", "updated_at": "2020-12-01T00:42:16Z", "active_deployment": {"id": "3aa4d20e-5527-4c00-b496-601fbd22520a", "spec": {"name": "sample-php", "services": [{"name": "sample-php", "git": {"repo_clone_url": "https://github.com/digitalocean/sample-php.git", "branch": "main"}, "run_command": "heroku-php-apache2", "environment_slug": "php", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "fra", "domains": [{"domain": "sample-php.example.com", "type": "PRIMARY", "zone": "example.com", "minimum_tls_version": "1.3"}]}, "services": [{"name": "sample-php", "source_commit_hash": "54d4a727f457231062439895000d45437c7bb405"}], "phase_last_updated_at": "2020-12-01T00:42:12Z", "created_at": "2020-12-01T00:40:05Z", "updated_at": "2020-12-01T00:42:12Z"}, "cause": "app spec updated", "pending_deployment": {"id": "3aa4d20e-5527-4c00-b496-601fbd22520a", "spec": {"name": "sample-php", "services": [{"name": "sample-php", "git": {"repo_clone_url": "https://github.com/digitalocean/sample-php.git", "branch": "main"}, "run_command": "heroku-php-apache2", "environment_slug": "php", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "fra", "domains": [{"domain": "sample-php.example.com", "type": "PRIMARY", "zone": "example.com", "minimum_tls_version": "1.3"}]}, "services": [{"name": "sample-php", "source_commit_hash": "54d4a727f457231062439895000d45437c7bb405"}], "phase_last_updated_at": "2020-12-01T00:42:12Z", "created_at": "2020-12-01T00:40:05Z", "updated_at": "2020-12-01T00:42:12Z"}, "progress": {"success_steps": 6, "total_steps": 6, "steps": [{"name": "build", "status": "SUCCESS", "steps": [{"name": "initialize", "status": "SUCCESS", "started_at": "2020-12-01T00:40:11.979305214Z", "ended_at": "2020-12-01T00:40:12.470972033Z"}, {"name": "components", "status": "SUCCESS", "steps": [{"name": "sample-php", "status": "SUCCESS", "started_at": "0001-01-01T00:00:00Z", "ended_at": "0001-01-01T00:00:00Z", "component_name": "sample-php", "message_base": "Building service"}], "started_at": "2020-12-01T00:40:12.470996857Z", "ended_at": "2020-12-01T00:41:26.180360487Z"}], "started_at": "2020-12-01T00:40:11.979257919Z", "ended_at": "2020-12-01T00:41:26.653989756Z"}], "phase": "ACTIVE", "tier_slug": "basic"}, "last_deployment_created_at": "2020-12-01T00:40:05Z", "live_url": "https://sample-php.example.com", "region": {"slug": "fra", "label": "Frankfurt", "flag": "germany", "continent": "Europe", "data_centers": ["fra1"]}, "tier_slug": "basic", "live_url_base": "https://sample-php.example.com", "live_domain": "sample-php.example.com", "domains": [{"id": "0831f444-a1a7-11ed-828c-ef59494480b5", "phase": "ACTIVE", "spec": {"domain": "sample-php.example.com", "type": "PRIMARY", "zone": "example.com", "minimum_tls_version": "1.3"}, "rotate_validation_records": false, "certificate_expires_at": "2024-01-29T23:59:59Z", "progress": {"steps": [{"ended_at": "0001-01-01T00:00:00Z", "name": "default-ingress-ready", "started_at": "2023-01-30T22:15:45.021896292Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-zone", "started_at": "2023-01-30T22:15:45.022017004Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:42:28.50752065Z", "name": "ensure-ns-records", "started_at": "2023-01-30T22:15:45.025567874Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "verify-nameservers", "started_at": "2023-01-30T22:15:45.033591906Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-record", "started_at": "2023-01-30T22:15:45.156750604Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.258626422Z", "name": "ensure-alias-record", "started_at": "2023-01-30T22:15:45.165933869Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.258808279Z", "name": "ensure-wildcard-record", "started_at": "2023-01-30T22:15:45.166093422Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "verify-cname", "started_at": "2023-01-30T22:15:45.166205559Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.475903785Z", "name": "ensure-ssl-txt-record-saved", "started_at": "2023-01-30T22:15:45.295237186Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.476017236Z", "name": "ensure-ssl-txt-record", "started_at": "2023-01-30T22:15:45.295315291Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.476094058Z", "name": "ensure-renewal-email", "started_at": "2023-01-30T22:15:45.295374087Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-CA-authorization", "started_at": "2023-01-30T22:15:45.295428101Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-certificate", "started_at": "2023-01-30T22:15:45.978756406Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:52.570612857Z", "name": "create-deployment", "started_at": "0001-01-01T00:00:00Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:31.333582377Z", "name": "configuration-alert", "started_at": "2023-01-30T22:15:46.278987808Z", "status": "SUCCESS"}]}}]}], "links": {"pages": {}}, "meta": {"total": 1}}
{"allOf": [{"type": "object", "properties": {"apps": {"title": "A list of apps", "type": "array", "items": {"description": "An application's configuration and status.", "properties": {"active_deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}, "created_at": {"format": "date-time", "title": "The creation time of the app", "type": "string"}, "default_ingress": {"title": "The default hostname on which the app is accessible", "type": "string"}, "domains": {"items": {"properties": {"id": {"title": "The ID of the domain", "type": "string"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING", "CONFIGURING", "ACTIVE", "ERROR"], "type": "string"}, "progress": {"properties": {"steps": {"description": "**Omitted**"}}, "type": "object"}, "spec": {"type": "object", "properties": {"domain": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "wildcard": {"description": "**Omitted**"}, "zone": {"description": "**Omitted**"}, "minimum_tls_version": {"description": "**Omitted**"}}, "required": ["domain"]}, "validations": {"title": "List of TXT validation records", "type": "array", "items": {"description": "**Omitted**"}}, "rotate_validation_records": {"title": "Validation values have changed and require manual intervention", "type": "boolean"}, "certificate_expires_at": {"title": "Current SSL certificate expiration time", "type": "string", "format": "date-time"}}, "type": "object"}, "title": "Contains all domains for the app", "type": "array"}, "id": {"title": "The ID of the application", "type": "string"}, "in_progress_deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}, "last_deployment_created_at": {"format": "date-time", "title": "The creation time of the last deployment", "type": "string"}, "live_domain": {"title": "The live domain of the app", "type": "string"}, "live_url": {"title": "The live URL of the app", "type": "string"}, "live_url_base": {"title": "The live URL base of the app, the URL excluding the path", "type": "string"}, "owner_uuid": {"title": "The ID of the account to which the application belongs", "type": "string"}, "pending_deployment": {"allOf": [{"description": "The most recent pending deployment. For CreateApp and UpdateApp transactions this is guaranteed to reflect the associated deployment."}, {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}]}, "project_id": {"type": "string", "title": "The ID of the project the app is assigned to. This will be empty if there is a lookup failure."}, "region": {"properties": {"continent": {"title": "The continent that this region is in", "type": "string"}, "data_centers": {"items": {"type": "string"}, "title": "Data centers that are in this region", "type": "array"}, "default": {"description": "Whether or not the region is presented as the default.", "type": "boolean"}, "disabled": {"title": "Whether or not the region is open for new apps", "type": "boolean"}, "flag": {"title": "The flag of this region", "type": "string"}, "label": {"title": "A human-readable name of the region", "type": "string"}, "reason": {"title": "Reason that this region is not available", "type": "string"}, "slug": {"title": "The slug form of the region name", "type": "string"}}, "title": "Geographical information about an app origin", "type": "object"}, "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"]}, "tier_slug": {"title": "The current pricing tier slug of the app", "type": "string"}, "updated_at": {"format": "date-time", "title": "Time of the app's last configuration update", "type": "string"}, "pinned_deployment": {"allOf": [{"description": "The deployment that the app is pinned to."}, {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "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"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}]}}, "required": ["spec"], "type": "object"}}}}, {"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/72022263-ecd6-4538-a675-32545d260e84/0/0
Digital Ocean
Digital Ocean Public API
null
sizes_list
To list all of available Droplet sizes, send a GET request to /v2/sizes. The response will be a JSON object with a key called sizes. The value of this will be an array of size objects each of which contain the standard size 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/72022263-ecd6-4538-a675-32545d260e84/1/0
Digital Ocean
Digital Ocean Public API
null
sizes_list
To list all of available Droplet sizes, send a GET request to /v2/sizes. The response will be a JSON object with a key called sizes. The value of this will be an array of size objects each of which contain the standard size attributes.
200
null
{"sizes": [{"slug": "s-1vcpu-1gb", "memory": 1024, "vcpus": 1, "disk": 25, "transfer": 1, "price_monthly": 5, "price_hourly": 0.00743999984115362, "regions": ["ams2", "ams3", "blr1", "fra1", "lon1", "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "sgp1", "tor1"], "available": true, "description": "Basic"}], "links": {"pages": {"last": "https://api.digitalocean.com/v2/sizes?page=64&per_page=1", "next": "https://api.digitalocean.com/v2/sizes?page=2&per_page=1"}}, "meta": {"total": 64}}
{"allOf": [{"type": "object", "properties": {"sizes": {"type": "array", "items": {"type": "object", "properties": {"slug": {"description": "**Omitted**"}, "memory": {"description": "**Omitted**"}, "vcpus": {"description": "**Omitted**"}, "disk": {"description": "**Omitted**"}, "transfer": {"description": "**Omitted**"}, "price_monthly": {"description": "**Omitted**"}, "price_hourly": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}}, "required": ["available", "disk", "memory", "price_hourly", "price_monthly", "regions", "slug", "transfer", "vcpus", "description"]}}}, "required": ["sizes"]}, {"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/72022263-ecd6-4538-a675-32545d260e84/2/0
Digital Ocean
Digital Ocean Public API
null
sizes_list
To list all of available Droplet sizes, send a GET request to /v2/sizes. The response will be a JSON object with a key called sizes. The value of this will be an array of size objects each of which contain the standard size 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"]}