Create a comment on a commit

POST

/api/v4/projects/{id}/repository/commits/{sha}/comments

• GitLab REST API

Creates a comment on a commit. To comment on a specific line in a file, specify the full commit SHA, path, line, and set line_type to new.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project

sha

required

string

A commit sha, or the name of a branch or tag on which to post a comment

Request Body ^required

Media type application/json

object

note

required

The text of the comment

string

nullable

Example

Nice code!

path

The file path

string

nullable

Example

doc/update/5.4-to-6.0.md

line

required

The line number

integer

nullable

Example

11

line_type

required

The type of the line

string

default: new >= 1 characters

Allowed values: new old

Responses

200

OK

Media type application/json

object

note

string

path

string

line

integer

line_type

string

author

object

id

integer format: int64

username

string

public_email

string

name

string

state

string

locked

boolean

avatar_url

string

avatar_path

string

custom_attributes

Array<object>

object

key

string

value

string

web_url

string

created_at

string format: date-time

Example

{
  "note": "this doc is really nice",
  "path": "README.md",
  "line": 11,
  "line_type": "new",
  "author": {
    "id": 1,
    "username": "admin",
    "public_email": "john@example.com",
    "name": "Administrator",
    "state": "active",
    "avatar_url": "https://gravatar.com/avatar/1",
    "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
    "custom_attributes": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "web_url": "https://gitlab.example.com/root"
  },
  "created_at": "2016-01-19T09:44:55.600Z"
}

400

Bad request

404

Not found