Sign in

v1

latestOpenAPI 3.0.32026-07-22238629559.2 KB
ProjectsService

List Projects

List all projects based on provided filters.

post/api/v2/deployments/{deploymentId}/projects/list

Path parameters

deploymentIdstring required

Your deployment ID.

Request body

pageSizeinteger

Maximum number of projects to return in a single page.

pageTokenstring

Opaque cursor used for pagination. If not provided the first page will be returned.

Example request

{
  "pageSize": 100,
  "filter": {
    "names": [
      "foo/bar",
      "baz/qux"
    ],
    "statuses": [
      "PROJECT_STATUS_ARCHIVED",
      "PROJECT_STATUS_UNINITIALIZED"
    ]
  }
}

Response

OK

pageTokenstring

An opaque cursor used to paginate through the results.

Example response

{
  "projects": [
    {
      "id": 555,
      "name": "foo/bar",
      "createTime": "2021-01-01T01:23:00.000Z",
      "tags": [
        "backend",
        "python"
      ],
      "latestScanId": 4356445,
      "url": "https://github.com/foo/bar"
    }
  ],
  "pageToken": "abc123"
}