debian-mirror-gitlab/doc/api/project_snippets.md

275 lines
13 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
stage: Create
group: Editor
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2021-04-17 20:07:23 +05:30
# Project snippets **(FREE)**
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
## Snippet visibility level
2015-09-11 14:41:01 +05:30
Snippets in GitLab can be either private, internal or public.
2017-08-17 22:00:37 +05:30
You can set it with the `visibility` field in the snippet.
2015-09-11 14:41:01 +05:30
Constants for snippet visibility levels are:
2017-08-17 22:00:37 +05:30
| visibility | Description |
| ---------- | ----------- |
2022-05-07 20:08:51 +05:30
| `private` | The snippet is visible only to project members |
2021-01-29 00:20:46 +05:30
| `internal` | The snippet is visible for any logged in user except [external users](../user/permissions.md#external-users) |
2017-08-17 22:00:37 +05:30
| `public` | The snippet can be accessed without any authentication |
2015-09-11 14:41:01 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2019-09-30 21:07:59 +05:30
From July 2019, the `Internal` visibility setting is disabled for new projects, groups,
and snippets on GitLab.com. Existing projects, groups, and snippets using the `Internal`
visibility setting keep this setting. You can read more about the change in the
2020-06-23 00:09:42 +05:30
[relevant issue](https://gitlab.com/gitlab-org/gitlab/-/issues/12388).
2019-09-30 21:07:59 +05:30
2014-09-02 18:07:02 +05:30
## List snippets
Get a list of project snippets.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /projects/:id/snippets
```
Parameters:
2022-01-26 12:08:38 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|----------|-----------------------------------------------------------------------------------------------------------------|
| `id` | integer or string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2014-09-02 18:07:02 +05:30
## Single snippet
Get a single project snippet.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /projects/:id/snippets/:snippet_id
```
Parameters:
2022-01-26 12:08:38 +05:30
| Attribute | Type | Required | Description |
|--------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------|
| `id` | integer or string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
| `snippet_id` | integer | yes | The ID of a project's snippet |
2014-09-02 18:07:02 +05:30
```json
{
"id": 1,
"title": "test",
"file_name": "add.rb",
2017-09-10 17:25:29 +05:30
"description": "Ruby test snippet",
2014-09-02 18:07:02 +05:30
"author": {
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"state": "active",
"created_at": "2012-05-23T08:00:58Z"
},
"updated_at": "2012-06-28T10:52:04Z",
2016-09-29 09:46:39 +05:30
"created_at": "2012-06-28T10:52:04Z",
2020-05-24 23:13:21 +05:30
"project_id": 1,
"web_url": "http://example.com/example/example/snippets/1",
"raw_url": "http://example.com/example/example/snippets/1/raw"
2014-09-02 18:07:02 +05:30
}
```
## Create new snippet
Creates a new project snippet. The user must have permission to create new snippets.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
POST /projects/:id/snippets
```
Parameters:
2021-01-03 14:25:43 +05:30
| Attribute | Type | Required | Description |
|:------------------|:----------------|:---------|:----------------------------------------------------------------------------------------------------------------|
2022-01-26 12:08:38 +05:30
| `id` | integer or string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2021-01-03 14:25:43 +05:30
| `title` | string | yes | Title of a snippet |
| `file_name` | string | no | Deprecated: Use `files` instead. Name of a snippet file |
| `content` | string | no | Deprecated: Use `files` instead. Content of a snippet |
| `description` | string | no | Description of a snippet |
| `visibility` | string | no | Snippet's [visibility](#snippet-visibility-level) |
| `files` | array of hashes | no | An array of snippet files |
| `files:file_path` | string | yes | File path of the snippet file |
| `files:content` | string | yes | Content of the snippet file |
2014-09-02 18:07:02 +05:30
2019-12-04 20:38:33 +05:30
Example request:
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request POST "https://gitlab.com/api/v4/projects/:id/snippets" \
2019-12-04 20:38:33 +05:30
--header "PRIVATE-TOKEN: <your access token>" \
--header "Content-Type: application/json" \
-d @snippet.json
```
`snippet.json` used in the above example request:
```json
{
"title" : "Example Snippet Title",
"description" : "More verbose snippet description",
2021-01-03 14:25:43 +05:30
"visibility" : "private",
"files": [
{
"file_path": "example.txt",
2021-06-08 01:23:25 +05:30
"content" : "source code \n with multiple lines\n"
2021-01-03 14:25:43 +05:30
}
]
2019-12-04 20:38:33 +05:30
}
```
2014-09-02 18:07:02 +05:30
## Update snippet
Updates an existing project snippet. The user must have permission to change an existing snippet.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
PUT /projects/:id/snippets/:snippet_id
```
Parameters:
2021-01-03 14:25:43 +05:30
| Attribute | Type | Required | Description |
|:----------------------|:----------------|:---------|:----------------------------------------------------------------------------------------------------------------|
2022-01-26 12:08:38 +05:30
| `id` | integer or string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2021-01-03 14:25:43 +05:30
| `snippet_id` | integer | yes | The ID of a project's snippet |
| `title` | string | no | Title of a snippet |
| `file_name` | string | no | Deprecated: Use `files` instead. Name of a snippet file |
| `content` | string | no | Deprecated: Use `files` instead. Content of a snippet |
| `description` | string | no | Description of a snippet |
| `visibility` | string | no | Snippet's [visibility](#snippet-visibility-level) |
| `files` | array of hashes | no | An array of snippet files |
2021-04-17 20:07:23 +05:30
| `files:action` | string | yes | Type of action to perform on the file, one of: `create`, `update`, `delete`, `move` |
2021-01-03 14:25:43 +05:30
| `files:file_path` | string | no | File path of the snippet file |
| `files:previous_path` | string | no | Previous path of the snippet file |
| `files:content` | string | no | Content of the snippet file |
Updates to snippets with multiple files *must* use the `files` attribute.
2014-09-02 18:07:02 +05:30
2019-12-04 20:38:33 +05:30
Example request:
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request PUT "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id" \
2019-12-04 20:38:33 +05:30
--header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type: application/json" \
-d @snippet.json
```
`snippet.json` used in the above example request:
```json
{
"title" : "Updated Snippet Title",
"description" : "More verbose snippet description",
2021-01-03 14:25:43 +05:30
"visibility" : "private",
"files": [
{
"action": "update",
"file_path": "example.txt",
"content" : "updated source code \n with multiple lines\n"
}
]
2019-12-04 20:38:33 +05:30
}
```
2014-09-02 18:07:02 +05:30
## Delete snippet
2018-03-17 18:26:18 +05:30
Deletes an existing project snippet. This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found.
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
DELETE /projects/:id/snippets/:snippet_id
```
Parameters:
2022-01-26 12:08:38 +05:30
| Attribute | Type | Required | Description |
|:-------------|:---------------|:---------|:----------------------------------------------------------------------------------------------------------------|
| `id` | integer or string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
| `snippet_id` | integer | yes | The ID of a project's snippet |
2014-09-02 18:07:02 +05:30
2019-12-04 20:38:33 +05:30
Example request:
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request DELETE "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id" \
2019-12-04 20:38:33 +05:30
--header "PRIVATE-TOKEN: <your_access_token>"
```
2014-09-02 18:07:02 +05:30
## Snippet content
Returns the raw project snippet as plain text.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /projects/:id/snippets/:snippet_id/raw
```
Parameters:
2022-01-26 12:08:38 +05:30
| Attribute | Type | Required | Description |
|:-------------|:---------------|:---------|:----------------------------------------------------------------------------------------------------------------|
| `id` | integer or string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
| `snippet_id` | integer | yes | The ID of a project's snippet |
2017-09-10 17:25:29 +05:30
2019-12-04 20:38:33 +05:30
Example request:
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id/raw" \
2019-12-04 20:38:33 +05:30
--header "PRIVATE-TOKEN: <your_access_token>"
```
2020-07-28 23:09:34 +05:30
## Snippet repository file content
Returns the raw file content as plain text.
```plaintext
GET /projects/:id/snippets/:snippet_id/files/:ref/:file_path/raw
```
Parameters:
2022-01-26 12:08:38 +05:30
| Attribute | Type | Required | Description |
|:-------------|:---------------|:---------|:----------------------------------------------------------------------------------------------------------------|
| `id` | integer or string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
| `snippet_id` | integer | yes | The ID of a project's snippet |
2022-07-23 23:45:48 +05:30
| `ref` | string | yes | The name of a branch, tag or commit, for example, main |
| `file_path` | string | yes | The URL-encoded path to the file, for example, snippet%2Erb |
2020-07-28 23:09:34 +05:30
Example request:
```shell
curl "https://gitlab.com/api/v4/projects/1/snippets/2/files/master/snippet%2Erb/raw" \
--header "PRIVATE-TOKEN: <your_access_token>"
```
2017-09-10 17:25:29 +05:30
## Get user agent details
2022-04-04 11:22:00 +05:30
Available only for users with administrator access.
2017-09-10 17:25:29 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /projects/:id/snippets/:snippet_id/user_agent_detail
```
2022-01-26 12:08:38 +05:30
| Attribute | Type | Required | Description |
|--------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------|
| `id` | integer or string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
| `snippet_id` | Integer | yes | The ID of a snippet |
2017-09-10 17:25:29 +05:30
2019-12-04 20:38:33 +05:30
Example request:
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/snippets/2/user_agent_detail"
2017-09-10 17:25:29 +05:30
```
Example response:
```json
{
"user_agent": "AppleWebKit/537.36",
"ip_address": "127.0.0.1",
"akismet_submitted": false
}
```