List projects

Retrieve a list of projects for a client. Results can be filtered by name and ordered by various fields.

GET /cloud/v1/projects

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cloud.projects.list()
page = page.results[0]
print(page.id)

200

{
  "count": 1,
  "results": [
    {
      "client_id": 1,
      "created_at": "2019-12-31T23:59:59",
      "deleted_at": "2020-12-31T23:59:59",
      "description": "Project description",
      "id": 1,
      "is_default": true,
      "name": "default",
      "state": "ACTIVE",
      "task_id": "7244e161-664c-4afd-a34e-7003eac4d949"
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

include_deleted · boolean · default: false

Whether to include deleted projects in the response.

Example:

false

limit · integer · default: 100

Limit value is used to limit the number of records in the result

Required range: x <= 1000

Example:

100

name · string

Name to filter the results by.

Example:

"my-project"

offset · integer · default: 0

Offset value is used to exclude the first set of records from the result

Required range: x >= 0

Example:

0

order_by · enum<string> · default: created_at.desc

Order by field and direction.

Available options: created_at.asc, created_at.desc, name.asc, name.desc

Example:

"name.desc"

Response

200 - application/json

OK

count · integer · required

Number of objects

Required range: x >= 0

Example:

1

results · ProjectSerializer · object[] · required

Objects

Show child attributes