v2

latestOpenAPI 3.1.02026-08-0531314.2 KB
GitLab Projects

Onboard a GitLab project

Add a GitLab project to Gitar and configure webhooks for code review. This endpoint is idempotent — calling it for an already-connected project returns success with status already_connected.

Selecting a GitLab instance. Organizations with a single connected GitLab instance can omit host. Once an organization connects more than one instance, host becomes required: without it Gitar cannot tell which instance a project id or path refers to, and the request is rejected with 409 Conflict listing the connected instances.

post/external/gitlab/projects

Request body

hoststring nullable

GitLab instance the project lives on (e.g. "https://gitlab.com").

Optional for organizations with a single connected GitLab instance, and required once there is more than one — without it the project would be looked up on an arbitrary instance. A request that omits or misnames the host on a multi-instance organization is rejected with 409 Conflict listing the connected instances.

project_idinteger nullable

GitLab project numeric ID (e.g. 12345)

project_pathstring nullable

GitLab project path (e.g. "group/subgroup/project")

Response

Project onboarded successfully or already connected

errorstring nullable
project_idinteger nullable
project_pathstring required
status'onboarded' | 'already_connected' | 'failed' required

Status of an individual project onboard operation.

successboolean required
webhook_configuredboolean required