Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kazuhiko Shiozaki
gitlab-ce
Commits
2b3e64a6
Commit
2b3e64a6
authored
Jan 24, 2016
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Clean up namespaces API documentation
[ci skip]
parent
ddc8b91a
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
14 additions
and
3 deletions
+14
-3
doc/api/namespaces.md
doc/api/namespaces.md
+14
-3
No files found.
doc/api/namespaces.md
View file @
2b3e64a6
# Namespaces
# Namespaces
Namespaces account for usernames and groupnames.
Usernames and groupnames fall under a special category called namespaces.
For users and groups supported API calls see the
[
users
](
users.md
)
and
[
groups
](
groups.md
)
documentation respectively.
[
Pagination
](
README.md#pagination
)
is used.
[
Pagination
](
README.md#pagination
)
is used.
## List namespaces
## List namespaces
Get a list of
namespaces. As a user, your namespaces are listed whereas if you
Get a list of
the namespaces of the authenticated user. If the user is an
a
re an administrator you get a list of all namespaces in the GitLab instance
.
a
dministrator, a list of all namespaces in the GitLab instance is shown
.
```
```
GET /namespaces
GET /namespaces
```
```
Example request:
```
bash
```
bash
curl
-H
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
https://gitlab.example.com/api/v3/namespaces
curl
-H
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
https://gitlab.example.com/api/v3/namespaces
```
```
Example response:
```
json
```
json
[
[
{
{
...
@@ -44,10 +51,14 @@ GET /namespaces?search=foobar
...
@@ -44,10 +51,14 @@ GET /namespaces?search=foobar
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`search`
| string | no | Returns a list of namespaces the user is authorized to see based on the search criteria |
|
`search`
| string | no | Returns a list of namespaces the user is authorized to see based on the search criteria |
Example request:
```
bash
```
bash
curl
-H
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
https://gitlab.example.com/api/v3/namespaces?search
=
twitter
curl
-H
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
https://gitlab.example.com/api/v3/namespaces?search
=
twitter
```
```
Example response:
```
json
```
json
[
[
{
{
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment