Skip to main content
GET
/
cloud
/
v1
/
projects
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)
{
  "count": 1,
  "results": [
    {
      "client_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "description": "Project description",
      "id": 123,
      "is_default": true,
      "name": "<string>",
      "state": "<string>",
      "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

​
client_id
integer<int64>

Client ID filter for administrators.

Example:

1

​
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