Where do I find the project ID for the GitLab API?

Question

I use GitLab on their servers. I would like to download my latest built artifacts (build via GitLab CI) via the API like this:

curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.com/api/v3/projects/1/builds/8/artifacts"

Where do I find this project ID? Or is this way of using the API not intended for hosted GitLab projects?

I created an issue: https://gitlab.com/gitlab-org/gitlab-ce/issues/28342 — User, Feb 17 '17 at 12:45

score 55 · Answer 1 · answered Aug 04 '17 at 07:05

55

I just found out an even easier way to get the project id: just see the HTML content of the gitlab page hosting your project. There is an input with a field called project_id, e.g:

<input type="hidden" name="project_id" id="project_id" value="335" />

answered Aug 04 '17 at 07:05

codependent

18,032
17
110
225

Bernát · Answer 2 · 2017-02-17T09:42:29.783

37

On the Edit Project page there is a Project ID field in the top right corner.

(You can also see the ID on the CI/CD pipelines page, in the exameple code of the Triggers section.)

In older versions, you can see it on the Triggers page, in the URLs of the example code.

edited Feb 17 '17 at 09:42

answered Dec 12 '16 at 10:46

Bernát

1,222
14
19

I cannot see this? What gitlab version? – sunew Feb 15 '17 at 11:56
1

In the version which is running on Gitlab.com... i don't know exactly, but not long ago, maybe since January 2017. In older versions you can find it in the example code on the Triggers page. – Bernát Feb 17 '17 at 09:41

score 33 · Answer 3 · answered Nov 02 '18 at 21:34

33

The latest version of GitLab 11.4 at the time of this writing now puts the Project ID at the top of the frontpage of your repository.

Screenshot:

answered Nov 02 '18 at 21:34

Rakaim

606
7
14

Fairy · Accepted Answer · 2017-02-20T16:12:53.327

32

You can query for your owned projects:

curl -XGET --header "PRIVATE-TOKEN: XXXX" "https://gitlab.com/api/v3/projects/owned"

You will receive JSON with each owned project:

[
  {
    "id":48,
    "description":"",
    "default_branch":"master",
    "tag_list":[
...

You are also able to get the project ID from the triggers configuration in your project which already has some sample code with your ID.

From the Triggers page:

curl -X POST \
     -F token=TOKEN \
     -F ref=REF_NAME \
     https://<GitLab Installation>/api/v3/projects/<ProjectID>/trigger/builds

edited Feb 20 '17 at 16:12

answered Sep 19 '16 at 11:39

Fairy

3,116
2
21
36

great thx - helps a lot. Small note: I think -header should be --header. – Hubert Ströbitzer Sep 20 '16 at 19:49
No problem. Don't forget to accept the answer if it has solved your problem. – Fairy Sep 20 '16 at 21:56
This answer is not valid anymore. See answer by @Bernát. You can see the project ID on the project settings page. – Ates Goral Feb 17 '17 at 20:51
@AtesGoral I am not seeing the project ID in the project settings page. Where is it supposed to be? – Fairy Feb 20 '17 at 16:08
@Fairy Which version of GitLab are you using? – Ates Goral Feb 20 '17 at 16:25
@AtesGoral 8.15.4 – Fairy Feb 20 '17 at 16:26
1

@Fairy Go to Settings -> CI/CD Pipelines. On the Triggers section, the URL examples contain the project ID. e.g. "https://gitlab.com/api/v3/projects/xxxxxx/trigger/builds" – Ates Goral Feb 27 '17 at 21:32
11

v3_to_v4.md, "/api/v4/projects?owned=true" – Leo Lee Feb 08 '18 at 08:30
https://docs.gitlab.com/ee/api/projects.html#list-all-projects – AXE Labs Mar 17 '20 at 18:22

score 20 · Answer 5 · answered Aug 22 '17 at 10:52

20

As mentioned here, all the project scoped APIs expect either an ID or the project path (URL encoded). So just use https://gitlab.com/api/v4/projects/gitlab-org%2Fgitlab-ce directly when you want to interact with a project.

answered Aug 22 '17 at 10:52

Martin Nowak

984
10
8

3

+1 important point is that `NAMESPACE/PROJECT_NAME` mentioned after `/api/v4/projects/` must be URL encoded. That means `/` needs to be replaced with `%2F` For example: https://gitlab.com/api/v4/projects/gitlab-org%2Fgitlab-ce – sactiw Nov 01 '17 at 21:45

score 20 · Answer 6 · answered Nov 29 '17 at 21:03

20

Enter the project.

On the Left Hand menu click Settings -> General -> Expand General Settings

It has a label Project ID and is next to the project name.

This is on version GitLab 10.2

answered Nov 29 '17 at 21:03

Martin Naughton

1,142
11
13

score 11 · Answer 7 · edited Jan 16 '19 at 12:35

11

Provide the solution that actually solve the problem the api of getting the project id for specific gitlab project

curl -XGET -H "Content-Type: application/json" --header "PRIVATE-TOKEN: $GITLAB_TOKEN" http://<YOUR-GITLAB-SERVER>/api/v3/projects/<YOUR-NAMESPACE>%2F<YOUR-PROJECT-NAME> | python -mjson.tool

Or maybe you just want the project id:

curl -XGET -H "Content-Type: application/json" --header "PRIVATE-TOKEN: $GITLAB_TOKEN" http://<YOUR-GITLAB-SERVER>/api/v3/projects/<YOUR-NAMESPACE>%2F<YOUR-PROJECT-NAME> | python -c 'import sys, json; print(json.load(sys.stdin)["id"])'

Note that the repo url(namespace/repo name) is encoded.

edited Jan 16 '19 at 12:35

Guillaume Jacquenot

9,076
5
38
47

answered Oct 31 '18 at 04:04

qtopierw

1,279
13
22

In case you are using gitlab.com the namespace would be your username. – Mike Twc Dec 18 '18 at 21:16
wouldn't the namespace be the owner of the project you are trying to get the project id for, rather than always your own username? – Milan Lakhani Mar 09 '21 at 09:35

score 5 · Answer 8 · answered Sep 21 '16 at 19:09

Just for the record, if someone else has the need to download artifacts from gitlab.com created via gitlab-ci

Create a private token within your browser
Get the project id via curl -XGET --header "PRIVATE-TOKEN: YOUR_AD_HERE?" "https://gitlab.com/api/v3/projects/owned"
Download the last artifact from your master branch created via a gitlab-ci step called release curl -XGET --header "PRIVATE-TOKEN: YOUR_AD_HERE?" -o myapp.jar "https://gitlab.com/api/v3/projects/4711/builds/artifacts/master/download?job=release"

I am very impressed about the beauty of gitlab.

v3 is no longer available. The URL is now: `https://gitlab.com/api/v4/projects/PROJECT_ID/jobs/artifacts/master/raw/PATH_TO_FILE?job=JOB` — AndrewHarvey, Feb 27 '19 at 02:40

shunya · Answer 9 · 2019-04-10T06:02:53.280

5

If you know your project name, you can get the project id by using the following API:

curl --header "Private-Token: <your_token>" -X GET https://gitlab.com/api/v4/projects?search=<exact_project_name>

This will return a JSON that includes the id:

[
  {
     "id":<project id>, ...
  }
]

edited Apr 10 '19 at 06:02

answered Apr 06 '19 at 02:40

shunya

114
1
5

score 4 · Answer 10 · answered Sep 12 '17 at 13:06

4

You can query projects with search attribute e.g:

http://gitlab.com/api/v3/projects?private_token=xxx&search=myprojectname

answered Sep 12 '17 at 13:06

MTZ4

1,985
1
21
32

score 4 · Answer 11 · answered Feb 28 '19 at 12:11

As of Gitlab API v4, the following API returns all projects that you own:

curl --header 'PRIVATE-TOKEN: <your_token>' 'https://gitlab.com/api/v4/projects?owned=true'

The response contains project id. Gitlab access tokens can be created from this page- https://gitlab.com/profile/personal_access_tokens

RodolfoAP · Answer 12 · 2020-10-22T11:32:57.367

No answer suits generic needs, the most similar is intended only for the gitlab site, not specific sites. This can be used to find the ID of the project streamer in the Gitlab server my-server.com, for example:

$ curl --silent --header 'Authorization: Bearer MY-TOKEN-XXXX' \
     'https://my-server.com/api/v4/projects?per_page=100&simple=true'| \
     jq -rc '.[]|select(.name|ascii_downcase|startswith("streamer"))'| \
     jq .id

168

Remark that

this gives only the first 100 projects, if you have more, you should request the pages that follow (&page=2, 3, ...) or run a different API (e.g. groups/:id/projects).
jq is quite flexible. Here we're just filtering a project, you can do multiple things with it.

Chuan · Answer 13 · 2019-06-27T08:58:23.437

If your project name is unique, it is handy to follow the answer by shunya, search by name, refer API doc.

If you have stronger access token and the Gitlab contains a few same name projects within different groups, then search within group is more convenient. API doc here. e.g.

curl --header "PRIVATE-TOKEN: <token>" -X GET https://gitlab.com/api/v4/groups/<group_id>/search?scope=projects&search=<project_name>

The group ID can be found from the Settings page under the group domain.

And to fetch the project id from the output, you can do:

curl --header "PRIVATE-TOKEN: <token>" -X GET https://gitlab.com/api/v4/groups/<group_id>/search?scope=projects&search=<project_name> | jq '[0].id'

Ferroao · Answer 14 · 2019-08-20T17:52:46.803

0

To get id from all projects, use:

curl --header 'PRIVATE-TOKEN: XXXXXXXXXXXXXXXXXXXXXXX' 'https://gitlab.com/api/v4/projects?owned=true' > curloutput
grep -oPz 'name\":\".*?\"|{\"id\":[0-9]+' curloutput | sed 's/{\"/\n/g' | sed 's/name//g' |sed 's/id\"://g' |sed 's/\"//g'  | sort -u -n

edited Aug 20 '19 at 17:52

answered Aug 20 '19 at 16:26

Ferroao

1,953
14
36

score 0 · Answer 15 · answered Mar 14 '21 at 21:53

There appears to be no way to retrieve only the Project ID using the gitlab api. Instead, retrieve all the owner's projects and loop through them until you find the matching project, then return the ID. I wrote a script to get the project ID:

#!/bin/bash

projectName="$1"
namespace="$2"
default=$(sudo cat .namespace)
namespace="${namespace:-$default}"
json=$(curl --header "PRIVATE-TOKEN: $(sudo cat .token)" -X GET 
'https://gitlab.com/api/v4/projects?owned=true' 2>/dev/null)
id=0
idMatch=0
pathWithNamespaceMatch=0
rowToMatch="\"$(echo "$namespace/$projectName" | tr '[:upper:]' '[:lower:]')\","
for row in $(echo "${json}" | jq -r '.'); do
    [[ $idMatch -eq 1 ]] && { idMatch=0; id=${row::-1}; }
    [[ $pathWithNamespaceMatch -eq 1 ]] && { pathWithNamespaceMatch=0; [[ "$row" == "$rowToMatch" ]] && { echo "$id"; return 0; } }
    [[ ${row} == "\"path_with_namespace\":" ]] && pathWithNamespaceMatch=1
    [[ ${row} == "\"id\":" ]] && idMatch=1
done
echo 'Error! Could not retrieve projectID.'
return 1

It expects the default namespace to be stored in a file .namespace and the private token to be stored in a file .token. For increased security, its best to run chmod 000 .token; chmod 000 .namespace; chown root .namespace; chown root .token

Where do I find the project ID for the GitLab API?

15 Answers15

Screenshot:

Linked