git-lab-preflight

List one page of the projects in a GitLab group and its subgroups that a PAT can read

Changed on
post/workspaces/gitlab/projects

Request

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

Query parameters

pageinteger
searchstring

Request body

groupFullPathstring

GitLab group full path, used to validate the token against the group when /api/v4/user refuses it

personalAccessTokenstring required

GitLab Personal Access Token to validate

serverUrlstring

The default GitLab instance this server reads from, which is also used when omitted; any other instance is refused.

Example request

{
  "groupFullPath": "my-org/my-team",
  "personalAccessToken": "your-gitlab-token",
  "serverUrl": "https://gitlab.example.com"
}

Response

One page of projects; nextPage is absent on the last page

nextPageinteger

The page that follows this one; absent on the last page

Example response

{
  "projects": [
    {
      "fullPath": "my-org/my-team/my-project"
    }
  ]
}

Changes