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
Boxiang Sun
gitlab-ce
Commits
ddc8b91a
Commit
ddc8b91a
authored
Jan 18, 2016
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Refactor namespaces API documentation [ci skip]
parent
835f1961
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
22 additions
and
7 deletions
+22
-7
doc/api/namespaces.md
doc/api/namespaces.md
+22
-7
No files found.
doc/api/namespaces.md
View file @
ddc8b91a
# Namespaces
# Namespaces
Namespaces account for usernames and groupnames.
[
Pagination
](
README.md#pagination
)
is used.
## List namespaces
## List namespaces
Get a list of namespaces. (As user: my namespaces, as admin: all namespaces)
Get a list of namespaces. As a user, your namespaces are listed whereas if you
are an administrator you get a list of all namespaces in the GitLab instance.
```
```
GET /namespaces
GET /namespaces
```
```
```
bash
curl
-H
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
https://gitlab.example.com/api/v3/namespaces
```
```
json
```
json
[
[
{
{
...
@@ -23,22 +32,28 @@ GET /namespaces
...
@@ -23,22 +32,28 @@ GET /namespaces
]
]
```
```
You can search for namespaces by name or path, see below.
## Search for namespace
## Search for namespace
Get all namespaces that match
your
string in their name or path.
Get all namespaces that match
a
string in their name or path.
```
```
GET /namespaces?search=foobar
GET /namespaces?search=foobar
```
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
|
`search`
| string | no | Returns a list of namespaces the user is authorized to see based on the search criteria |
```
bash
curl
-H
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
https://gitlab.example.com/api/v3/namespaces?search
=
twitter
```
```
json
```
json
[
[
{
{
"id"
:
1
,
"id"
:
4
,
"path"
:
"
user1
"
,
"path"
:
"
twitter
"
,
"kind"
:
"
user
"
"kind"
:
"
group
"
}
}
]
]
```
```
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