Documentation | Projects › List Projects

Projects

projects

Methods

Create Project ->

ProjectSerializer

post/v1/projects

Create project

Delete Project -> { tasks }

delete/v1/projects/{project_id}

All cloud resources in all regions that belong to the project will be deleted and will not be recoverable

List Projects -> { count, results }

get/v1/projects

List projects

Parameters

client_id: number

Optional

Client ID filter for administrators.

include_deleted: boolean

Optional

Whether to include deleted entries in the response.

name: string

Optional

Name to filter the results by.

order_by: Array<

Optional

Order by field and direction. Supports multiple values.

"created_at.asc"

"created_at.desc"

"name.asc"

"name.desc"

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<

ProjectSerializer

Objects

Request example

curl https://api.gcore.com/cloud/v1/projects \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "count": 1,
  "results": [
    {
      "id": 1,
      "client_id": 1,
      "created_at": "2019-12-27T18:11:19.117Z",
      "is_default": true,
      "name": "default",
      "state": "ACTIVE",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "description": "Project description",
      "task_id": "7244e161-664c-4afd-a34e-7003eac4d949"
    }
  ]
}

Get Project ->

ProjectSerializer

get/v1/projects/{project_id}

Get Project

Update Project ->

ProjectSerializer

put/v1/projects/{project_id}

Update Project

Domain types

ProjectSerializer = { id, client_id, created_at, 6 more... }