G-g-core
Projects

List projects

Changed on

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

get/cloud/v1/projects

Request

  • Base URL
    https://api.gcore.com
  • URL
    https://api.gcore.com/cloud/v1/projects
  • Auth
    HTTP apikey

Query parameters

include_deletedboolean

Whether to include deleted projects in the response.

limitinteger

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

Example:100
namestring

Name to filter the results by.

Example:my-project
offsetinteger

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

order_by'created_at.asc' | 'created_at.desc' | 'name.asc' | 'name.desc'

Order by field and direction.

Response

OK

countinteger required

Number of objects

Example response

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

Changes

  • a2b772345f3aRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status