Tags

List project repository tags

Get a list of repository tags from a project, sorted by name in reverse alphabetical order. This endpoint can be accessed without authentication if the repository is publicly accessible.

GET /projects/:id/repository/tags

Parameters:

  • id (required) - The ID of a project
[
  {
    "commit": {
      "author_name": "John Smith",
      "author_email": "[email protected]",
      "authored_date": "2012-05-28T04:42:42-07:00",
      "committed_date": "2012-05-28T04:42:42-07:00",
      "committer_name": "Jack Smith",
      "committer_email": "[email protected]",
      "id": "2695effb5807a22ff3d138d593fd856244e155e7",
      "message": "Initial commit",
      "parents_ids": [
        "2a4b78934375d7f53875269ffd4f45fd83a84ebe"
      ]
    },
    "release": {
      "tag_name": "1.0.0",
      "description": "Amazing release. Wow"
    },
    "name": "v1.0.0",
    "message": null
  }
]

Get a single repository tag

Get a specific repository tag determined by its name. This endpoint can be accessed without authentication if the repository is publicly accessible.

GET /projects/:id/repository/tags/:tag_name

Parameters:

Attribute Type Required Description
id integer yes The ID of a project
tag_name string yes The name of the tag
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/repository/tags/v1.0.0

Example Response:

{
  "name": "v5.0.0",
  "message": null,
  "commit": {
    "id": "60a8ff033665e1207714d6670fcd7b65304ec02f",
    "message": "v5.0.0\n",
    "parent_ids": [
      "f61c062ff8bcbdb00e0a1b3317a91aed6ceee06b"
    ],
    "authored_date": "2015-02-01T21:56:31.000+01:00",
    "author_name": "Arthur Verschaeve",
    "author_email": "[email protected]",
    "committed_date": "2015-02-01T21:56:31.000+01:00",
    "committer_name": "Arthur Verschaeve",
    "committer_email": "[email protected]"
  },
  "release": null
}

Create a new tag

Creates a new tag in the repository that points to the supplied ref.

POST /projects/:id/repository/tags

Parameters:

  • id (required) - The ID of a project
  • tag_name (required) - The name of a tag
  • ref (required) - Create tag using commit SHA, another tag name, or branch name.
  • message (optional) - Creates annotated tag.
  • release_description (optional) - Add release notes to the git tag and store it in the GitLab database.
{
  "commit": {
    "author_name": "John Smith",
    "author_email": "[email protected]",
    "authored_date": "2012-05-28T04:42:42-07:00",
    "committed_date": "2012-05-28T04:42:42-07:00",
    "committer_name": "Jack Smith",
    "committer_email": "[email protected]",
    "id": "2695effb5807a22ff3d138d593fd856244e155e7",
    "message": "Initial commit",
    "parents_ids": [
      "2a4b78934375d7f53875269ffd4f45fd83a84ebe"
    ]
  },
  "release": {
    "tag_name": "1.0.0",
    "description": "Amazing release. Wow"
  },
  "name": "v1.0.0",
  "message": null
}

The message will be nil when creating a lightweight tag otherwise it will contain the annotation.

In case of an error, status code 405 with an explaining error message is returned.

Delete a tag

Deletes a tag of a repository with given name.

DELETE /projects/:id/repository/tags/:tag_name

Parameters:

  • id (required) - The ID of a project
  • tag_name (required) - The name of a tag
{
  "tag_name": "v4.3.0"
}

Create a new release

Add release notes to the existing git tag. If there already exists a release for the given tag, status code 409 is returned.

POST /projects/:id/repository/tags/:tag_name/release

Parameters:

  • id (required) - The ID of a project
  • tag_name (required) - The name of a tag
  • description (required) - Release notes with markdown support
{
  "tag_name": "1.0.0",
  "description": "Amazing release. Wow"
}

Update a release

Updates the release notes of a given release.

PUT /projects/:id/repository/tags/:tag_name/release

Parameters:

  • id (required) - The ID of a project
  • tag_name (required) - The name of a tag
  • description (required) - Release notes with markdown support
{
  "tag_name": "1.0.0",
  "description": "Amazing release. Wow"
}