pydo.apps.list_deployments()

Generated on 25 November 2024 from pydo version v0.6.0

Description

List all deployments of an app.

Parameters

Name	Type	Required	Description	Default Value
`app_id`	string	True	The app ID
`page`	integer	False	Which ‘page’ of paginated results to return.	1
`per_page`	integer	False	Number of items returned per page	20

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

get_resp = client.apps.list_deployments(app_id="4f6c71e2")

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

200
401
404
429
500
default

A JSON object with a deployments key. This will be a list of all app deployments

Click to expand an example response for deployments.

{
  "value": {
    "deployments": [
      {
        "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": "apps-s-1vcpu-0.5gb",
              "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"
      }
    ],
    "links": {
      "pages": {}
    },
    "meta": {
      "total": 1
    }
  }
}

Unauthorized