# NAME
GitLab::API::v4 - A complete GitLab API v4 client.
# SYNOPSIS
```perl
use GitLab::API::v4;
my $api = GitLab::API::v4->new(
url => $v4_api_url,
private_token => $token,
);
my $branches = $api->branches( $project_id );
```
# DESCRIPTION
This module provides a one-to-one interface with the GitLab
API v4. Much is not documented here as it would just be duplicating
GitLab's own [API Documentation](http://doc.gitlab.com/ce/api/README.html).
Note that this distribution also includes the [gitlab-api-v4](https://metacpan.org/pod/gitlab-api-v4) command-line
interface (CLI).
## Upgrading
If you are upgrading from [GitLab::API::v3](https://metacpan.org/pod/GitLab%3A%3AAPI%3A%3Av3) make sure you read:
[https://docs.gitlab.com/ce/api/v3\_to\_v4.html](https://docs.gitlab.com/ce/api/v3_to_v4.html)
Also, review the `Changes` file included in the distribution as it outlines
the changes made to convert the v3 module to v4:
[https://github.com/bluefeet/GitLab-API-v4/blob/master/Changes](https://github.com/bluefeet/GitLab-API-v4/blob/master/Changes)
Finally, be aware that many methods were added, removed, renamed, and/or altered.
If you want to review exactly what was changed you can use GitHub's compare tool:
[https://github.com/bluefeet/GitLab-API-v4/compare/72e384775c9570f60f8ef68dee3a1eecd347fb69...master](https://github.com/bluefeet/GitLab-API-v4/compare/72e384775c9570f60f8ef68dee3a1eecd347fb69...master)
Or clone the repo and run this command:
`git diff 72e384775c9570f60f8ef68dee3a1eecd347fb69..HEAD -- author/sections/`
## Credentials
Authentication credentials may be defined by setting either the ["access\_token"](#access_token)
or ["private\_token"](#private_token) arguments.
If no credentials are supplied then the client will be anonymous and greatly
limited in what it can do with the API.
Extra care has been taken to hide the token arguments behind closures. This way,
if you dump your api object, your tokens won't accidentally leak into places you
don't want them to.
## Constants
The GitLab API, in rare cases, uses a hard-coded value to represent a state.
To make life easier the [GitLab::API::v4::Constants](https://metacpan.org/pod/GitLab%3A%3AAPI%3A%3Av4%3A%3AConstants) module exposes
these states as named variables.
## Exceptions
The API methods will all throw a useful exception if
an unsuccessful response is received from the API. That is except for
`GET` requests that return a `404` response - these will return `undef`
for methods that return a value.
If you'd like to catch and handle these exceptions consider using
[Try::Tiny](https://metacpan.org/pod/Try%3A%3ATiny).
## Logging
This module uses [Log::Any](https://metacpan.org/pod/Log%3A%3AAny) and produces some debug messages here
and there, but the most useful bits are the info messages produced
just before each API call.
## Project ID
Note that many API calls require a `$project_id`. This can be
specified as a numeric project `ID` or, in many cases, maybe all cases,
as a `NAMESPACE_PATH/PROJECT_PATH` string. The GitLab documentation on
this point is vague.
# REQUIRED ARGUMENTS
## url
The URL to your v4 API endpoint. Typically this will be something
like `https://git.example.com/api/v4`.
# OPTIONAL ARGUMENTS
## access\_token
A GitLab API OAuth2 token. If set then ["private\_token"](#private_token) may not be set.
See [https://docs.gitlab.com/ce/api/#oauth2-tokens](https://docs.gitlab.com/ce/api/#oauth2-tokens).
## private\_token
A GitLab API personal token. If set then ["access\_token"](#access_token) may not be set.
See [https://docs.gitlab.com/ce/api/#personal-access-tokens](https://docs.gitlab.com/ce/api/#personal-access-tokens).
## retries
The number of times the request should be retried in case it fails (5XX HTTP
response code). Defaults to `0` (false), meaning that a failed request will
not be retried.
## sudo\_user
The user to execute API calls as. You may find it more useful to use the
["sudo"](#sudo) method instead.
See [https://docs.gitlab.com/ce/api/#sudo](https://docs.gitlab.com/ce/api/#sudo).
## rest\_client
An instance of [GitLab::API::v4::RESTClient](https://metacpan.org/pod/GitLab%3A%3AAPI%3A%3Av4%3A%3ARESTClient) (or whatever ["rest\_client\_class"](#rest_client_class)
is set to). Typically you will not be setting this as it defaults to a new
instance and customization should not be necessary.
## rest\_client\_class
The class to use when constructing the ["rest\_client"](#rest_client).
Defaults to [GitLab::API::v4::RESTClient](https://metacpan.org/pod/GitLab%3A%3AAPI%3A%3Av4%3A%3ARESTClient).
# UTILITY METHODS
## paginator
```perl
my $paginator = $api->paginator( $method, @method_args );
my $members = $api->paginator('group_members', $group_id);
while (my $member = $members->next()) {
...
}
my $users_pager = $api->paginator('users');
while (my $users = $users_pager->next_page()) {
...
}
my $all_open_issues = $api->paginator(
'issues',
$project_id,
{ state=>'opened' },
)->all();
```
Given a method who supports the `page` and `per_page` parameters,
and returns an array ref, this will return a [GitLab::API::v4::Paginator](https://metacpan.org/pod/GitLab%3A%3AAPI%3A%3Av4%3A%3APaginator)
object that will allow you to walk the records one page or one record
at a time.
## sudo
```
$api->sudo('fred')->create_issue(...);
```
Returns a new instance of [GitLab::API::v4](https://metacpan.org/pod/GitLab%3A%3AAPI%3A%3Av4) with the ["sudo\_user"](#sudo_user) argument
set.
See [https://docs.gitlab.com/ce/api/#sudo](https://docs.gitlab.com/ce/api/#sudo).
# API METHODS
## Award Emoji
See [https://docs.gitlab.com/ce/api/award\_emoji.html](https://docs.gitlab.com/ce/api/award_emoji.html).
- issue\_award\_emojis
```perl
my $award_emojis = $api->issue_award_emojis(
$project_id,
$issue_iid,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/award_emoji` and returns the decoded response content.
- merge\_request\_award\_emojis
```perl
my $award_emojis = $api->merge_request_award_emojis(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/award_emoji` and returns the decoded response content.
- snippet\_award\_emojis
```perl
my $award_emojis = $api->snippet_award_emojis(
$project_id,
$merge_request_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_id/award_emoji` and returns the decoded response content.
- issue\_award\_emoji
```perl
my $award_emoji = $api->issue_award_emoji(
$project_id,
$issue_iid,
$award_id,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/award_emoji/:award_id` and returns the decoded response content.
- merge\_request\_award\_emoji
```perl
my $award_emoji = $api->merge_request_award_emoji(
$project_id,
$merge_request_iid,
$award_id,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/award_emoji/:award_id` and returns the decoded response content.
- snippet\_award\_emoji
```perl
my $award_emoji = $api->snippet_award_emoji(
$project_id,
$snippet_id,
$award_id,
);
```
Sends a `GET` request to `projects/:project_id/snippets/:snippet_id/award_emoji/:award_id` and returns the decoded response content.
- create\_issue\_award\_emoji
```perl
my $award_emoji = $api->create_issue_award_emoji(
$project_id,
$issue_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/award_emoji` and returns the decoded response content.
- create\_merge\_request\_award\_emoji
```perl
my $award_emoji = $api->create_merge_request_award_emoji(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/award_emoji` and returns the decoded response content.
- create\_snippet\_award\_emoji
```perl
my $award_emoji = $api->create_snippet_award_emoji(
$project_id,
$snippet_id,
);
```
Sends a `POST` request to `projects/:project_id/snippets/:snippet_id/award_emoji` and returns the decoded response content.
- delete\_issue\_award\_emoji
```perl
my $award_emoji = $api->delete_issue_award_emoji(
$project_id,
$issue_id,
$award_id,
);
```
Sends a `DELETE` request to `projects/:project_id/issues/:issue_id/award_emoji/:award_id` and returns the decoded response content.
- delete\_merge\_request\_award\_emoji
```perl
my $award_emoji = $api->delete_merge_request_award_emoji(
$project_id,
$merge_request_id,
$award_id,
);
```
Sends a `DELETE` request to `projects/:project_id/merge_requests/:merge_request_id/award_emoji/:award_id` and returns the decoded response content.
- delete\_snippet\_award\_emoji
```perl
my $award_emoji = $api->delete_snippet_award_emoji(
$project_id,
$snippet_id,
$award_id,
);
```
Sends a `DELETE` request to `projects/:project_id/snippets/:snippet_id/award_emoji/:award_id` and returns the decoded response content.
- issue\_note\_award\_emojis
```perl
my $award_emojis = $api->issue_note_award_emojis(
$project_id,
$issue_iid,
$note_id,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/notes/:note_id/award_emoji` and returns the decoded response content.
- issue\_note\_award\_emoji
```perl
my $award_emoji = $api->issue_note_award_emoji(
$project_id,
$issue_iid,
$note_id,
$award_id,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id` and returns the decoded response content.
- create\_issue\_note\_award\_emoji
```perl
my $award_emoji = $api->create_issue_note_award_emoji(
$project_id,
$issue_iid,
$note_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/notes/:note_id/award_emoji` and returns the decoded response content.
- delete\_issue\_note\_award\_emoji
```perl
my $award_emoji = $api->delete_issue_note_award_emoji(
$project_id,
$issue_iid,
$note_id,
$award_id,
);
```
Sends a `DELETE` request to `projects/:project_id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id` and returns the decoded response content.
- merge\_request\_note\_award\_emojis
```perl
my $award_emojis = $api->merge_request_note_award_emojis(
$project_id,
$merge_request_iid,
$note_id,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji` and returns the decoded response content.
- merge\_request\_note\_award\_emoji
```perl
my $award_emoji = $api->merge_request_note_award_emoji(
$project_id,
$merge_request_iid,
$note_id,
$award_id,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_id` and returns the decoded response content.
- create\_merge\_request\_note\_award\_emoji
```perl
my $award_emoji = $api->create_merge_request_note_award_emoji(
$project_id,
$merge_request_iid,
$note_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji` and returns the decoded response content.
- delete\_merge\_request\_note\_award\_emoji
```perl
my $award_emoji = $api->delete_merge_request_note_award_emoji(
$project_id,
$merge_request_iid,
$note_id,
$award_id,
);
```
Sends a `DELETE` request to `projects/:project_id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_id` and returns the decoded response content.
## Branches
See [https://docs.gitlab.com/ce/api/branches.html](https://docs.gitlab.com/ce/api/branches.html).
- branches
```perl
my $branches = $api->branches(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/branches` and returns the decoded response content.
- branch
```perl
my $branch = $api->branch(
$project_id,
$branch_name,
);
```
Sends a `GET` request to `projects/:project_id/repository/branches/:branch_name` and returns the decoded response content.
- create\_branch
```perl
my $branch = $api->create_branch(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/repository/branches` and returns the decoded response content.
- delete\_branch
```
$api->delete_branch(
$project_id,
$branch_name,
);
```
Sends a `DELETE` request to `projects/:project_id/repository/branches/:branch_name`.
- delete\_merged\_branches
```
$api->delete_merged_branches(
$project_id,
);
```
Sends a `DELETE` request to `projects/:project_id/repository/merged_branches`.
## Broadcast Messages
See [https://docs.gitlab.com/ce/api/broadcast\_messages.html](https://docs.gitlab.com/ce/api/broadcast_messages.html).
- broadcast\_messages
```perl
my $messages = $api->broadcast_messages(
\%params,
);
```
Sends a `GET` request to `broadcast_messages` and returns the decoded response content.
- broadcast\_message
```perl
my $message = $api->broadcast_message(
$message_id,
);
```
Sends a `GET` request to `broadcast_messages/:message_id` and returns the decoded response content.
- create\_broadcast\_message
```perl
my $message = $api->create_broadcast_message(
\%params,
);
```
Sends a `POST` request to `broadcast_messages` and returns the decoded response content.
- edit\_broadcast\_message
```perl
my $message = $api->edit_broadcast_message(
$message_id,
\%params,
);
```
Sends a `PUT` request to `broadcast_messages/:message_id` and returns the decoded response content.
- delete\_broadcast\_message
```
$api->delete_broadcast_message(
$message_id,
);
```
Sends a `DELETE` request to `broadcast_messages/:message_id`.
## Project-level Variables
See [https://docs.gitlab.com/ce/api/project\_level\_variables.html](https://docs.gitlab.com/ce/api/project_level_variables.html).
- project\_variables
```perl
my $variables = $api->project_variables(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/variables` and returns the decoded response content.
- project\_variable
```perl
my $variable = $api->project_variable(
$project_id,
$variable_key,
);
```
Sends a `GET` request to `projects/:project_id/variables/:variable_key` and returns the decoded response content.
- create\_project\_variable
```perl
my $variable = $api->create_project_variable(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/variables` and returns the decoded response content.
- edit\_project\_variable
```perl
my $variable = $api->edit_project_variable(
$project_id,
$variable_key,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/variables/:variable_key` and returns the decoded response content.
- delete\_project\_variable
```
$api->delete_project_variable(
$project_id,
$variable_key,
);
```
Sends a `DELETE` request to `projects/:project_id/variables/:variable_key`.
## Group-level Variables
See [https://docs.gitlab.com/ce/api/group\_level\_variables.html](https://docs.gitlab.com/ce/api/group_level_variables.html).
- group\_variables
```perl
my $variables = $api->group_variables(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/variables` and returns the decoded response content.
- group\_variable
```perl
my $variable = $api->group_variable(
$group_id,
$variable_key,
);
```
Sends a `GET` request to `groups/:group_id/variables/:variable_key` and returns the decoded response content.
- create\_group\_variable
```perl
my $variable = $api->create_group_variable(
$group_id,
\%params,
);
```
Sends a `POST` request to `groups/:group_id/variables` and returns the decoded response content.
- edit\_group\_variable
```perl
my $variable = $api->edit_group_variable(
$group_id,
$variable_key,
\%params,
);
```
Sends a `PUT` request to `groups/:group_id/variables/:variable_key` and returns the decoded response content.
- delete\_group\_variable
```
$api->delete_group_variable(
$group_id,
$variable_key,
);
```
Sends a `DELETE` request to `groups/:group_id/variables/:variable_key`.
## Snippets
See [https://docs.gitlab.com/ce/api/snippets.html](https://docs.gitlab.com/ce/api/snippets.html).
- snippets
```perl
my $snippets = $api->snippets();
```
Sends a `GET` request to `snippets` and returns the decoded response content.
- snippet
```perl
my $snippet = $api->snippet(
$snippet_id,
);
```
Sends a `GET` request to `snippets/:snippet_id` and returns the decoded response content.
- create\_snippet
```perl
my $snippet = $api->create_snippet(
\%params,
);
```
Sends a `POST` request to `snippets` and returns the decoded response content.
- edit\_snippet
```perl
my $snippet = $api->edit_snippet(
$snippet_id,
\%params,
);
```
Sends a `PUT` request to `snippets/:snippet_id` and returns the decoded response content.
- delete\_snippet
```
$api->delete_snippet(
$snippet_id,
);
```
Sends a `DELETE` request to `snippets/:snippet_id`.
- public\_snippets
```perl
my $snippets = $api->public_snippets(
\%params,
);
```
Sends a `GET` request to `snippets/public` and returns the decoded response content.
- snippet\_user\_agent\_detail
```perl
my $user_agent = $api->snippet_user_agent_detail(
$snippet_id,
);
```
Sends a `GET` request to `snippets/:snippet_id/user_agent_detail` and returns the decoded response content.
## Commits
See [https://docs.gitlab.com/ce/api/commits.html](https://docs.gitlab.com/ce/api/commits.html).
- commits
```perl
my $commits = $api->commits(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/commits` and returns the decoded response content.
- create\_commit
```perl
my $commit = $api->create_commit(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/repository/commits` and returns the decoded response content.
- commit
```perl
my $commit = $api->commit(
$project_id,
$commit_sha,
);
```
Sends a `GET` request to `projects/:project_id/repository/commits/:commit_sha` and returns the decoded response content.
- commit\_refs
```perl
my $refs = $api->commit_refs(
$project_id,
$commit_sha,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/commits/:commit_sha/refs` and returns the decoded response content.
- cherry\_pick\_commit
```perl
my $commit = $api->cherry_pick_commit(
$project_id,
$commit_sha,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/repository/commits/:commit_sha/cherry_pick` and returns the decoded response content.
- commit\_diff
```perl
my $diff = $api->commit_diff(
$project_id,
$commit_sha,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/commits/:commit_sha/diff` and returns the decoded response content.
- commit\_comments
```perl
my $comments = $api->commit_comments(
$project_id,
$commit_sha,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/commits/:commit_sha/comments` and returns the decoded response content.
- create\_commit\_comment
```
$api->create_commit_comment(
$project_id,
$commit_sha,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/repository/commits/:commit_sha/comments`.
- commit\_statuses
```perl
my $build_statuses = $api->commit_statuses(
$project_id,
$commit_sha,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/commits/:commit_sha/statuses` and returns the decoded response content.
- create\_commit\_status
```perl
my $build_status = $api->create_commit_status(
$project_id,
$commit_sha,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/statuses/:commit_sha` and returns the decoded response content.
## Container Registry
See [https://docs.gitlab.com/ce/api/container\_registry.html](https://docs.gitlab.com/ce/api/container_registry.html).
- registry\_repositories\_in\_project
```perl
my $registry_repositories = $api->registry_repositories_in_project(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/registry/repositories` and returns the decoded response content.
- registry\_repositories\_in\_group
```perl
my $registry_repositories = $api->registry_repositories_in_group(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/registry/repositories` and returns the decoded response content.
- delete\_registry\_repository
```
$api->delete_registry_repository(
$project_id,
$repository_id,
);
```
Sends a `DELETE` request to `projects/:project_id/registry/repositories/:repository_id`.
- registry\_repository\_tags
```perl
my $tags = $api->registry_repository_tags(
$project_id,
$repository_id,
);
```
Sends a `GET` request to `projects/:project_id/registry/repositories/:repository_id/tags` and returns the decoded response content.
- registry\_repository\_tag
```perl
my $tag = $api->registry_repository_tag(
$project_id,
$repository_id,
$tag_name,
);
```
Sends a `GET` request to `projects/:project_id/registry/repositories/:repository_id/tags/:tag_name` and returns the decoded response content.
- delete\_registry\_repository\_tag
```
$api->delete_registry_repository_tag(
$project_id,
$repository_id,
$tag_name,
);
```
Sends a `DELETE` request to `projects/:project_id/registry/repositories/:repository_id/tags/:tag_name`.
- bulk\_delete\_registry\_repository\_tags
```
$api->bulk_delete_registry_repository_tags(
$project_id,
$repository_id,
\%params,
);
```
Sends a `DELETE` request to `projects/:project_id/registry/repositories/:repository_id/tags`.
## Custom Attributes
See [https://docs.gitlab.com/ce/api/custom\_attributes.html](https://docs.gitlab.com/ce/api/custom_attributes.html).
- custom\_user\_attributes
```perl
my $attributes = $api->custom_user_attributes(
$user_id,
);
```
Sends a `GET` request to `users/:user_id/custom_attributes` and returns the decoded response content.
- custom\_group\_attributes
```perl
my $attributes = $api->custom_group_attributes(
$group_id,
);
```
Sends a `GET` request to `groups/:group_id/custom_attributes` and returns the decoded response content.
- custom\_project\_attributes
```perl
my $attributes = $api->custom_project_attributes(
$project_id,
);
```
Sends a `GET` request to `projects/:project_id/custom_attributes` and returns the decoded response content.
- custom\_user\_attribute
```perl
my $attribute = $api->custom_user_attribute(
$user_id,
$attribute_key,
);
```
Sends a `GET` request to `users/:user_id/custom_attributes/:attribute_key` and returns the decoded response content.
- custom\_group\_attribute
```perl
my $attribute = $api->custom_group_attribute(
$group_id,
$attribute_key,
);
```
Sends a `GET` request to `groups/:group_id/custom_attributes/:attribute_key` and returns the decoded response content.
- custom\_project\_attribute
```perl
my $attribute = $api->custom_project_attribute(
$project_id,
$attribute_key,
);
```
Sends a `GET` request to `projects/:project_id/custom_attributes/:attribute_key` and returns the decoded response content.
- set\_custom\_user\_attribute
```perl
my $attribute = $api->set_custom_user_attribute(
$user_id,
$attribute_key,
\%params,
);
```
Sends a `PUT` request to `users/:user_id/custom_attributes/:attribute_key` and returns the decoded response content.
- set\_custom\_group\_attribute
```perl
my $attribute = $api->set_custom_group_attribute(
$group_id,
$attribute_key,
\%params,
);
```
Sends a `PUT` request to `groups/:group_id/custom_attributes/:attribute_key` and returns the decoded response content.
- set\_custom\_project\_attribute
```perl
my $attribute = $api->set_custom_project_attribute(
$project_id,
$attribute_key,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/custom_attributes/:attribute_key` and returns the decoded response content.
- delete\_custom\_user\_attribute
```perl
$api->delete_custom_user_attribute(
$user_id,
$attribute_key,
);
```
Sends a `DELETE` request to `users/:user_id/custom_attributes/:attribute_key`.
- delete\_custom\_group\_attribute
```
$api->delete_custom_group_attribute(
$group_id,
$attribute_key,
);
```
Sends a `DELETE` request to `groups/:group_id/custom_attributes/:attribute_key`.
- delete\_custom\_project\_attribute
```
$api->delete_custom_project_attribute(
$project_id,
$attribute_key,
);
```
Sends a `DELETE` request to `projects/:project_id/custom_attributes/:attribute_key`.
## Deployments
See [https://docs.gitlab.com/ce/api/deployments.html](https://docs.gitlab.com/ce/api/deployments.html).
- deployments
```perl
my $deployments = $api->deployments(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/deployments` and returns the decoded response content.
- deployment
```perl
my $deployment = $api->deployment(
$project_id,
$deployment_id,
);
```
Sends a `GET` request to `projects/:project_id/deployments/:deployment_id` and returns the decoded response content.
## Deploy Keys
See [https://docs.gitlab.com/ce/api/deploy\_keys.html](https://docs.gitlab.com/ce/api/deploy_keys.html).
- all\_deploy\_keys
```perl
my $keys = $api->all_deploy_keys(
\%params,
);
```
Sends a `GET` request to `deploy_keys` and returns the decoded response content.
- deploy\_keys
```perl
my $keys = $api->deploy_keys(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/deploy_keys` and returns the decoded response content.
- deploy\_key
```perl
my $key = $api->deploy_key(
$project_id,
$key_id,
);
```
Sends a `GET` request to `projects/:project_id/deploy_keys/:key_id` and returns the decoded response content.
- create\_deploy\_key
```perl
my $key = $api->create_deploy_key(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/deploy_keys` and returns the decoded response content.
- delete\_deploy\_key
```
$api->delete_deploy_key(
$project_id,
$key_id,
);
```
Sends a `DELETE` request to `projects/:project_id/deploy_keys/:key_id`.
- enable\_deploy\_key
```perl
my $key = $api->enable_deploy_key(
$project_id,
$key_id,
);
```
Sends a `POST` request to `projects/:project_id/deploy_keys/:key_id/enable` and returns the decoded response content.
## Environments
See [https://docs.gitlab.com/ce/api/environments.html](https://docs.gitlab.com/ce/api/environments.html).
- environments
```perl
my $environments = $api->environments(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/environments` and returns the decoded response content.
- create\_environment
```perl
my $environment = $api->create_environment(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/environments` and returns the decoded response content.
- edit\_environment
```perl
my $environment = $api->edit_environment(
$project_id,
$environments_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/environments/:environments_id` and returns the decoded response content.
- delete\_environment
```
$api->delete_environment(
$project_id,
$environment_id,
);
```
Sends a `DELETE` request to `projects/:project_id/environments/:environment_id`.
- stop\_environment
```perl
my $environment = $api->stop_environment(
$project_id,
$environment_id,
);
```
Sends a `POST` request to `projects/:project_id/environments/:environment_id/stop` and returns the decoded response content.
## Events
See [https://docs.gitlab.com/ce/api/events.html](https://docs.gitlab.com/ce/api/events.html).
- all\_events
```perl
my $events = $api->all_events(
\%params,
);
```
Sends a `GET` request to `events` and returns the decoded response content.
- user\_events
```perl
my $events = $api->user_events(
$user_id,
\%params,
);
```
Sends a `GET` request to `users/:user_id/events` and returns the decoded response content.
- project\_events
```perl
my $events = $api->project_events(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/events` and returns the decoded response content.
## Feature flags
See [https://docs.gitlab.com/ce/api/features.html](https://docs.gitlab.com/ce/api/features.html).
- features
```perl
my $features = $api->features();
```
Sends a `GET` request to `features` and returns the decoded response content.
- set\_feature
```perl
my $feature = $api->set_feature(
$name,
\%params,
);
```
Sends a `POST` request to `features/:name` and returns the decoded response content.
## Gitignores
See [https://docs.gitlab.com/ce/api/templates/gitignores.html](https://docs.gitlab.com/ce/api/templates/gitignores.html).
- gitignores\_templates
```perl
my $templates = $api->gitignores_templates(
\%params,
);
```
Sends a `GET` request to `templates/gitignores` and returns the decoded response content.
- gitignores\_template
```perl
my $template = $api->gitignores_template(
$template_key,
);
```
Sends a `GET` request to `templates/gitignores/:template_key` and returns the decoded response content.
## GitLab CI YMLs
See [https://docs.gitlab.com/ce/api/templates/gitlab\_ci\_ymls.html](https://docs.gitlab.com/ce/api/templates/gitlab_ci_ymls.html).
- gitlab\_ci\_ymls\_templates
```perl
my $templates = $api->gitlab_ci_ymls_templates(
\%params,
);
```
Sends a `GET` request to `templates/gitlab_ci_ymls` and returns the decoded response content.
- gitlab\_ci\_ymls\_template
```perl
my $template = $api->gitlab_ci_ymls_template(
$template_key,
);
```
Sends a `GET` request to `templates/gitlab_ci_ymls/:template_key` and returns the decoded response content.
## Groups
See [https://docs.gitlab.com/ce/api/groups.html](https://docs.gitlab.com/ce/api/groups.html).
- groups
```perl
my $groups = $api->groups(
\%params,
);
```
Sends a `GET` request to `groups` and returns the decoded response content.
- group\_subgroups
```perl
my $subgroups = $api->group_subgroups(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/subgroups` and returns the decoded response content.
- group\_projects
```perl
my $projects = $api->group_projects(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/projects` and returns the decoded response content.
- group
```perl
my $group = $api->group(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id` and returns the decoded response content.
- create\_group
```
$api->create_group(
\%params,
);
```
Sends a `POST` request to `groups`.
- transfer\_project\_to\_group
```
$api->transfer_project_to_group(
$group_id,
$project_id,
);
```
Sends a `POST` request to `groups/:group_id/projects/:project_id`.
- edit\_group
```perl
my $group = $api->edit_group(
$group_id,
\%params,
);
```
Sends a `PUT` request to `groups/:group_id` and returns the decoded response content.
- delete\_group
```
$api->delete_group(
$group_id,
);
```
Sends a `DELETE` request to `groups/:group_id`.
- sync\_group\_with\_ldap
```
$api->sync_group_with_ldap(
$group_id,
);
```
Sends a `POST` request to `groups/:group_id/ldap_sync`.
- create\_ldap\_group\_link
```
$api->create_ldap_group_link(
$group_id,
\%params,
);
```
Sends a `POST` request to `groups/:group_id/ldap_group_links`.
- delete\_ldap\_group\_link
```
$api->delete_ldap_group_link(
$group_id,
$cn,
);
```
Sends a `DELETE` request to `groups/:group_id/ldap_group_links/:cn`.
- delete\_ldap\_provider\_group\_link
```
$api->delete_ldap_provider_group_link(
$group_id,
$provider,
$cn,
);
```
Sends a `DELETE` request to `groups/:group_id/ldap_group_links/:provider/:cn`.
## Group access requests
See [https://docs.gitlab.com/ce/api/access\_requests.html](https://docs.gitlab.com/ce/api/access_requests.html).
- group\_access\_requests
```perl
my $requests = $api->group_access_requests(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/access_requests` and returns the decoded response content.
- request\_group\_access
```perl
my $request = $api->request_group_access(
$group_id,
);
```
Sends a `POST` request to `groups/:group_id/access_requests` and returns the decoded response content.
- approve\_group\_access
```perl
my $request = $api->approve_group_access(
$group_id,
$user_id,
);
```
Sends a `PUT` request to `groups/:group_id/access_requests/:user_id/approve` and returns the decoded response content.
- deny\_group\_access
```perl
$api->deny_group_access(
$group_id,
$user_id,
);
```
Sends a `DELETE` request to `groups/:group_id/access_requests/:user_id`.
## Group badges
See [https://docs.gitlab.com/ce/api/group\_badges.html](https://docs.gitlab.com/ce/api/group_badges.html).
- group\_badges
```perl
my $badges = $api->group_badges(
$group_id,
);
```
Sends a `GET` request to `groups/:group_id/badges` and returns the decoded response content.
- group\_badge
```perl
my $badge = $api->group_badge(
$group_id,
$badge_id,
);
```
Sends a `GET` request to `groups/:group_id/badges/:badge_id` and returns the decoded response content.
- create\_group\_badge
```perl
my $badge = $api->create_group_badge(
$group_id,
\%params,
);
```
Sends a `POST` request to `groups/:group_id/badges` and returns the decoded response content.
- edit\_group\_badge
```perl
my $badge = $api->edit_group_badge(
$group_id,
$badge_id,
\%params,
);
```
Sends a `PUT` request to `groups/:group_id/badges/:badge_id` and returns the decoded response content.
- delete\_group\_badge
```
$api->delete_group_badge(
$group_id,
$badge_id,
);
```
Sends a `DELETE` request to `groups/:group_id/badges/:badge_id`.
- preview\_group\_badge
```perl
my $preview = $api->preview_group_badge(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/badges/render` and returns the decoded response content.
## Group members
See [https://docs.gitlab.com/ce/api/members.html](https://docs.gitlab.com/ce/api/members.html).
- group\_members
```perl
my $members = $api->group_members(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/members` and returns the decoded response content.
- all\_group\_members
```perl
my $members = $api->all_group_members(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/members/all` and returns the decoded response content.
- group\_member
```perl
my $member = $api->group_member(
$project_id,
$user_id,
);
```
Sends a `GET` request to `groups/:project_id/members/:user_id` and returns the decoded response content.
- add\_group\_member
```perl
my $member = $api->add_group_member(
$group_id,
\%params,
);
```
Sends a `POST` request to `groups/:group_id/members` and returns the decoded response content.
- update\_group\_member
```perl
my $member = $api->update_group_member(
$group_id,
$user_id,
\%params,
);
```
Sends a `PUT` request to `groups/:group_id/members/:user_id` and returns the decoded response content.
- remove\_group\_member
```perl
$api->remove_group_member(
$group_id,
$user_id,
);
```
Sends a `DELETE` request to `groups/:group_id/members/:user_id`.
## Issues
See [https://docs.gitlab.com/ce/api/issues.html](https://docs.gitlab.com/ce/api/issues.html).
- global\_issues
```perl
my $issues = $api->global_issues(
\%params,
);
```
Sends a `GET` request to `issues` and returns the decoded response content.
- group\_issues
```perl
my $issues = $api->group_issues(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/issues` and returns the decoded response content.
- issues
```perl
my $issues = $api->issues(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/issues` and returns the decoded response content.
- issue
```perl
my $issue = $api->issue(
$project_id,
$issue_iid,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid` and returns the decoded response content.
- create\_issue
```perl
my $issue = $api->create_issue(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/issues` and returns the decoded response content.
- edit\_issue
```perl
my $issue = $api->edit_issue(
$project_id,
$issue_iid,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/issues/:issue_iid` and returns the decoded response content.
- delete\_issue
```
$api->delete_issue(
$project_id,
$issue_iid,
);
```
Sends a `DELETE` request to `projects/:project_id/issues/:issue_iid`.
- move\_issue
```perl
my $issue = $api->move_issue(
$project_id,
$issue_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/move` and returns the decoded response content.
- subscribe\_to\_issue
```perl
my $issue = $api->subscribe_to_issue(
$project_id,
$issue_iid,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/subscribe` and returns the decoded response content.
- unsubscribe\_from\_issue
```perl
my $issue = $api->unsubscribe_from_issue(
$project_id,
$issue_iid,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/unsubscribe` and returns the decoded response content.
- create\_issue\_todo
```perl
my $todo = $api->create_issue_todo(
$project_id,
$issue_iid,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/todo` and returns the decoded response content.
- set\_issue\_time\_estimate
```perl
my $tracking = $api->set_issue_time_estimate(
$project_id,
$issue_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/time_estimate` and returns the decoded response content.
- reset\_issue\_time\_estimate
```perl
my $tracking = $api->reset_issue_time_estimate(
$project_id,
$issue_iid,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/reset_time_estimate` and returns the decoded response content.
- add\_issue\_spent\_time
```perl
my $tracking = $api->add_issue_spent_time(
$project_id,
$issue_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/add_spent_time` and returns the decoded response content.
- reset\_issue\_spent\_time
```perl
my $tracking = $api->reset_issue_spent_time(
$project_id,
$issue_iid,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/reset_spent_time` and returns the decoded response content.
- issue\_time\_stats
```perl
my $tracking = $api->issue_time_stats(
$project_id,
$issue_iid,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/time_stats` and returns the decoded response content.
- issue\_closed\_by
```perl
my $merge_requests = $api->issue_closed_by(
$project_id,
$issue_iid,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/closed_by` and returns the decoded response content.
- issue\_user\_agent\_detail
```perl
my $user_agent = $api->issue_user_agent_detail(
$project_id,
$issue_iid,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/user_agent_detail` and returns the decoded response content.
## Issue Boards
See [https://docs.gitlab.com/ce/api/boards.html](https://docs.gitlab.com/ce/api/boards.html).
- project\_boards
```perl
my $boards = $api->project_boards(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/boards` and returns the decoded response content.
- project\_board\_lists
```perl
my $lists = $api->project_board_lists(
$project_id,
$board_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/boards/:board_id/lists` and returns the decoded response content.
- project\_board\_list
```perl
my $list = $api->project_board_list(
$project_id,
$board_id,
$list_id,
);
```
Sends a `GET` request to `projects/:project_id/boards/:board_id/lists/:list_id` and returns the decoded response content.
- create\_project\_board\_list
```perl
my $list = $api->create_project_board_list(
$project_id,
$board_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/boards/:board_id/lists` and returns the decoded response content.
- edit\_project\_board\_list
```perl
my $list = $api->edit_project_board_list(
$project_id,
$board_id,
$list_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/boards/:board_id/lists/:list_id` and returns the decoded response content.
- delete\_project\_board\_list
```
$api->delete_project_board_list(
$project_id,
$board_id,
$list_id,
);
```
Sends a `DELETE` request to `projects/:project_id/boards/:board_id/lists/:list_id`.
## Group Issue Boards
See [https://docs.gitlab.com/ce/api/group\_boards.html](https://docs.gitlab.com/ce/api/group_boards.html).
- group\_boards
```perl
my $boards = $api->group_boards(
$group_id,
);
```
Sends a `GET` request to `groups/:group_id/boards` and returns the decoded response content.
- group\_board
```perl
my $board = $api->group_board(
$group_id,
$board_id,
);
```
Sends a `GET` request to `groups/:group_id/boards/:board_id` and returns the decoded response content.
- group\_board\_lists
```perl
my $lists = $api->group_board_lists(
$group_id,
$board_id,
);
```
Sends a `GET` request to `groups/:group_id/boards/:board_id/lists` and returns the decoded response content.
- group\_board\_list
```perl
my $list = $api->group_board_list(
$group_id,
$board_id,
$list_id,
);
```
Sends a `GET` request to `groups/:group_id/boards/:board_id/lists/:list_id` and returns the decoded response content.
- create\_group\_board\_list
```perl
my $list = $api->create_group_board_list(
$group_id,
$board_id,
\%params,
);
```
Sends a `POST` request to `groups/:group_id/boards/:board_id/lists` and returns the decoded response content.
- edit\_group\_board\_list
```perl
my $list = $api->edit_group_board_list(
$group_id,
$board_id,
$list_id,
\%params,
);
```
Sends a `PUT` request to `groups/:group_id/boards/:board_id/lists/:list_id` and returns the decoded response content.
- delete\_group\_board\_list
```
$api->delete_group_board_list(
$group_id,
$board_id,
$list_id,
);
```
Sends a `DELETE` request to `groups/:group_id/boards/:board_id/lists/:list_id`.
## Jobs
See [https://docs.gitlab.com/ce/api/jobs.html](https://docs.gitlab.com/ce/api/jobs.html).
- jobs
```perl
my $jobs = $api->jobs(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/jobs` and returns the decoded response content.
- pipeline\_jobs
```perl
my $jobs = $api->pipeline_jobs(
$project_id,
$pipeline_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/pipelines/:pipeline_id/jobs` and returns the decoded response content.
- job
```perl
my $job = $api->job(
$project_id,
$job_id,
);
```
Sends a `GET` request to `projects/:project_id/jobs/:job_id` and returns the decoded response content.
- job\_artifacts
```perl
my $artifacts = $api->job_artifacts(
$project_id,
$job_id,
);
```
Sends a `GET` request to `projects/:project_id/jobs/:job_id/artifacts` and returns the decoded response content.
- job\_artifacts\_archive
```perl
my $archive = $api->job_artifacts_archive(
$project_id,
$ref_name,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/jobs/artifacts/:ref_name/download` and returns the decoded response content.
- job\_artifacts\_file
```perl
my $file = $api->job_artifacts_file(
$project_id,
$job_id,
$artifact_path,
);
```
Sends a `GET` request to `projects/:project_id/jobs/:job_id/artifacts/:artifact_path` and returns the decoded response content.
- job\_trace\_file
```perl
my $file = $api->job_trace_file(
$project_id,
$job_id,
);
```
Sends a `GET` request to `projects/:project_id/jobs/:job_id/trace` and returns the decoded response content.
- cancel\_job
```perl
my $job = $api->cancel_job(
$project_id,
$job_id,
);
```
Sends a `POST` request to `projects/:project_id/jobs/:job_id/cancel` and returns the decoded response content.
- retry\_job
```perl
my $job = $api->retry_job(
$project_id,
$job_id,
);
```
Sends a `POST` request to `projects/:project_id/jobs/:job_id/retry` and returns the decoded response content.
- erase\_job
```perl
my $job = $api->erase_job(
$project_id,
$job_id,
);
```
Sends a `POST` request to `projects/:project_id/jobs/:job_id/erase` and returns the decoded response content.
- keep\_job\_artifacts
```perl
my $job = $api->keep_job_artifacts(
$project_id,
$job_id,
);
```
Sends a `POST` request to `projects/:project_id/jobs/:job_id/artifacts/keep` and returns the decoded response content.
- play\_job
```perl
my $job = $api->play_job(
$project_id,
$job_id,
);
```
Sends a `POST` request to `projects/:project_id/jobs/:job_id/play` and returns the decoded response content.
## Keys
See [https://docs.gitlab.com/ce/api/keys.html](https://docs.gitlab.com/ce/api/keys.html).
- key
```perl
my $key = $api->key(
$key_id,
);
```
Sends a `GET` request to `keys/:key_id` and returns the decoded response content.
## Labels
See [https://docs.gitlab.com/ce/api/labels.html](https://docs.gitlab.com/ce/api/labels.html).
- labels
```perl
my $labels = $api->labels(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/labels` and returns the decoded response content.
- create\_label
```perl
my $label = $api->create_label(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/labels` and returns the decoded response content.
- delete\_label
```
$api->delete_label(
$project_id,
\%params,
);
```
Sends a `DELETE` request to `projects/:project_id/labels`.
- edit\_label
```perl
my $label = $api->edit_label(
$project_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/labels` and returns the decoded response content.
- subscribe\_to\_label
```perl
my $label = $api->subscribe_to_label(
$project_id,
$label_id,
);
```
Sends a `POST` request to `projects/:project_id/labels/:label_id/subscribe` and returns the decoded response content.
- unsubscribe\_from\_label
```perl
$api->unsubscribe_from_label(
$project_id,
$label_id,
);
```
Sends a `POST` request to `projects/:project_id/labels/:label_id/unsubscribe`.
## Markdown
See [https://docs.gitlab.com/ce/api/markdown.html](https://docs.gitlab.com/ce/api/markdown.html).
- markdown
```perl
my $html = $api->markdown(
\%params,
);
```
Sends a `POST` request to `markdown` and returns the decoded response content.
## Merge requests
See [https://docs.gitlab.com/ce/api/merge\_requests.html](https://docs.gitlab.com/ce/api/merge_requests.html).
- global\_merge\_requests
```perl
my $merge_requests = $api->global_merge_requests(
\%params,
);
```
Sends a `GET` request to `merge_requests` and returns the decoded response content.
- merge\_requests
```perl
my $merge_requests = $api->merge_requests(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests` and returns the decoded response content.
- merge\_request
```perl
my $merge_request = $api->merge_request(
$project_id,
$merge_request_iid,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid` and returns the decoded response content.
- merge\_request\_commits
```perl
my $commits = $api->merge_request_commits(
$project_id,
$merge_request_iid,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/commits` and returns the decoded response content.
- merge\_request\_with\_changes
```perl
my $merge_request = $api->merge_request_with_changes(
$project_id,
$merge_request_iid,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/changes` and returns the decoded response content.
- create\_merge\_request
```perl
my $merge_request = $api->create_merge_request(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests` and returns the decoded response content.
- edit\_merge\_request
```perl
my $merge_request = $api->edit_merge_request(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/merge_requests/:merge_request_iid` and returns the decoded response content.
- delete\_merge\_request
```
$api->delete_merge_request(
$project_id,
$merge_request_iid,
);
```
Sends a `DELETE` request to `projects/:project_id/merge_requests/:merge_request_iid`.
- accept\_merge\_request
```perl
my $merge_request = $api->accept_merge_request(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/merge_requests/:merge_request_iid/merge` and returns the decoded response content.
- cancel\_merge\_when\_pipeline\_succeeds
```perl
my $merge_request = $api->cancel_merge_when_pipeline_succeeds(
$project_id,
$merge_request_iid,
);
```
Sends a `PUT` request to `projects/:project_id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds` and returns the decoded response content.
- merge\_request\_closes\_issues
```perl
my $issues = $api->merge_request_closes_issues(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/closes_issues` and returns the decoded response content.
- subscribe\_to\_merge\_request
```perl
my $merge_request = $api->subscribe_to_merge_request(
$project_id,
$merge_request_iid,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/subscribe` and returns the decoded response content.
- unsubscribe\_from\_merge\_request
```perl
my $merge_request = $api->unsubscribe_from_merge_request(
$project_id,
$merge_request_iid,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/unsubscribe` and returns the decoded response content.
- create\_merge\_request\_todo
```perl
my $todo = $api->create_merge_request_todo(
$project_id,
$merge_request_iid,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/todo` and returns the decoded response content.
- merge\_request\_diff\_versions
```perl
my $versions = $api->merge_request_diff_versions(
$project_id,
$merge_request_iid,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/versions` and returns the decoded response content.
- merge\_request\_diff\_version
```perl
my $version = $api->merge_request_diff_version(
$project_id,
$merge_request_iid,
$version_id,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/versions/:version_id` and returns the decoded response content.
- set\_merge\_request\_time\_estimate
```perl
my $tracking = $api->set_merge_request_time_estimate(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/time_estimate` and returns the decoded response content.
- reset\_merge\_request\_time\_estimate
```perl
my $tracking = $api->reset_merge_request_time_estimate(
$project_id,
$merge_request_iid,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/reset_time_estimate` and returns the decoded response content.
- add\_merge\_request\_spent\_time
```perl
my $tracking = $api->add_merge_request_spent_time(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/add_spent_time` and returns the decoded response content.
- reset\_merge\_request\_spent\_time
```perl
my $tracking = $api->reset_merge_request_spent_time(
$project_id,
$merge_request_iid,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/reset_spent_time` and returns the decoded response content.
- merge\_request\_time\_stats
```perl
my $tracking = $api->merge_request_time_stats(
$project_id,
$merge_request_iid,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/time_stats` and returns the decoded response content.
## Milestones
See [https://docs.gitlab.com/ce/api/milestones.html](https://docs.gitlab.com/ce/api/milestones.html).
- project\_milestones
```perl
my $milestones = $api->project_milestones(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/milestones` and returns the decoded response content.
- project\_milestone
```perl
my $milestone = $api->project_milestone(
$project_id,
$milestone_id,
);
```
Sends a `GET` request to `projects/:project_id/milestones/:milestone_id` and returns the decoded response content.
- create\_project\_milestone
```perl
my $milestone = $api->create_project_milestone(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/milestones` and returns the decoded response content.
- edit\_project\_milestone
```perl
my $milestone = $api->edit_project_milestone(
$project_id,
$milestone_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/milestones/:milestone_id` and returns the decoded response content.
- project\_milestone\_issues
```perl
my $issues = $api->project_milestone_issues(
$project_id,
$milestone_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/milestones/:milestone_id/issues` and returns the decoded response content.
- project\_milestone\_merge\_requests
```perl
my $merge_requests = $api->project_milestone_merge_requests(
$project_id,
$milestone_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/milestones/:milestone_id/merge_requests` and returns the decoded response content.
## Group milestones
See [https://docs.gitlab.com/ce/api/group\_milestones.html](https://docs.gitlab.com/ce/api/group_milestones.html).
- group\_milestones
```perl
my $milestones = $api->group_milestones(
$group_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/milestones` and returns the decoded response content.
- group\_milestone
```perl
my $milestone = $api->group_milestone(
$group_id,
$milestone_id,
);
```
Sends a `GET` request to `groups/:group_id/milestones/:milestone_id` and returns the decoded response content.
- create\_group\_milestone
```perl
my $milestone = $api->create_group_milestone(
$group_id,
\%params,
);
```
Sends a `POST` request to `groups/:group_id/milestones` and returns the decoded response content.
- edit\_group\_milestone
```perl
my $milestone = $api->edit_group_milestone(
$group_id,
$milestone_id,
\%params,
);
```
Sends a `PUT` request to `groups/:group_id/milestones/:milestone_id` and returns the decoded response content.
- group\_milestone\_issues
```perl
my $issues = $api->group_milestone_issues(
$group_id,
$milestone_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/milestones/:milestone_id/issues` and returns the decoded response content.
- group\_milestone\_merge\_requests
```perl
my $merge_requests = $api->group_milestone_merge_requests(
$group_id,
$milestone_id,
\%params,
);
```
Sends a `GET` request to `groups/:group_id/milestones/:milestone_id/merge_requests` and returns the decoded response content.
## Namespaces
See [https://docs.gitlab.com/ce/api/namespaces.html](https://docs.gitlab.com/ce/api/namespaces.html).
- namespaces
```perl
my $namespaces = $api->namespaces(
\%params,
);
```
Sends a `GET` request to `namespaces` and returns the decoded response content.
- namespace
```perl
my $namespace = $api->namespace(
$namespace_id,
);
```
Sends a `GET` request to `namespaces/:namespace_id` and returns the decoded response content.
## Notes
See [https://docs.gitlab.com/ce/api/notes.html](https://docs.gitlab.com/ce/api/notes.html).
- issue\_notes
```perl
my $notes = $api->issue_notes(
$project_id,
$issue_iid,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/notes` and returns the decoded response content.
- issue\_note
```perl
my $note = $api->issue_note(
$project_id,
$issue_iid,
$note_id,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/notes/:note_id` and returns the decoded response content.
- create\_issue\_note
```perl
my $note = $api->create_issue_note(
$project_id,
$issue_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/notes` and returns the decoded response content.
- edit\_issue\_note
```
$api->edit_issue_note(
$project_id,
$issue_iid,
$note_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/issues/:issue_iid/notes/:note_id`.
- delete\_issue\_note
```
$api->delete_issue_note(
$project_id,
$issue_iid,
$note_id,
);
```
Sends a `DELETE` request to `projects/:project_id/issues/:issue_iid/notes/:note_id`.
- snippet\_notes
```perl
my $notes = $api->snippet_notes(
$project_id,
$snippet_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/snippets/:snippet_id/notes` and returns the decoded response content.
- snippet\_note
```perl
my $note = $api->snippet_note(
$project_id,
$snippet_id,
$note_id,
);
```
Sends a `GET` request to `projects/:project_id/snippets/:snippet_id/notes/:note_id` and returns the decoded response content.
- create\_snippet\_note
```perl
my $note = $api->create_snippet_note(
$project_id,
$snippet_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/snippets/:snippet_id/notes` and returns the decoded response content.
- edit\_snippet\_note
```
$api->edit_snippet_note(
$project_id,
$snippet_id,
$note_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/snippets/:snippet_id/notes/:note_id`.
- delete\_snippet\_note
```
$api->delete_snippet_note(
$project_id,
$snippet_id,
$note_id,
);
```
Sends a `DELETE` request to `projects/:project_id/snippets/:snippet_id/notes/:note_id`.
- merge\_request\_notes
```perl
my $notes = $api->merge_request_notes(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/notes` and returns the decoded response content.
- merge\_request\_note
```perl
my $note = $api->merge_request_note(
$project_id,
$merge_request_iid,
$note_id,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/notes/:note_id` and returns the decoded response content.
- create\_merge\_request\_note
```perl
my $note = $api->create_merge_request_note(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/notes` and returns the decoded response content.
- edit\_merge\_request\_note
```
$api->edit_merge_request_note(
$project_id,
$merge_request_iid,
$note_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/merge_requests/:merge_request_iid/notes/:note_id`.
- delete\_merge\_request\_note
```
$api->delete_merge_request_note(
$project_id,
$merge_request_iid,
$note_id,
);
```
Sends a `DELETE` request to `projects/:project_id/merge_requests/:merge_request_iid/notes/:note_id`.
## Discussions
See [https://docs.gitlab.com/ce/api/discussions.html](https://docs.gitlab.com/ce/api/discussions.html).
- issue\_discussions
```perl
my $discussions = $api->issue_discussions(
$project_id,
$issue_iid,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/discussions` and returns the decoded response content.
- issue\_discussion
```perl
my $discussion = $api->issue_discussion(
$project_id,
$issue_iid,
$discussion_id,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/discussions/:discussion_id` and returns the decoded response content.
- create\_issue\_discussion
```perl
my $discussion = $api->create_issue_discussion(
$project_id,
$issue_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/discussions` and returns the decoded response content.
- create\_issue\_discussion\_note
```
$api->create_issue_discussion_note(
$project_id,
$issue_iid,
$discussion_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/issues/:issue_iid/discussions/:discussion_id/notes`.
- edit\_issue\_discussion\_note
```
$api->edit_issue_discussion_note(
$project_id,
$issue_iid,
$discussion_id,
$note_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/issues/:issue_iid/discussions/:discussion_id/notes/:note_id`.
- delete\_issue\_discussion\_note
```
$api->delete_issue_discussion_note(
$project_id,
$issue_iid,
$discussion_id,
$note_id,
);
```
Sends a `DELETE` request to `projects/:project_id/issues/:issue_iid/discussions/:discussion_id/notes/:note_id`.
- project\_snippet\_discussions
```perl
my $discussions = $api->project_snippet_discussions(
$project_id,
$snippet_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/snippets/:snippet_id/discussions` and returns the decoded response content.
- project\_snippet\_discussion
```perl
my $discussion = $api->project_snippet_discussion(
$project_id,
$snippet_id,
$discussion_id,
);
```
Sends a `GET` request to `projects/:project_id/snippets/:snippet_id/discussions/:discussion_id` and returns the decoded response content.
- create\_project\_snippet\_discussion
```perl
my $discussion = $api->create_project_snippet_discussion(
$project_id,
$snippet_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/snippets/:snippet_id/discussions` and returns the decoded response content.
- create\_project\_snippet\_discussion\_note
```
$api->create_project_snippet_discussion_note(
$project_id,
$snippet_id,
$discussion_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/snippets/:snippet_id/discussions/:discussion_id/notes`.
- edit\_project\_snippet\_discussion\_note
```
$api->edit_project_snippet_discussion_note(
$project_id,
$snippet_id,
$discussion_id,
$note_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/snippets/:snippet_id/discussions/:discussion_id/notes/:note_id`.
- delete\_project\_snippet\_discussion\_note
```
$api->delete_project_snippet_discussion_note(
$project_id,
$snippet_id,
$discussion_id,
$note_id,
);
```
Sends a `DELETE` request to `projects/:project_id/snippets/:snippet_id/discussions/:discussion_id/notes/:note_id`.
- merge\_request\_discussions
```perl
my $discussions = $api->merge_request_discussions(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/discussions` and returns the decoded response content.
- merge\_request\_discussion
```perl
my $discussion = $api->merge_request_discussion(
$project_id,
$merge_request_iid,
$discussion_id,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/discussions/:discussion_id` and returns the decoded response content.
- create\_merge\_request\_discussion
```perl
my $discussion = $api->create_merge_request_discussion(
$project_id,
$merge_request_iid,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/discussions` and returns the decoded response content.
- resolve\_merge\_request\_discussion
```
$api->resolve_merge_request_discussion(
$project_id,
$merge_request_iid,
$discussion_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/merge_requests/:merge_request_iid/discussions/:discussion_id`.
- create\_merge\_request\_discussion\_note
```
$api->create_merge_request_discussion_note(
$project_id,
$merge_request_iid,
$discussion_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes`.
- edit\_merge\_request\_discussion\_note
```
$api->edit_merge_request_discussion_note(
$project_id,
$merge_request_iid,
$discussion_id,
$note_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes/:note_id`.
- delete\_merge\_request\_discussion\_note
```
$api->delete_merge_request_discussion_note(
$project_id,
$merge_request_iid,
$discussion_id,
$note_id,
);
```
Sends a `DELETE` request to `projects/:project_id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes/:note_id`.
- commit\_discussions
```perl
my $discussions = $api->commit_discussions(
$project_id,
$commit_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/commits/:commit_id/discussions` and returns the decoded response content.
- commit\_discussion
```perl
my $discussion = $api->commit_discussion(
$project_id,
$commit_id,
$discussion_id,
);
```
Sends a `GET` request to `projects/:project_id/commits/:commit_id/discussions/:discussion_id` and returns the decoded response content.
- create\_commit\_discussion
```perl
my $discussion = $api->create_commit_discussion(
$project_id,
$commit_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/commits/:commit_id/discussions` and returns the decoded response content.
- create\_commit\_discussion\_note
```
$api->create_commit_discussion_note(
$project_id,
$commit_id,
$discussion_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/commits/:commit_id/discussions/:discussion_id/notes`.
- edit\_commit\_discussion\_note
```
$api->edit_commit_discussion_note(
$project_id,
$commit_id,
$discussion_id,
$note_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/commits/:commit_id/discussions/:discussion_id/notes/:note_id`.
- delete\_commit\_discussion\_note
```
$api->delete_commit_discussion_note(
$project_id,
$commit_id,
$discussion_id,
$note_id,
);
```
Sends a `DELETE` request to `projects/:project_id/commits/:commit_id/discussions/:discussion_id/notes/:note_id`.
## Resource label events
See [https://docs.gitlab.com/ce/api/resource\_label\_events.html](https://docs.gitlab.com/ce/api/resource_label_events.html).
- issue\_resource\_label\_events
```perl
my $events = $api->issue_resource_label_events(
$project_id,
$issue_iid,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/resource_label_events` and returns the decoded response content.
- issue\_resource\_label\_event
```perl
my $event = $api->issue_resource_label_event(
$project_id,
$issue_iid,
$resource_label_event_id,
);
```
Sends a `GET` request to `projects/:project_id/issues/:issue_iid/resource_label_events/:resource_label_event_id` and returns the decoded response content.
- merge\_request\_resource\_label\_events
```perl
my $events = $api->merge_request_resource_label_events(
$project_id,
$merge_request_iid,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/resource_label_events` and returns the decoded response content.
- merge\_request\_resource\_label\_event
```perl
my $event = $api->merge_request_resource_label_event(
$project_id,
$merge_request_iid,
$resource_label_event_id,
);
```
Sends a `GET` request to `projects/:project_id/merge_requests/:merge_request_iid/resource_label_events/:resource_label_event_id` and returns the decoded response content.
## Notification settings
See [https://docs.gitlab.com/ce/api/notification\_settings.html](https://docs.gitlab.com/ce/api/notification_settings.html).
- global\_notification\_settings
```perl
my $settings = $api->global_notification_settings();
```
Sends a `GET` request to `notification_settings` and returns the decoded response content.
- set\_global\_notification\_settings
```perl
my $settings = $api->set_global_notification_settings(
\%params,
);
```
Sends a `PUT` request to `notification_settings` and returns the decoded response content.
- group\_notification\_settings
```perl
my $settings = $api->group_notification_settings(
$group_id,
);
```
Sends a `GET` request to `groups/:group_id/notification_settings` and returns the decoded response content.
- project\_notification\_settings
```perl
my $settings = $api->project_notification_settings(
$project_id,
);
```
Sends a `GET` request to `projects/:project_id/notification_settings` and returns the decoded response content.
- set\_group\_notification\_settings
```perl
my $settings = $api->set_group_notification_settings(
$group_id,
\%params,
);
```
Sends a `PUT` request to `groups/:group_id/notification_settings` and returns the decoded response content.
- set\_project\_notification\_settings
```perl
my $settings = $api->set_project_notification_settings(
$project_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/notification_settings` and returns the decoded response content.
## Licenses
See [https://docs.gitlab.com/ce/api/templates/licenses.html](https://docs.gitlab.com/ce/api/templates/licenses.html).
- license\_templates
```perl
my $templates = $api->license_templates(
\%params,
);
```
Sends a `GET` request to `templates/licenses` and returns the decoded response content.
- license\_template
```perl
my $template = $api->license_template(
$template_key,
\%params,
);
```
Sends a `GET` request to `templates/licenses/:template_key` and returns the decoded response content.
## Pages domains
See [https://docs.gitlab.com/ce/api/pages\_domains.html](https://docs.gitlab.com/ce/api/pages_domains.html).
- global\_pages\_domains
```perl
my $domains = $api->global_pages_domains(
\%params,
);
```
Sends a `GET` request to `pages/domains` and returns the decoded response content.
- pages\_domains
```perl
my $domains = $api->pages_domains(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/pages/domains` and returns the decoded response content.
- pages\_domain
```perl
my $domain = $api->pages_domain(
$project_id,
$domain,
);
```
Sends a `GET` request to `projects/:project_id/pages/domains/:domain` and returns the decoded response content.
- create\_pages\_domain
```perl
my $domain = $api->create_pages_domain(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/pages/domains` and returns the decoded response content.
- edit\_pages\_domain
```perl
my $domain = $api->edit_pages_domain(
$project_id,
$domain,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/pages/domains/:domain` and returns the decoded response content.
- delete\_pages\_domain
```
$api->delete_pages_domain(
$project_id,
$domain,
);
```
Sends a `DELETE` request to `projects/:project_id/pages/domains/:domain`.
## Pipelines
See [https://docs.gitlab.com/ce/api/pipelines.html](https://docs.gitlab.com/ce/api/pipelines.html).
- pipelines
```perl
my $pipelines = $api->pipelines(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/pipelines` and returns the decoded response content.
- pipeline
```perl
my $pipeline = $api->pipeline(
$project_id,
$pipeline_id,
);
```
Sends a `GET` request to `projects/:project_id/pipelines/:pipeline_id` and returns the decoded response content.
- create\_pipeline
```perl
my $pipeline = $api->create_pipeline(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/pipeline` and returns the decoded response content.
Git ref (branch or tag) name must be specified in the `ref` field of the
`%params` hash. It's also possible to pass variables to a pipeline in
the `variables` field like in the following example:
```perl
my $pipeline = $api->create_pipeline(
$project_id,
{
'ref' => 'master',
variables => [
{ 'key' => 'VARIABLE1', 'value' => 'VALUE1' },
{ 'key' => 'VARIABLE2', 'value' => 'VALUE2' },
],
},
);
```
- retry\_pipeline\_jobs
```perl
my $pipeline = $api->retry_pipeline_jobs(
$project_id,
$pipeline_id,
);
```
Sends a `POST` request to `projects/:project_id/pipelines/:pipeline_id/retry` and returns the decoded response content.
- cancel\_pipeline\_jobs
```perl
my $pipeline = $api->cancel_pipeline_jobs(
$project_id,
$pipeline_id,
);
```
Sends a `POST` request to `projects/:project_id/pipelines/:pipeline_id/cancel` and returns the decoded response content.
- delete\_pipeline
```
$api->delete_pipeline(
$project_id,
$pipeline_id,
);
```
Sends a `DELETE` request to `projects/:project_id/pipelines/:pipeline_id`.
## Pipeline triggers
See [https://docs.gitlab.com/ce/api/pipeline\_triggers.html](https://docs.gitlab.com/ce/api/pipeline_triggers.html).
- triggers
```perl
my $triggers = $api->triggers(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/triggers` and returns the decoded response content.
- trigger
```perl
my $trigger = $api->trigger(
$project_id,
$trigger_id,
);
```
Sends a `GET` request to `projects/:project_id/triggers/:trigger_id` and returns the decoded response content.
- create\_trigger
```perl
my $trigger = $api->create_trigger(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/triggers` and returns the decoded response content.
- edit\_trigger
```perl
my $trigger = $api->edit_trigger(
$project_id,
$trigger_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/triggers/:trigger_id` and returns the decoded response content.
- take\_ownership\_of\_trigger
```perl
my $trigger = $api->take_ownership_of_trigger(
$project_id,
$trigger_id,
);
```
Sends a `POST` request to `projects/:project_id/triggers/:trigger_id/take_ownership` and returns the decoded response content.
- delete\_trigger
```
$api->delete_trigger(
$project_id,
$trigger_id,
);
```
Sends a `DELETE` request to `projects/:project_id/triggers/:trigger_id`.
- trigger\_pipeline
```perl
my $pipeline = $api->trigger_pipeline(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/trigger/pipeline` and returns the decoded response content.
The API authentication token (["private\_token"](#private_token) or ["access\_token"](#access_token)
parameters in a constructor) is not needed when using this method, however
You must pass trigger token (generated at the trigger creation) as `token`
field and git ref name as `ref` field in the `%params` hash. You can also
pass variables to be set in a pipeline in the `variables` field. Example:
```perl
my $pipeline = $api->trigger_pipeline(
$project_id,
{
token => 'd69dba9162ab6ac72fa0993496286ada',
'ref' => 'master',
variables => {
variable1 => 'value1',
variable2 => 'value2',
},
},
);
```
Read more at [https://docs.gitlab.com/ce/ci/triggers/#triggering-a-pipeline](https://docs.gitlab.com/ce/ci/triggers/#triggering-a-pipeline).
## Pipeline schedules
See [https://docs.gitlab.com/ce/api/pipeline\_schedules.html](https://docs.gitlab.com/ce/api/pipeline_schedules.html).
- pipeline\_schedules
```perl
my $schedules = $api->pipeline_schedules(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/pipeline_schedules` and returns the decoded response content.
- pipeline\_schedule
```perl
my $schedule = $api->pipeline_schedule(
$project_id,
$pipeline_schedule_id,
);
```
Sends a `GET` request to `projects/:project_id/pipeline_schedules/:pipeline_schedule_id` and returns the decoded response content.
- create\_pipeline\_schedule
```perl
my $schedule = $api->create_pipeline_schedule(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/pipeline_schedules` and returns the decoded response content.
- edit\_pipeline\_schedule
```perl
my $schedule = $api->edit_pipeline_schedule(
$project_id,
$pipeline_schedule_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/pipeline_schedules/:pipeline_schedule_id` and returns the decoded response content.
- take\_ownership\_of\_pipeline\_schedule
```perl
my $schedule = $api->take_ownership_of_pipeline_schedule(
$project_id,
$pipeline_schedule_id,
);
```
Sends a `POST` request to `projects/:project_id/pipeline_schedules/:pipeline_schedule_id/take_ownership` and returns the decoded response content.
- delete\_pipeline\_schedule
```perl
my $schedule = $api->delete_pipeline_schedule(
$project_id,
$pipeline_schedule_id,
);
```
Sends a `DELETE` request to `projects/:project_id/pipeline_schedules/:pipeline_schedule_id` and returns the decoded response content.
- create\_pipeline\_schedule\_variable
```perl
my $variable = $api->create_pipeline_schedule_variable(
$project_id,
$pipeline_schedule_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/pipeline_schedules/:pipeline_schedule_id/variables` and returns the decoded response content.
- edit\_pipeline\_schedule\_variable
```perl
my $variable = $api->edit_pipeline_schedule_variable(
$project_id,
$pipeline_schedule_id,
$variable_key,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/pipeline_schedules/:pipeline_schedule_id/variables/:variable_key` and returns the decoded response content.
- delete\_pipeline\_schedule\_variable
```perl
my $variable = $api->delete_pipeline_schedule_variable(
$project_id,
$pipeline_schedule_id,
$variable_key,
);
```
Sends a `DELETE` request to `projects/:project_id/pipeline_schedules/:pipeline_schedule_id/variables/:variable_key` and returns the decoded response content.
## Projects
See [https://docs.gitlab.com/ce/api/projects.html](https://docs.gitlab.com/ce/api/projects.html).
- projects
```perl
my $projects = $api->projects(
\%params,
);
```
Sends a `GET` request to `projects` and returns the decoded response content.
- user\_projects
```perl
my $projects = $api->user_projects(
$user_id,
\%params,
);
```
Sends a `GET` request to `users/:user_id/projects` and returns the decoded response content.
- project
```perl
my $project = $api->project(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id` and returns the decoded response content.
- project\_users
```perl
my $users = $api->project_users(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/users` and returns the decoded response content.
- create\_project
```perl
my $project = $api->create_project(
\%params,
);
```
Sends a `POST` request to `projects` and returns the decoded response content.
- create\_project\_for\_user
```perl
$api->create_project_for_user(
$user_id,
\%params,
);
```
Sends a `POST` request to `projects/user/:user_id`.
- edit\_project
```
$api->edit_project(
$project_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id`.
- fork\_project
```
$api->fork_project(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/fork`.
- project\_forks
```perl
my $forks = $api->project_forks(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/forks` and returns the decoded response content.
- start\_project
```perl
my $project = $api->start_project(
$project_id,
);
```
Sends a `POST` request to `projects/:project_id/star` and returns the decoded response content.
- unstar\_project
```perl
my $project = $api->unstar_project(
$project_id,
);
```
Sends a `POST` request to `projects/:project_id/unstar` and returns the decoded response content.
- project\_languages
```perl
my $languages = $api->project_languages(
$project_id,
);
```
Sends a `GET` request to `projects/:project_id/languages` and returns the decoded response content.
- archive\_project
```perl
my $project = $api->archive_project(
$project_id,
);
```
Sends a `POST` request to `projects/:project_id/archive` and returns the decoded response content.
- unarchive\_project
```perl
my $project = $api->unarchive_project(
$project_id,
);
```
Sends a `POST` request to `projects/:project_id/unarchive` and returns the decoded response content.
- delete\_project
```
$api->delete_project(
$project_id,
);
```
Sends a `DELETE` request to `projects/:project_id`.
- upload\_file\_to\_project
```perl
my $upload = $api->upload_file_to_project(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/uploads` and returns the decoded response content.
The `file` parameter must point to a readable file on the local filesystem.
- share\_project\_with\_group
```
$api->share_project_with_group(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/share`.
- unshare\_project\_with\_group
```
$api->unshare_project_with_group(
$project_id,
$group_id,
);
```
Sends a `DELETE` request to `projects/:project_id/share/:group_id`.
- project\_hooks
```perl
my $hooks = $api->project_hooks(
$project_id,
);
```
Sends a `GET` request to `projects/:project_id/hooks` and returns the decoded response content.
- project\_hook
```perl
my $hook = $api->project_hook(
$project_id,
$hook_id,
);
```
Sends a `GET` request to `projects/:project_id/hooks/:hook_id` and returns the decoded response content.
- create\_project\_hook
```perl
my $hook = $api->create_project_hook(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/hooks` and returns the decoded response content.
- edit\_project\_hook
```perl
my $hook = $api->edit_project_hook(
$project_id,
$hook_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/hooks/:hook_id` and returns the decoded response content.
- delete\_project\_hook
```
$api->delete_project_hook(
$project_id,
$hook_id,
);
```
Sends a `DELETE` request to `projects/:project_id/hooks/:hook_id`.
- set\_project\_fork
```
$api->set_project_fork(
$project_id,
$from_project_id,
);
```
Sends a `POST` request to `projects/:project_id/fork/:from_project_id`.
- clear\_project\_fork
```
$api->clear_project_fork(
$project_id,
);
```
Sends a `DELETE` request to `projects/:project_id/fork`.
- start\_housekeeping
```perl
$api->start_housekeeping(
$project_id,
);
```
Sends a `POST` request to `projects/:project_id/housekeeping`.
- transfer\_project\_to\_namespace
```
$api->transfer_project_to_namespace(
$project_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/transfer`.
## Project access requests
See [https://docs.gitlab.com/ce/api/access\_requests.html](https://docs.gitlab.com/ce/api/access_requests.html).
- project\_access\_requests
```perl
my $requests = $api->project_access_requests(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/access_requests` and returns the decoded response content.
- request\_project\_access
```perl
my $request = $api->request_project_access(
$project_id,
);
```
Sends a `POST` request to `projects/:project_id/access_requests` and returns the decoded response content.
- approve\_project\_access
```perl
my $request = $api->approve_project_access(
$project_id,
$user_id,
);
```
Sends a `PUT` request to `projects/:project_id/access_requests/:user_id/approve` and returns the decoded response content.
- deny\_project\_access
```perl
$api->deny_project_access(
$project_id,
$user_id,
);
```
Sends a `DELETE` request to `projects/:project_id/access_requests/:user_id`.
## Project badges
See [https://docs.gitlab.com/ce/api/project\_badges.html](https://docs.gitlab.com/ce/api/project_badges.html).
- project\_badges
```perl
my $badges = $api->project_badges(
$project_id,
);
```
Sends a `GET` request to `projects/:project_id/badges` and returns the decoded response content.
- project\_badge
```perl
my $badge = $api->project_badge(
$project_id,
$badge_id,
);
```
Sends a `GET` request to `projects/:project_id/badges/:badge_id` and returns the decoded response content.
- create\_project\_badge
```perl
my $badge = $api->create_project_badge(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/badges` and returns the decoded response content.
- edit\_project\_badge
```perl
my $badge = $api->edit_project_badge(
$project_id,
$badge_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/badges/:badge_id` and returns the decoded response content.
- delete\_project\_badge
```
$api->delete_project_badge(
$project_id,
$badge_id,
);
```
Sends a `DELETE` request to `projects/:project_id/badges/:badge_id`.
- preview\_project\_badge
```perl
my $preview = $api->preview_project_badge(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/badges/render` and returns the decoded response content.
## Project import/export
See [https://docs.gitlab.com/ce/api/project\_import\_export.html](https://docs.gitlab.com/ce/api/project_import_export.html).
- schedule\_project\_export
```
$api->schedule_project_export(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/export`.
- project\_export\_status
```perl
my $status = $api->project_export_status(
$project_id,
);
```
Sends a `GET` request to `projects/:project_id/export` and returns the decoded response content.
- download\_project\_export
```perl
my $download = $api->download_project_export(
$project_id,
);
```
Sends a `GET` request to `projects/:project_id/export/download` and returns the decoded response content.
- schedule\_project\_import
```
$api->schedule_project_import(
\%params,
);
```
Sends a `POST` request to `projects/import`.
- project\_import\_status
```perl
my $status = $api->project_import_status(
$project_id,
);
```
Sends a `GET` request to `projects/:project_id/import` and returns the decoded response content.
## Project members
See [https://docs.gitlab.com/ce/api/members.html](https://docs.gitlab.com/ce/api/members.html).
- project\_members
```perl
my $members = $api->project_members(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/members` and returns the decoded response content.
- all\_project\_members
```perl
my $members = $api->all_project_members(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/members/all` and returns the decoded response content.
- project\_member
```perl
my $member = $api->project_member(
$project_id,
$user_id,
);
```
Sends a `GET` request to `projects/:project_id/members/:user_id` and returns the decoded response content.
- add\_project\_member
```perl
my $member = $api->add_project_member(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/members` and returns the decoded response content.
- update\_project\_member
```perl
my $member = $api->update_project_member(
$project_id,
$user_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/members/:user_id` and returns the decoded response content.
- remove\_project\_member
```perl
$api->remove_project_member(
$project_id,
$user_id,
);
```
Sends a `DELETE` request to `projects/:project_id/members/:user_id`.
## Project snippets
See [https://docs.gitlab.com/ce/api/project\_snippets.html](https://docs.gitlab.com/ce/api/project_snippets.html).
- project\_snippets
```perl
my $snippets = $api->project_snippets(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/snippets` and returns the decoded response content.
- project\_snippet
```perl
my $snippet = $api->project_snippet(
$project_id,
$snippet_id,
);
```
Sends a `GET` request to `projects/:project_id/snippets/:snippet_id` and returns the decoded response content.
- create\_project\_snippet
```
$api->create_project_snippet(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/snippets`.
- edit\_project\_snippet
```
$api->edit_project_snippet(
$project_id,
$snippet_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/snippets/:snippet_id`.
- delete\_project\_snippet
```
$api->delete_project_snippet(
$project_id,
$snippet_id,
);
```
Sends a `DELETE` request to `projects/:project_id/snippets/:snippet_id`.
- project\_snippet\_content
```perl
my $content = $api->project_snippet_content(
$project_id,
$snippet_id,
);
```
Sends a `GET` request to `projects/:project_id/snippets/:snippet_id/raw` and returns the decoded response content.
- project\_snippet\_user\_agent\_detail
```perl
my $user_agent = $api->project_snippet_user_agent_detail(
$project_id,
$snippet_id,
);
```
Sends a `GET` request to `projects/:project_id/snippets/:snippet_id/user_agent_detail` and returns the decoded response content.
## Protected branches
See [https://docs.gitlab.com/ce/api/protected\_branches.html](https://docs.gitlab.com/ce/api/protected_branches.html).
- protected\_branches
```perl
my $branches = $api->protected_branches(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/protected_branches` and returns the decoded response content.
- protected\_branch
```perl
my $branch = $api->protected_branch(
$project_id,
$branch_name,
);
```
Sends a `GET` request to `projects/:project_id/protected_branches/:branch_name` and returns the decoded response content.
- protect\_branch
```perl
my $branch = $api->protect_branch(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/protected_branches` and returns the decoded response content.
- unprotect\_branch
```
$api->unprotect_branch(
$project_id,
$branch_name,
);
```
Sends a `DELETE` request to `projects/:project_id/protected_branches/:branch_name`.
## Protected tags
See [https://docs.gitlab.com/ce/api/protected\_tags.html](https://docs.gitlab.com/ce/api/protected_tags.html).
- protected\_tags
```perl
my $tags = $api->protected_tags(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/protected_tags` and returns the decoded response content.
- protected\_tag
```perl
my $tag = $api->protected_tag(
$project_id,
$tag_name,
);
```
Sends a `GET` request to `projects/:project_id/protected_tags/:tag_name` and returns the decoded response content.
- protect\_tag
```perl
my $tag = $api->protect_tag(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/protected_tags` and returns the decoded response content.
- unprotect\_tag
```
$api->unprotect_tag(
$project_id,
$tag_name,
);
```
Sends a `DELETE` request to `projects/:project_id/protected_tags/:tag_name`.
## Releases
See [https://docs.gitlab.com/ce/api/releases/index.html](https://docs.gitlab.com/ce/api/releases/index.html).
- releases
```perl
my $releases = $api->releases(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/releases` and returns the decoded response content.
- release
```perl
my $release = $api->release(
$project_id,
$tag_name,
);
```
Sends a `GET` request to `projects/:project_id/releases/:tag_name` and returns the decoded response content.
- create\_release
```perl
my $release = $api->create_release(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/releases` and returns the decoded response content.
- update\_release
```perl
my $release = $api->update_release(
$project_id,
$tag_name,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/releases/:tag_name` and returns the decoded response content.
- delete\_release
```perl
my $release = $api->delete_release(
$project_id,
$tag_name,
);
```
Sends a `DELETE` request to `projects/:project_id/releases/:tag_name` and returns the decoded response content.
## Release Links
See [https://docs.gitlab.com/ce/api/releases/links.html](https://docs.gitlab.com/ce/api/releases/links.html).
- release\_links
```perl
my $links = $api->release_links(
$project_id,
$tag_name,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/releases/:tag_name/assets/links` and returns the decoded response content.
- release\_link
```perl
my $link = $api->release_link(
$project_id,
$tag_name,
$link_id,
);
```
Sends a `GET` request to `projects/:project_id/releases/:tag_name/assets/links/:link_id` and returns the decoded response content.
- create\_release\_link
```perl
my $link = $api->create_release_link(
$project_id,
$tag_name,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/releases/:tag_name/assets/links` and returns the decoded response content.
- update\_release\_link
```perl
my $link = $api->update_release_link(
$project_id,
$tag_name,
$link_id,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/releases/:tag_name/assets/links/:link_id` and returns the decoded response content.
- delete\_release\_link
```perl
my $link = $api->delete_release_link(
$project_id,
$tag_name,
$link_id,
);
```
Sends a `DELETE` request to `projects/:project_id/releases/:tag_name/assets/links/:link_id` and returns the decoded response content.
## Repositories
See [https://docs.gitlab.com/ce/api/repositories.html](https://docs.gitlab.com/ce/api/repositories.html).
- tree
```perl
my $tree = $api->tree(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/tree` and returns the decoded response content.
- blob
```perl
my $blob = $api->blob(
$project_id,
$sha,
);
```
Sends a `GET` request to `projects/:project_id/repository/blobs/:sha` and returns the decoded response content.
- raw\_blob
```perl
my $raw_blob = $api->raw_blob(
$project_id,
$sha,
);
```
Sends a `GET` request to `projects/:project_id/repository/blobs/:sha/raw` and returns the decoded response content.
- archive
```perl
my $archive = $api->archive(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/archive` and returns the raw response content.
- compare
```perl
my $comparison = $api->compare(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/compare` and returns the decoded response content.
- contributors
```perl
my $contributors = $api->contributors(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/contributors` and returns the decoded response content.
## Repository files
See [https://docs.gitlab.com/ce/api/repository\_files.html](https://docs.gitlab.com/ce/api/repository_files.html).
- file
```perl
my $file = $api->file(
$project_id,
$file_path,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/files/:file_path` and returns the decoded response content.
- raw\_file
```perl
my $content = $api->raw_file(
$project_id,
$file_path,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/files/:file_path/raw` and returns the raw response content.
- create\_file
```
$api->create_file(
$project_id,
$file_path,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/repository/files/:file_path`.
- edit\_file
```
$api->edit_file(
$project_id,
$file_path,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/repository/files/:file_path`.
- delete\_file
```
$api->delete_file(
$project_id,
$file_path,
\%params,
);
```
Sends a `DELETE` request to `projects/:project_id/repository/files/:file_path`.
## Runners
See [https://docs.gitlab.com/ce/api/runners.html](https://docs.gitlab.com/ce/api/runners.html).
- runners
```perl
my $runners = $api->runners(
\%params,
);
```
Sends a `GET` request to `runners` and returns the decoded response content.
- all\_runners
```perl
my $runners = $api->all_runners(
\%params,
);
```
Sends a `GET` request to `runners/all` and returns the decoded response content.
- runner
```perl
my $runner = $api->runner(
$runner_id,
);
```
Sends a `GET` request to `runners/:runner_id` and returns the decoded response content.
- update\_runner
```perl
my $runner = $api->update_runner(
$runner_id,
\%params,
);
```
Sends a `PUT` request to `runners/:runner_id` and returns the decoded response content.
- delete\_runner
```
$api->delete_runner(
$runner_id,
);
```
Sends a `DELETE` request to `runners/:runner_id`.
- runner\_jobs
```perl
my $jobs = $api->runner_jobs(
$runner_id,
\%params,
);
```
Sends a `GET` request to `runners/:runner_id/jobs` and returns the decoded response content.
- project\_runners
```perl
my $runners = $api->project_runners(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/runners` and returns the decoded response content.
- enable\_project\_runner
```perl
my $runner = $api->enable_project_runner(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/runners` and returns the decoded response content.
- disable\_project\_runner
```perl
my $runner = $api->disable_project_runner(
$project_id,
$runner_id,
);
```
Sends a `DELETE` request to `projects/:project_id/runners/:runner_id` and returns the decoded response content.
## Search
See [https://docs.gitlab.com/ce/api/search.html](https://docs.gitlab.com/ce/api/search.html).
- search
```perl
my $results = $api->search(
\%params,
);
```
Sends a `GET` request to `search` and returns the decoded response content.
## Services
See [https://docs.gitlab.com/ce/api/services.html](https://docs.gitlab.com/ce/api/services.html).
- project\_service
```perl
my $service = $api->project_service(
$project_id,
$service_name,
);
```
Sends a `GET` request to `projects/:project_id/services/:service_name` and returns the decoded response content.
- edit\_project\_service
```
$api->edit_project_service(
$project_id,
$service_name,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/services/:service_name`.
- delete\_project\_service
```
$api->delete_project_service(
$project_id,
$service_name,
);
```
Sends a `DELETE` request to `projects/:project_id/services/:service_name`.
## Application settings
See [https://docs.gitlab.com/ce/api/settings.html](https://docs.gitlab.com/ce/api/settings.html).
- settings
```perl
my $settings = $api->settings();
```
Sends a `GET` request to `application/settings` and returns the decoded response content.
- update\_settings
```perl
my $settings = $api->update_settings(
\%params,
);
```
Sends a `PUT` request to `application/settings` and returns the decoded response content.
## Application statistics
See [https://docs.gitlab.com/ce/api/statistics.html](https://docs.gitlab.com/ce/api/statistics.html).
- statistics
```perl
my $statistics = $api->statistics();
```
Sends a `GET` request to `application/statistics` and returns the decoded response content.
## Sidekiq Metrics
See [https://docs.gitlab.com/ce/api/sidekiq\_metrics.html](https://docs.gitlab.com/ce/api/sidekiq_metrics.html).
- queue\_metrics
```perl
my $metrics = $api->queue_metrics();
```
Sends a `GET` request to `sidekiq/queue_metrics` and returns the decoded response content.
- process\_metrics
```perl
my $metrics = $api->process_metrics();
```
Sends a `GET` request to `sidekiq/process_metrics` and returns the decoded response content.
- job\_stats
```perl
my $stats = $api->job_stats();
```
Sends a `GET` request to `sidekiq/job_stats` and returns the decoded response content.
- compound\_metrics
```perl
my $metrics = $api->compound_metrics();
```
Sends a `GET` request to `sidekiq/compound_metrics` and returns the decoded response content.
## System hooks
See [https://docs.gitlab.com/ce/api/system\_hooks.html](https://docs.gitlab.com/ce/api/system_hooks.html).
- hooks
```perl
my $hooks = $api->hooks(
\%params,
);
```
Sends a `GET` request to `hooks` and returns the decoded response content.
- create\_hook
```
$api->create_hook(
\%params,
);
```
Sends a `POST` request to `hooks`.
- test\_hook
```perl
my $hook = $api->test_hook(
$hook_id,
);
```
Sends a `GET` request to `hooks/:hook_id` and returns the decoded response content.
- delete\_hook
```
$api->delete_hook(
$hook_id,
);
```
Sends a `DELETE` request to `hooks/:hook_id`.
## Tags
See [https://docs.gitlab.com/ce/api/tags.html](https://docs.gitlab.com/ce/api/tags.html).
- tags
```perl
my $tags = $api->tags(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/repository/tags` and returns the decoded response content.
- tag
```perl
my $tag = $api->tag(
$project_id,
$tag_name,
);
```
Sends a `GET` request to `projects/:project_id/repository/tags/:tag_name` and returns the decoded response content.
- create\_tag
```perl
my $tag = $api->create_tag(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/repository/tags` and returns the decoded response content.
- delete\_tag
```
$api->delete_tag(
$project_id,
$tag_name,
);
```
Sends a `DELETE` request to `projects/:project_id/repository/tags/:tag_name`.
- create\_tag\_release
```perl
my $release = $api->create_tag_release(
$project_id,
$tag_name,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/repository/tags/:tag_name/release` and returns the decoded response content.
- update\_tag\_release
```perl
my $release = $api->update_tag_release(
$project_id,
$tag_name,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/repository/tags/:tag_name/release` and returns the decoded response content.
## Todos
See [https://docs.gitlab.com/ce/api/todos.html](https://docs.gitlab.com/ce/api/todos.html).
- todos
```perl
my $todos = $api->todos(
\%params,
);
```
Sends a `GET` request to `todos` and returns the decoded response content.
- mark\_todo\_done
```perl
my $todo = $api->mark_todo_done(
$todo_id,
);
```
Sends a `POST` request to `todos/:todo_id/mark_as_done` and returns the decoded response content.
- mark\_all\_todos\_done
```
$api->mark_all_todos_done();
```
Sends a `POST` request to `todos/mark_as_done`.
## Users
See [https://docs.gitlab.com/ce/api/users.html](https://docs.gitlab.com/ce/api/users.html).
- users
```perl
my $users = $api->users(
\%params,
);
```
Sends a `GET` request to `users` and returns the decoded response content.
- user
```perl
my $user = $api->user(
$user_id,
);
```
Sends a `GET` request to `users/:user_id` and returns the decoded response content.
- create\_user
```perl
$api->create_user(
\%params,
);
```
Sends a `POST` request to `users`.
- edit\_user
```perl
$api->edit_user(
$user_id,
\%params,
);
```
Sends a `PUT` request to `users/:user_id`.
- delete\_user
```perl
$api->delete_user(
$user_id,
\%params,
);
```
Sends a `DELETE` request to `users/:user_id`.
- current\_user
```perl
my $user = $api->current_user();
```
Sends a `GET` request to `user` and returns the decoded response content.
- current\_user\_ssh\_keys
```perl
my $keys = $api->current_user_ssh_keys(
\%params,
);
```
Sends a `GET` request to `user/keys` and returns the decoded response content.
- user\_ssh\_keys
```perl
my $keys = $api->user_ssh_keys(
$user_id,
\%params,
);
```
Sends a `GET` request to `users/:user_id/keys` and returns the decoded response content.
- user\_ssh\_key
```perl
my $key = $api->user_ssh_key(
$key_id,
);
```
Sends a `GET` request to `user/keys/:key_id` and returns the decoded response content.
- create\_current\_user\_ssh\_key
```perl
$api->create_current_user_ssh_key(
\%params,
);
```
Sends a `POST` request to `user/keys`.
- create\_user\_ssh\_key
```perl
$api->create_user_ssh_key(
$user_id,
\%params,
);
```
Sends a `POST` request to `users/:user_id/keys`.
- delete\_current\_user\_ssh\_key
```perl
$api->delete_current_user_ssh_key(
$key_id,
);
```
Sends a `DELETE` request to `user/keys/:key_id`.
- delete\_user\_ssh\_key
```perl
$api->delete_user_ssh_key(
$user_id,
$key_id,
);
```
Sends a `DELETE` request to `users/:user_id/keys/:key_id`.
- current\_user\_gpg\_keys
```perl
my $keys = $api->current_user_gpg_keys(
\%params,
);
```
Sends a `GET` request to `user/gpg_keys` and returns the decoded response content.
- current\_user\_gpg\_key
```perl
my $key = $api->current_user_gpg_key(
$key_id,
);
```
Sends a `GET` request to `user/gpg_keys/:key_id` and returns the decoded response content.
- create\_current\_user\_gpg\_key
```perl
$api->create_current_user_gpg_key(
\%params,
);
```
Sends a `POST` request to `user/gpg_keys`.
- delete\_current\_user\_gpg\_key
```perl
$api->delete_current_user_gpg_key(
$key_id,
);
```
Sends a `DELETE` request to `user/gpg_keys/:key_id`.
- user\_gpg\_keys
```perl
my $keys = $api->user_gpg_keys(
$user_id,
\%params,
);
```
Sends a `GET` request to `users/:user_id/gpg_keys` and returns the decoded response content.
- user\_gpg\_key
```perl
my $key = $api->user_gpg_key(
$user_id,
$key_id,
);
```
Sends a `GET` request to `users/:user_id/gpg_keys/:key_id` and returns the decoded response content.
- create\_user\_gpg\_key
```perl
my $keys = $api->create_user_gpg_key(
$user_id,
\%params,
);
```
Sends a `POST` request to `users/:user_id/gpg_keys` and returns the decoded response content.
- delete\_user\_gpg\_key
```perl
$api->delete_user_gpg_key(
$user_id,
$key_id,
);
```
Sends a `DELETE` request to `users/:user_id/gpg_keys/:key_id`.
- current\_user\_emails
```perl
my $emails = $api->current_user_emails(
\%params,
);
```
Sends a `GET` request to `user/emails` and returns the decoded response content.
- user\_emails
```perl
my $emails = $api->user_emails(
$user_id,
\%params,
);
```
Sends a `GET` request to `users/:user_id/emails` and returns the decoded response content.
- current\_user\_email
```perl
my $email = $api->current_user_email(
$email_id,
);
```
Sends a `GET` request to `user/emails/:email_id` and returns the decoded response content.
- create\_current\_user\_email
```perl
my $email = $api->create_current_user_email(
\%params,
);
```
Sends a `POST` request to `user/emails` and returns the decoded response content.
- create\_user\_email
```perl
my $email = $api->create_user_email(
$user_id,
\%params,
);
```
Sends a `POST` request to `users/:user_id/emails` and returns the decoded response content.
- delete\_current\_user\_email
```perl
$api->delete_current_user_email(
$email_id,
);
```
Sends a `DELETE` request to `user/emails/:email_id`.
- delete\_user\_email
```perl
$api->delete_user_email(
$user_id,
$email_id,
);
```
Sends a `DELETE` request to `users/:user_id/emails/:email_id`.
- block\_user
```perl
my $success = $api->block_user(
$user_id,
);
```
Sends a `POST` request to `users/:user_id/block` and returns the decoded response content.
- unblock\_user
```perl
my $success = $api->unblock_user(
$user_id,
);
```
Sends a `POST` request to `users/:user_id/unblock` and returns the decoded response content.
- user\_impersonation\_tokens
```perl
my $tokens = $api->user_impersonation_tokens(
$user_id,
\%params,
);
```
Sends a `GET` request to `users/:user_id/impersonation_tokens` and returns the decoded response content.
- user\_impersonation\_token
```perl
my $token = $api->user_impersonation_token(
$user_id,
$impersonation_token_id,
);
```
Sends a `GET` request to `users/:user_id/impersonation_tokens/:impersonation_token_id` and returns the decoded response content.
- create\_user\_impersonation\_token
```perl
my $token = $api->create_user_impersonation_token(
$user_id,
\%params,
);
```
Sends a `POST` request to `users/:user_id/impersonation_tokens` and returns the decoded response content.
- delete\_user\_impersonation\_token
```perl
$api->delete_user_impersonation_token(
$user_id,
$impersonation_token_id,
);
```
Sends a `DELETE` request to `users/:user_id/impersonation_tokens/:impersonation_token_id`.
- all\_user\_activities
```perl
my $activities = $api->all_user_activities(
\%params,
);
```
Sends a `GET` request to `user/activities` and returns the decoded response content.
- user\_memberships
```perl
my $memberships = $api->user_memberships(
$user_id,
\%params,
);
```
Sends a `GET` request to `users/:user_id/memberships` and returns the decoded response content.
## Validate the .gitlab-ci.yml
See [https://docs.gitlab.com/ce/api/lint.html](https://docs.gitlab.com/ce/api/lint.html).
- lint
```perl
my $result = $api->lint(
\%params,
);
```
Sends a `POST` request to `lint` and returns the decoded response content.
## Version
See [https://docs.gitlab.com/ce/api/version.html](https://docs.gitlab.com/ce/api/version.html).
- version
```perl
my $version = $api->version();
```
Sends a `GET` request to `version` and returns the decoded response content.
## Wikis
See [https://docs.gitlab.com/ce/api/wikis.html](https://docs.gitlab.com/ce/api/wikis.html).
- wiki\_pages
```perl
my $pages = $api->wiki_pages(
$project_id,
\%params,
);
```
Sends a `GET` request to `projects/:project_id/wikis` and returns the decoded response content.
- wiki\_page
```perl
my $pages = $api->wiki_page(
$project_id,
$slug,
);
```
Sends a `GET` request to `projects/:project_id/wikis/:slug` and returns the decoded response content.
- create\_wiki\_page
```perl
my $page = $api->create_wiki_page(
$project_id,
\%params,
);
```
Sends a `POST` request to `projects/:project_id/wikis` and returns the decoded response content.
- edit\_wiki\_page
```perl
my $page = $api->edit_wiki_page(
$project_id,
$slug,
\%params,
);
```
Sends a `PUT` request to `projects/:project_id/wikis/:slug` and returns the decoded response content.
- delete\_wiki\_page
```
$api->delete_wiki_page(
$project_id,
$slug,
);
```
Sends a `DELETE` request to `projects/:project_id/wikis/:slug`.
# CONTRIBUTING
This module is auto-generated from a set of YAML files defining the
interface of GitLab's API. If you'd like to contribute to this module
then please feel free to make a
[fork on GitHub](https://github.com/bluefeet/GitLab-API-v4)
and submit a pull request, just make sure you edit the files in the
`authors/` directory instead of `lib/GitLab/API/v4.pm` directly.
Please see
[https://github.com/bluefeet/GitLab-API-v4/blob/master/author/README.pod](https://github.com/bluefeet/GitLab-API-v4/blob/master/author/README.pod)
for more information.
Alternatively, you can
[open a ticket](https://github.com/bluefeet/GitLab-API-v4/issues).
# SUPPORT
Please submit bugs and feature requests to the
GitLab-API-v4 GitHub issue tracker:
[https://github.com/bluefeet/GitLab-API-v4/issues](https://github.com/bluefeet/GitLab-API-v4/issues)
# ACKNOWLEDGEMENTS
Thanks to [ZipRecruiter](https://www.ziprecruiter.com/)
for encouraging their employees to contribute back to the open
source ecosystem. Without their dedication to quality software
development this distribution would not exist.
# AUTHORS
```
Aran Clary Deltac <bluefeet@gmail.com>
Dotan Dimet <dotan@corky.net>
Nigel Gregoire <nigelgregoire@gmail.com>
trunov-ms <trunov.ms@gmail.com>
Marek R. Sotola <Marek.R.Sotola@nasa.gov>
José Joaquín Atria <jjatria@gmail.com>
Dave Webb <github@d5ve.com>
Simon Ruderich <simon@ruderich.org>
royce55 <royce@ecs.vuw.ac.nz>
gregor herrmann <gregoa@debian.org>
Luc Didry <luc@didry.org>
Kieren Diment <kieren.diment@staples.com.au>
Dmitry Frolov <dmitry.frolov@gmail.com>
Thomas Klausner <domm@plix.at>
Graham Knop <haarg@haarg.org>
```
# COPYRIGHT AND LICENSE
Copyright (C) 2014 Aran Clary Deltac
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).