Reference > PyDo > Library Reference > projects > list()

Was this page helpful?

Give Feedback

pydo.projects.list()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To list all your projects, send a GET request to /v2/projects.

Parameters

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

Request Sample

import os
from pydo import Client

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

resp = client.projects.list()

Responses

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

200
401
429
500
default

The response will be a JSON object with a key called projects. The value of this will be an object with the standard project attributes

Click to expand an example response.

{
  "projects": [
    {
      "id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679",
      "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7",
      "owner_id": 258992,
      "name": "my-web-api",
      "description": "My website API",
      "purpose": "Service or API",
      "environment": "Production",
      "is_default": false,
      "created_at": "2018-09-27T20:10:35Z",
      "updated_at": "2018-09-27T20:10:35Z"
    },
    {
      "id": "addb4547-6bab-419a-8542-76263a033cf6",
      "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7",
      "owner_id": 258992,
      "name": "Default",
      "description": "Default project",
      "purpose": "Just trying out DigitalOcean",
      "environment": "Development",
      "is_default": true,
      "created_at": "2017-10-19T21:44:20Z",
      "updated_at": "2019-11-05T18:50:03Z"
    }
  ],
  "links": {
    "pages": {
      "first": "https://api.digitalocean.com/v2/projects?page=1",
      "last": "https://api.digitalocean.com/v2/projects?page=1"
    }
  },
  "meta": {
    "total": 2
  }
}

Unauthorized

Click to expand an example response.

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

API Rate limit exceeded

Click to expand an example response.

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response.

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response.

{
  "id": "example_error",
  "message": "some error message"
}