Give Feedback

app

Generated on 13 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

Create, update, or delete App Platform applications. App Platform is a Platform-as-a-Service (PaaS) offering that allows developers to publish code directly to DigitalOcean servers without worrying about the underlying infrastructure. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Apps.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`id` str		The unique identifier of the app. Used for lookup when updating or deleting.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`name` str		The name of the app to look up. Used for lookup when updating or deleting.
`spec` dict		The app specification that describes the app. This is a dictionary containing the app’s components, services, etc.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Create an App Platform application
  digitalocean.cloud.app:
    token: "{{ token }}"
    state: present
    spec:
      name: my-app
      region: nyc
      services:
        - name: web
          github:
            repo: my-org/my-repo
            branch: main
          run_command: npm start
          http_port: 8080
          instance_count: 1
          instance_size_slug: basic-xxs

- name: Delete an App Platform application by name
  digitalocean.cloud.app:
    token: "{{ token }}"
    state: absent
    name: my-app

- name: Delete an App Platform application by ID
  digitalocean.cloud.app:
    token: "{{ token }}"
    state: absent
    id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4

Return Values

Key Returned Description

Key	Returned	Description
`app` dict	always	App Platform application information. Sample: `{ "active_deployment": { "id": "deployment-id", "phase": "ACTIVE" }, "created_at": "2020-03-13T19:20:47.442049222Z", "default_ingress": "https://my-app-xxxxx.ondigitalocean.app", "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "spec": { "name": "my-app", "region": "nyc", "services": [ { "github": { "branch": "main", "repo": "my-org/my-repo" }, "name": "web" } ] }, "updated_at": "2020-03-13T19:20:47.442049222Z" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	App result information. Sample: `[ "Created app my-app", "Updated app my-app", "Deleted app my-app", "App my-app would be created", "App my-app exists" ]`

app
dict

always

App Platform application information.
Sample:

{
  "active_deployment": {
    "id": "deployment-id",
    "phase": "ACTIVE"
  },
  "created_at": "2020-03-13T19:20:47.442049222Z",
  "default_ingress": "https://my-app-xxxxx.ondigitalocean.app",
  "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
  "spec": {
    "name": "my-app",
    "region": "nyc",
    "services": [
      {
        "github": {
          "branch": "main",
          "repo": "my-org/my-repo"
        },
        "name": "web"
      }
    ]
  },
  "updated_at": "2020-03-13T19:20:47.442049222Z"
}

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str