Sign in
Projects

Get a list of all projects

Changed on
get/projects

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number (1-based)

per_pageinteger

Number of items per page (1-100)

searchstring

Case-insensitive project name or slug filter

Response

List of projects

pageinteger required
per_pageinteger required
totalinteger required

Example response

{
  "projects": [
    {
      "docker_socket": {
        "nodes": [
          "control-plane",
          "worker-1"
        ]
      },
      "git_provider_type": "gitlab",
      "gitlab_webhook_id": 42,
      "preset_config": {
        "buildContext": "./api",
        "dockerfilePath": "docker/Dockerfile"
      }
    }
  ]
}

Changes

  • c3b504454b19Revision changes
    • info

      added the optional property /// to the response with the status

  • 3c75d3f3795cRevision changes
    • info

      added the optional property /// to the response with the status