スニペットAPI

スニペットAPIはスニペットに関するオペレーションを行います。スニペットをプロジェクト化したり、ストレージ間でスニペットを移動したりするための関連APIがあります。

スニペットの可視レベル

GitLabのスニペットには、非公開、内部、公開のいずれかがあります。スニペット内のvisibility フィールドで設定できます。

スニペット可視レベルの有効な値は以下の通りです：

可視性説明
privateスニペットはスニペット作成者にのみ表示されます。
internalスニペットは、外部ユーザーを除く、認証されたすべてのユーザーに表示されます。
publicスニペットには認証なしでアクセスできます。

現在のユーザーのスニペット一覧を表示します。

現在のユーザーのスニペット一覧を取得します。

GET /snippets

パラメータを指定します：

属性種類必須説明
per_page整数。いいえページごとに返すスニペット数。
page整数。いいえ取得するPages。
created_afterdatetimeいいえ指定された時間以降に作成されたスニペットを返します。ISO 8601 形式 (2019-03-15T08:00:00Z) で返されます。
created_beforedatetimeいいえ指定された時間以前に作成されたスニペットを返します。ISO 8601 形式 (2019-03-15T08:00:00Z) で返されます。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets"

応答例

[
    {
        "id": 42,
        "title": "Voluptatem iure ut qui aut et consequatur quaerat.",
        "file_name": "mclaughlin.rb",
        "description": null,
        "visibility": "internal",
        "author": {
            "id": 22,
            "name": "User 0",
            "username": "user0",
            "state": "active",
            "avatar_url": "https://www.gravatar.com/avatar/52e4ce24a915fb7e51e1ad3b57f4b00a?s=80&d=identicon",
            "web_url": "http://example.com/user0"
        },
        "updated_at": "2018-09-18T01:12:26.383Z",
        "created_at": "2018-09-18T01:12:26.383Z",
        "project_id": null,
        "web_url": "http://example.com/snippets/42",
        "raw_url": "http://example.com/snippets/42/raw"
    },
    {
        "id": 41,
        "title": "Ut praesentium non et atque.",
        "file_name": "ondrickaemard.rb",
        "description": null,
        "visibility": "internal",
        "author": {
            "id": 22,
            "name": "User 0",
            "username": "user0",
            "state": "active",
            "avatar_url": "https://www.gravatar.com/avatar/52e4ce24a915fb7e51e1ad3b57f4b00a?s=80&d=identicon",
            "web_url": "http://example.com/user0"
        },
        "updated_at": "2018-09-18T01:12:26.360Z",
        "created_at": "2018-09-18T01:12:26.360Z",
        "project_id": 1,
        "web_url": "http://example.com/gitlab-org/gitlab-test/snippets/41",
        "raw_url": "http://example.com/gitlab-org/gitlab-test/snippets/41/raw"
    }
]

単一のスニペットの取得

スニペット1つを取得します。

GET /snippets/:id

パラメータを指定します：

属性種類必須説明
id整数。yes取得するスニペットのID。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/1"

応答例

{
  "id": 1,
  "title": "test",
  "file_name": "add.rb",
  "description": "Ruby test snippet",
  "visibility": "private",
  "author": {
    "id": 1,
    "username": "john_smith",
    "email": "john@example.com",
    "name": "John Smith",
    "state": "active",
    "created_at": "2012-05-23T08:00:58Z"
  },
  "expires_at": null,
  "updated_at": "2012-06-28T10:52:04Z",
  "created_at": "2012-06-28T10:52:04Z",
  "project_id": null,
  "web_url": "http://example.com/snippets/1",
  "raw_url": "http://example.com/snippets/1/raw"
}

単一のスニペットコンテンツ

単一のスニペットの生のコンテンツを取得します。

GET /snippets/:id/raw

パラメータを指定します：

属性種類必須説明
id整数。yes取得するスニペットのID。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/1/raw"

応答例

Hello World snippet

スニペットリポジトリファイルの内容

ファイルの内容をプレーンテキストで返します。

GET /snippets/:id/files/:ref/:file_path/raw

パラメータを指定します：

属性種類必須説明
id整数。yes取得するスニペットのID。
ref文字列です。yesタグ、ブランチ、コミットへの参照。
file_path文字列です。yesファイルへの URL エンコードされたパス。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/1/files/master/snippet%2Erb/raw"

応答例

Hello World snippet

新しいスニペットの作成

新しいスニペットを作成します。

note
ユーザーには新しいスニペットを作成する権限が必要です。
POST /snippets

パラメータを指定します：

属性種類必須説明
title文字列です。yesスニペットのタイトル
file_name文字列です。いいえ非推奨：代わりにfiles 。スニペットファイル名
content文字列です。いいえ非推奨：代わりにfiles 。スニペットの内容
description文字列です。いいえスニペットの説明
visibility文字列です。いいえスニペットの可視性
filesハッシュの配列いいえスニペットファイルの配列
files:file_path文字列です。yesスニペットファイルのファイルパス
files:content文字列です。yesスニペットファイルの内容

リクエストの例

curl --request POST "https://gitlab.example.com/api/v4/snippets" \
     --header 'Content-Type: application/json' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     -d @snippet.json

snippet.json 上記のリクエスト例で使用されています：

{
  "title": "This is a snippet",
  "description": "Hello World snippet",
  "visibility": "internal",
  "files": [
    {
      "content": "Hello world",
      "file_path": "test.txt"
    }
  ]
}

応答例

{
  "id": 1,
  "title": "This is a snippet",
  "description": "Hello World snippet",
  "visibility": "internal",
  "author": {
    "id": 1,
    "username": "john_smith",
    "email": "john@example.com",
    "name": "John Smith",
    "state": "active",
    "created_at": "2012-05-23T08:00:58Z"
  },
  "expires_at": null,
  "updated_at": "2012-06-28T10:52:04Z",
  "created_at": "2012-06-28T10:52:04Z",
  "project_id": null,
  "web_url": "http://example.com/snippets/1",
  "raw_url": "http://example.com/snippets/1/raw",
  "ssh_url_to_repo": "ssh://git@gitlab.example.com:snippets/1.git",
  "http_url_to_repo": "https://gitlab.example.com/snippets/1.git",
  "file_name": "test.txt",
  "files": [
    {
      "path": "text.txt",
      "raw_url": "https://gitlab.example.com/-/snippets/1/raw/master/renamed.md"
    }
  ]
}

スニペットの更新

既存のスニペットを更新します。

note
ユーザーには既存のスニペットを変更する権限が必要です。
PUT /snippets/:id

パラメータを指定します：

属性種類必須説明
id整数。yes更新するスニペットのID
title文字列です。いいえスニペットのタイトル
file_name文字列です。いいえ非推奨：代わりにfiles 。スニペットファイル名
content文字列です。いいえ非推奨：代わりにfiles 。スニペットの内容
description文字列です。いいえスニペットの説明
visibility文字列です。いいえスニペットの可視性
filesハッシュの配列時々スニペットファイルの配列。複数のファイルでスニペットを更新するときに必要です。
files:action文字列です。yesファイルに対して実行するアクションの種類：create update,delete、move
files:file_path文字列です。いいえスニペットファイルのファイルパス
files:previous_path文字列です。いいえスニペットファイルの前のパス
files:content文字列です。いいえスニペットファイルの内容

リクエストの例

curl --request PUT "https://gitlab.example.com/api/v4/snippets/1" \
     --header 'Content-Type: application/json' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     -d @snippet.json

snippet.json 上記のリクエスト例で使用されています：

{
  "title": "foo",
  "files": [
    {
      "action": "move",
      "previous_path": "test.txt",
      "file_path": "renamed.md"
    }
  ]
}

応答例

{
  "id": 1,
  "title": "test",
  "description": "description of snippet",
  "visibility": "internal",
  "author": {
    "id": 1,
    "username": "john_smith",
    "email": "john@example.com",
    "name": "John Smith",
    "state": "active",
    "created_at": "2012-05-23T08:00:58Z"
  },
  "expires_at": null,
  "updated_at": "2012-06-28T10:52:04Z",
  "created_at": "2012-06-28T10:52:04Z",
  "project_id": null,
  "web_url": "http://example.com/snippets/1",
  "raw_url": "http://example.com/snippets/1/raw",
  "ssh_url_to_repo": "ssh://git@gitlab.example.com:snippets/1.git",
  "http_url_to_repo": "https://gitlab.example.com/snippets/1.git",
  "file_name": "renamed.md",
  "files": [
    {
      "path": "renamed.md",
      "raw_url": "https://gitlab.example.com/-/snippets/1/raw/master/renamed.md"
    }
  ]
}

スニペットの削除

既存のスニペットを削除します。

DELETE /snippets/:id

パラメータを指定します：

属性種類必須説明
id整数。yes削除するスニペットのID。

リクエストの例

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/1"

可能なリターンコードは以下のとおりです：

コード説明
204削除に成功しました。データは返されません。
404スニペットが見つかりませんでした。

すべての公開スニペット一覧

すべての公開スニペットを一覧表示します。

GET /snippets/public

パラメータを指定します：

属性種類必須説明
per_page整数。いいえページごとに返すスニペット数。
page整数。いいえ取得するPages。
created_afterdatetimeいいえ指定された時間以降に作成されたスニペットを返します。ISO 8601 形式 (2019-03-15T08:00:00Z) で返されます。
created_beforedatetimeいいえ指定された時間以前に作成されたスニペットを返します。ISO 8601 形式 (2019-03-15T08:00:00Z) で返されます。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/public?per_page=2&page=1"

応答例

[
    {
        "author": {
            "avatar_url": "http://www.gravatar.com/avatar/edaf55a9e363ea263e3b981d09e0f7f7?s=80&d=identicon",
            "id": 12,
            "name": "Libby Rolfson",
            "state": "active",
            "username": "elton_wehner",
            "web_url": "http://example.com/elton_wehner"
        },
        "created_at": "2016-11-25T16:53:34.504Z",
        "file_name": "oconnerrice.rb",
        "id": 49,
        "title": "Ratione cupiditate et laborum temporibus.",
        "updated_at": "2016-11-25T16:53:34.504Z",
        "project_id": null,
        "web_url": "http://example.com/snippets/49",
        "raw_url": "http://example.com/snippets/49/raw"
    },
    {
        "author": {
            "avatar_url": "http://www.gravatar.com/avatar/36583b28626de71061e6e5a77972c3bd?s=80&d=identicon",
            "id": 16,
            "name": "Llewellyn Flatley",
            "state": "active",
            "username": "adaline",
            "web_url": "http://example.com/adaline"
        },
        "created_at": "2016-11-25T16:53:34.479Z",
        "file_name": "muellershields.rb",
        "id": 48,
        "title": "Minus similique nesciunt vel fugiat qui ullam sunt.",
        "updated_at": "2016-11-25T16:53:34.479Z",
        "project_id": null,
        "web_url": "http://example.com/snippets/48",
        "raw_url": "http://example.com/snippets/49/raw",
        "visibility": "public"
    }
]

すべてのスニペットのリスト

GitLab 16.3 で導入されました。

現在のユーザーがアクセスできる全てのスニペットを一覧表示します。管理者または監査役のアクセスレベルを持つユーザーは、すべてのスニペット（個人とプロジェクトの両方）を見ることができます。

GET /snippets/all

パラメータを指定します：

属性種類必須説明
created_afterdatetimeいいえ指定された時間以降に作成されたスニペットを返します。ISO 8601 形式 (2019-03-15T08:00:00Z) で返されます。
created_beforedatetimeいいえ指定された時間以前に作成されたスニペットを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z) で返されます。
page整数。いいえ取得するPages。
per_page整数。いいえページごとに返すスニペット数。
repository_storage文字列です。いいえスニペットで使用されているリポジトリストレージでフィルタリングします_(管理者のみ)_。GitLab 16.3 で導入されました。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/all?per_page=2&page=1"

応答例

[
  {
    "id": 113,
    "title": "Internal Project Snippet",
    "description": null,
    "visibility": "internal",
    "author": {
      "id": 17,
      "username": "tim_kreiger",
      "name": "Tim Kreiger",
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/edaf55a9e363ea263e3b981d09e0f7f7?s=80&d=identicon",
      "web_url": "http://example.com/tim_kreiger"
    },
    "created_at": "2023-08-03T10:21:02.480Z",
    "updated_at": "2023-08-03T10:21:02.480Z",
    "project_id": 35,
    "web_url": "http://example.com/tim_kreiger/internal_project/-/snippets/113",
    "raw_url": "http://example.com/tim_kreiger/internal_project/-/snippets/113/raw",
    "file_name": "",
    "files": [],
    "repository_storage": "default"
  },
  {
    "id": 112,
    "title": "Private Personal Snippet",
    "description": null,
    "visibility": "private",
    "author": {
      "id": 1,
      "username": "root",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/edaf55a9e363ea263e3b981d09e0f7f7?s=80&d=identicon",
      "web_url": "http://example.com/root"
    },
    "created_at": "2023-08-03T10:20:59.994Z",
    "updated_at": "2023-08-03T10:20:59.994Z",
    "project_id": null,
    "web_url": "http://example.com/-/snippets/112",
    "raw_url": "http://example.com/-/snippets/112/raw",
    "file_name": "",
    "files": [],
    "repository_storage": "default"
  },
  {
    "id": 111,
    "title": "Public Personal Snippet",
    "description": null,
    "visibility": "public",
    "author": {
      "id": 17,
      "username": "tim_kreiger",
      "name": "Tim Kreiger",
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/edaf55a9e363ea263e3b981d09e0f7f7?s=80&d=identicon",
      "web_url": "http://example.com/tim_kreiger"
    },
    "created_at": "2023-08-03T10:21:01.312Z",
    "updated_at": "2023-08-03T10:21:01.312Z",
    "project_id": null,
    "web_url": "http://example.com/-/snippets/111",
    "raw_url": "http://example.com/-/snippets/111/raw",
    "file_name": "",
    "files": [],
    "repository_storage": "default"
  },
]

ユーザーエージェントの詳細の取得

note
管理者のみ利用可能です。
GET /snippets/:id/user_agent_detail
属性種類必須説明
id整数。yesスニペットのID。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/1/user_agent_detail"

応答例

{
  "user_agent": "AppleWebKit/537.36",
  "ip_address": "127.0.0.1",
  "akismet_submitted": false
}