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 88 · Answer 1 · answered Aug 04 '17 at 07:05

88

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

23,193
31
166
308

Great answer. Despite not guaranteed to work since does not use any API, it is quite possible this approach will remain working indefinitely – Leonardo Maffei Nov 29 '21 at 20:04
Thanks, I didn't see it right away but was able to print it to the console with a little js: `document.getElementById('project_id').value` – justFatLard Oct 04 '22 at 17:03

score 83 · Answer 2 · answered Nov 02 '18 at 21:34

83

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

Kurt

1,169
1
9
16

2

Worth noting, you can click to copy the ID to your clipboard – Zachary Yates Dec 21 '21 at 16:37

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

50

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,362
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
Goto `Settings > General` – Jan Nov 20 '21 at 17:02

score 44 · Accepted Answer · edited Sep 30 '22 at 15:18

44

You can query for your owned projects:

curl -XGET --header "PRIVATE-TOKEN: XXXX" "https://gitlab.com/api/v4/projects?owned=true"

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 Sep 30 '22 at 15:18

VonC

1,262,500
529
4,410
5,250

answered Sep 19 '16 at 11:39

Fairy

3,592
2
27
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
3

@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
12

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 34 · Answer 5 · edited Oct 28 '22 at 18:31

34

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-foss directly when you want to interact with a project.

edited Oct 28 '22 at 18:31

Alex Gittemeier

5,224
30
55

answered Aug 22 '17 at 10:52

Martin Nowak

1,282
13
8

8

+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
2

This example is 404 for me. – agapanthusblue Aug 03 '22 at 21:47
It works for me. Thank you so much – Hay Trần Jul 29 '23 at 04:48

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

25

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,476
17
14

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

13

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

11,217
6
43
49

answered Oct 31 '18 at 04:04

qtopierw

1,447
14
23

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
And the one based on jq: `curl -s -XGET -H "Content-Type: application/json" --header "PRIVATE-TOKEN: $GITLAB_TOKEN" http:///api/v3/projects/%2F | jq '.id` – Steve Baroti Jul 14 '21 at 20:23
Thanks! works also with API v4 – Alek Oct 25 '22 at 21:21

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

9

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

154
1
5

score 7 · Answer 9 · answered Feb 07 '22 at 10:59

7

You can view it under the repository name

answered Feb 07 '22 at 10:59

quoc9x

1,423
2
9
26

score 5 · Answer 10 · 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

score 4 · Answer 11 · 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

2,274
2
25
41

score 4 · Answer 12 · 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 13 · 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.

definitely better answer! – Marcello DeSales Aug 05 '21 at 16:57 — Marcello DeSales, Aug 05 '21 at 16:57

score 1 · Answer 14 · 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

Chuan · Answer 15 · 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 16 · 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

3,042
28
53

Divek John · Answer 17 · 2022-01-28T15:38:00.613

0

Not Specific to question, but somehow reached here, might help others I used chrome to get a project ID

Go to the desired project example gitlab.com/username/project1
Inspect network tab
see the first garphql request in network tab

edited Jan 28 '22 at 15:38

answered Jan 28 '22 at 15:31

Divek John

623
8
16

score 0 · Answer 18 · answered Feb 07 '22 at 19:17

You can search for the project path

curl -s  'https://gitlab.com/api/v4/projects?search=my/path/to/my/project&search_namespaces=true' --header "PRIVATE-TOKEN: $GITLAB_TOKEN" |python -mjson.tool |grep \"id\"

https://docs.gitlab.com/ee/api/projects.html

Which will only match your project and will not find other unnecessary projects

score 0 · Answer 19 · answered Aug 12 '22 at 13:23

0

My favorite method is to pull from the CI/CD pipeline so on build it dynamically assigns the project id.

Simply assign a variable in your code to = CI_PROJECT_ID

answered Aug 12 '22 at 13:23

sixfears7

66
4

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

19 Answers19

Screenshot:

Linked