Skip to main content

apps

Overview

Nameapps
TypeResource
Iddigitalocean.apps.apps

Fields

NameDatatypeDescription
idstring
active_deploymentobject
created_atstring
default_ingressstring
domainsarray
in_progress_deploymentobject
last_deployment_created_atstring
live_domainstring
live_urlstring
live_url_basestring
owner_uuidstring
pending_deploymentobjectThe most recent pending deployment. For CreateApp and UpdateApp transactions this is guaranteed to reflect the associated deployment.
pinned_deploymentobjectThe deployment that the app is pinned to.
project_idstring
regionobject
specobjectThe desired configuration of an application.
tier_slugstring
updated_atstring

Methods

NameAccessible byRequired ParamsDescription
getSELECTidRetrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response.
listSELECTList 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.
createINSERTdata__specCreate a new app by submitting an app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
deleteDELETEidDelete 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.
_getEXECidRetrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response.
_listEXECList 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.
updateEXECid, data__specUpdate an existing app by submitting a new app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
validate_appSpecEXECdata__specTo propose and validate a spec for a new or existing app, send a POST request to the /v2/apps/propose endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app.