이 API로 프로젝트 스니펫을 관리합니다. 관련 API로 개인 스니펫과 스토리지 간 스니펫 이동이 있습니다.

프로젝트의 모든 스니펫 조회#

지정한 프로젝트의 모든 스니펫을 조회합니다.

GET /projects/:id/snippets

지원되는 속성:

요청에 성공하면 200 OK와 다음 응답 속성을 반환합니다.

요청 예시:

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

응답 예시:

[
  {
    "id": 1,
    "title": "test",
    "file_name": "add.rb",
    "description": "Ruby test snippet",
    "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",
    "created_at": "2012-06-28T10:52:04Z",
    "imported": false,
    "imported_from": "none",
    "project_id": 1,
    "web_url": "http://example.com/example/example/snippets/1",
    "raw_url": "http://example.com/example/example/snippets/1/raw",
    "ssh_url_to_repo": "ssh://git@example.com:example/example/snippets/1.git",
    "http_url_to_repo": "http://example.com/example/example/snippets/1.git"
  },
  {
    "id": 3,
    "title": "Configuration helper",
    "file_name": "config.yml",
    "description": "YAML configuration snippet",
    "author": {
      "id": 2,
      "username": "jane_doe",
      "email": "jane@example.com",
      "name": "Jane Doe",
      "state": "active",
      "created_at": "2013-02-15T10:30:20Z"
    },
    "updated_at": "2013-03-10T14:15:30Z",
    "created_at": "2013-03-01T09:45:12Z",
    "imported": false,
    "imported_from": "none",
    "project_id": 1,
    "web_url": "http://example.com/example/example/snippets/3",
    "raw_url": "http://example.com/example/example/snippets/3/raw",
    "ssh_url_to_repo": "ssh://git@example.com:example/example/snippets/3.git",
    "http_url_to_repo": "http://example.com/example/example/snippets/3.git"
  }
]

스니펫 조회#

지정한 프로젝트 스니펫을 조회합니다.

GET /projects/:id/snippets/:snippet_id

지원되는 속성:

요청에 성공하면 200 OK와 다음 응답 속성을 반환합니다.

요청 예시:

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

응답 예시:

{
  "id": 2,
  "title": "test",
  "file_name": "add.rb",
  "description": "Ruby test snippet",
  "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",
  "created_at": "2012-06-28T10:52:04Z",
  "imported": false,
  "imported_from": "none",
  "project_id": 1,
  "web_url": "http://example.com/example/example/snippets/2",
  "raw_url": "http://example.com/example/example/snippets/2/raw",
  "ssh_url_to_repo": "ssh://git@example.com:example/example/snippets/2.git",
  "http_url_to_repo": "http://example.com/example/example/snippets/2.git"
}

스니펫 생성#

프로젝트 스니펫을 생성합니다. 사용자에게 스니펫을 생성할 권한이 있어야 합니다.

스니펫 생성은 인증된 사용자마다 시간당 300건으로 속도가 제한됩니다. 이 제한은 이 엔드포인트와 개인 스니펫 생성, 그리고 GitLab UI가 사용하는 createSnippet GraphQL 뮤테이션이 함께 사용합니다. 자세한 내용은 구성할 수 없는 속도 제한을 참고합니다.

POST /projects/:id/snippets

지원되는 속성:

요청에 성공하면 201 Created와 다음 응답 속성을 반환합니다.

요청 예시:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{"title": "Example Snippet Title", "description": "More verbose snippet description", "visibility": "private", "files": [{"file_path": "example.txt", "content": "source code \n with multiple lines\n"}]}' \
  --url "https://gitlab.example.com/api/v4/projects/1/snippets"

응답 예시:

{
  "id": 1,
  "title": "Example Snippet Title",
  "file_name": "example.txt",
  "description": "More verbose snippet description",
  "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",
  "created_at": "2012-06-28T10:52:04Z",
  "imported": false,
  "imported_from": "none",
  "project_id": 1,
  "web_url": "http://example.com/example/example/snippets/1",
  "raw_url": "http://example.com/example/example/snippets/1/raw",
  "ssh_url_to_repo": "ssh://git@example.com:example/example/snippets/1.git",
  "http_url_to_repo": "http://example.com/example/example/snippets/1.git"
}

스니펫 업데이트#

지정한 프로젝트 스니펫을 업데이트합니다. 사용자에게 기존 스니펫을 변경할 권한이 있어야 합니다.

파일이 여러 개인 스니펫을 업데이트할 때는 files 속성을 사용해야 합니다.

PUT /projects/:id/snippets/:snippet_id

지원되는 속성:

요청에 성공하면 200 OK와 다음 응답 속성을 반환합니다.

요청 예시:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{"title": "Updated Snippet Title", "description": "More verbose snippet description", "visibility": "private", "files": [{"action": "update", "file_path": "example.txt", "content": "updated source code \n with multiple lines\n"}]}' \
  --url "https://gitlab.example.com/api/v4/projects/1/snippets/2"

응답 예시:

{
  "id": 2,
  "title": "Updated Snippet Title",
  "file_name": "example.txt",
  "description": "More verbose snippet description",
  "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",
  "created_at": "2012-06-28T10:52:04Z",
  "imported": false,
  "imported_from": "none",
  "project_id": 1,
  "web_url": "http://example.com/example/example/snippets/2",
  "raw_url": "http://example.com/example/example/snippets/2/raw",
  "ssh_url_to_repo": "ssh://git@example.com:example/example/snippets/2.git",
  "http_url_to_repo": "http://example.com/example/example/snippets/2.git"
}

스니펫 삭제#

지정한 프로젝트 스니펫을 삭제합니다. 작업에 성공하면 204 No Content 상태 코드를, 리소스를 찾지 못하면 404를 반환합니다.

DELETE /projects/:id/snippets/:snippet_id

지원되는 속성:

요청 예시:

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

스니펫 콘텐츠 조회#

프로젝트 스니펫의 원본을 일반 텍스트로 조회합니다.

GET /projects/:id/snippets/:snippet_id/raw

지원되는 속성:

요청 예시:

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

스니펫 리포지터리 파일 콘텐츠 조회#

원본 파일 콘텐츠를 일반 텍스트로 조회합니다.

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

지원되는 속성:

요청 예시:

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

사용자 에이전트 정보 조회#

지정한 스니펫의 사용자 에이전트 정보를 조회합니다. 관리자 액세스 권한이 있는 사용자만 사용할 수 있습니다.

GET /projects/:id/snippets/:snippet_id/user_agent_detail

지원되는 속성:

요청에 성공하면 200 OK와 다음 응답 속성을 반환합니다.

요청 예시:

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

응답 예시:

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