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
1
Merge Requests
1
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
nexedi
gitlab-ce
Commits
a7e3fcfe
Commit
a7e3fcfe
authored
Nov 19, 2020
by
Łukasz Korbasiewicz
Committed by
Marcin Sedlak-Jakubowski
Nov 19, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Resolve "How to update appearance - upload images - via API"
parent
81ffca3a
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
34 additions
and
1 deletion
+34
-1
doc/api/appearance.md
doc/api/appearance.md
+34
-1
No files found.
doc/api/appearance.md
View file @
a7e3fcfe
...
...
@@ -54,7 +54,7 @@ PUT /application/appearance
| --------------------------------- | ------- | -------- | ----------- |
|
`title`
| string | no | Instance title on the sign in / sign up page
|
`description`
| string | no | Markdown text shown on the sign in / sign up page
|
`logo`
| mixed | no | Instance image used on the sign in / sign up page
|
`logo`
| mixed | no | Instance image used on the sign in / sign up page
. See
[
Change logo
](
#change-logo
)
|
`header_logo`
| mixed | no | Instance image used for the main navigation bar
|
`favicon`
| mixed | no | Instance favicon in
`.ico`
or
`.png`
format
|
`new_project_guidelines`
| string | no | Markdown text shown on the new project page
...
...
@@ -87,3 +87,36 @@ Example response:
"email_header_and_footer_enabled"
:
true
}
```
## Change logo
Upload a logo to your GitLab instance.
To upload an avatar from your file system, use the
`--form`
argument. This causes
cURL to post data using the header
`Content-Type: multipart/form-data`
. The
`file=`
parameter must point to an image file on your file system and be
preceded by
`@`
.
```
plaintext
PUT /application/appearance
```
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | -------------- |
|
`logo`
| string | Yes | File to upload |
Example request:
```
shell
curl
--location
--request
PUT
"https://gitlab.example.com/api/v4/application/appearance?data=image/png"
\
--header
"Content-Type: multipart/form-data"
\
--header
"PRIVATE-TOKEN: <your_access_token>"
\
--form
"logo=@/path/to/logo.png"
```
Returned object:
```
json
{
"logo"
:
"/uploads/-/system/appearance/logo/1/logo.png"
```
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