Skip to content
forgit api docs

Create an approval rule for a project

POST
/api/v4/projects/{id}/approval_rules

Creates an approval rule for a specified project.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
One of:
string

The ID or URL-encoded path of the project

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
name
required

The name of the approval rule

string
nullable
approvals_required
required

The number of required approvals for this rule

integer
nullable
rule_type

The type of approval rule

string
nullable
Example 
regular
users

Deprecated: The user ids for this rule

Array<integer>
nullable
user_ids

The user ids for this rule

Array<integer>
nullable
groups

Deprecated: The group ids for this rule

Array<integer>
nullable
group_ids

The group ids for this rule

Array<integer>
nullable
usernames

The usernames for this rule

Array<string>
nullable
protected_branch_ids

The protected branch ids for this rule

Array<integer>
nullable
applies_to_all_protected_branches

Apply this rule to all protected branches within the project

boolean
nullable
report_type

The type of the report required when rule type equals to report_approver

string
nullable
Allowed values: code_coverage
coverage_minimum_threshold

Minimum code coverage threshold (0-100). If coverage falls below this threshold, approval is required.

number
nullable
vulnerabilities_allowed

The number of vulnerabilities allowed for this rule

integer
nullable
scanners

The security scanners to be considered by the approval rule

Array<string>
nullable
severity_levels

The security levels to be considered by the approval rule

Array<string>
nullable
vulnerability_states

The vulnerability states to be considered by the approval rule

Array<string>
nullable

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Created

Media type application/json
object
id
integer format: int64
name
string
rule_type
string
eligible_approvers
Array<object>
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
approvals_required
integer
users
Array<object>
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
groups
Array<object>
object
id
integer format: int64
web_url
string
name
string
path
string
description
string
visibility
string
share_with_group_lock
boolean
require_two_factor_authentication
boolean
two_factor_grace_period
integer
project_creation_level
string
auto_devops_enabled
string
subgroup_creation_level
string
emails_disabled
boolean
emails_enabled
boolean
show_diff_preview_in_email
boolean
mentions_disabled
string
lfs_enabled
boolean
archived
boolean
math_rendering_limits_enabled
boolean
lock_math_rendering_limits_enabled
boolean
crm_enabled
boolean
resource_access_token_notify_inherited
boolean
lock_resource_access_token_notify_inherited
boolean
default_branch
string
default_branch_protection
integer
default_branch_protection_defaults
string
avatar_url
string
request_access_enabled
boolean
full_name
string
full_path
string
created_at
string
parent_id
string
organization_id
integer format: int64
shared_runners_setting
string
max_artifacts_size
integer
custom_attributes
object
key
string
value
string
statistics
string
marked_for_deletion_on
string
root_storage_statistics
object
build_artifacts_size

CI artifacts size in bytes.

integer
container_registry_size

Container registry size in bytes.

integer
container_registry_size_is_estimated

Indicates whether the deduplicated container registry size for the namespace is an estimated value or not.

boolean
dependency_proxy_size

Dependency Proxy sizes in bytes.

integer
lfs_objects_size

LFS objects size in bytes.

integer
packages_size

Packages size in bytes.

integer
pipeline_artifacts_size

CI pipeline artifacts size in bytes.

integer
repository_size

Git repository size in bytes.

integer
snippets_size

Snippets size in bytes.

integer
storage_size

Total storage in bytes.

integer
uploads_size

Uploads size in bytes.

integer
wiki_size

Wiki size in bytes.

integer
ldap_cn
string
ldap_access
string
ldap_group_links
object
cn
string
group_access
integer
provider
string
filter
string
member_role_id
integer format: int64
saml_group_links
object
name
string
access_level
integer
member_role_id
integer format: int64
provider
string
file_template_project_id
string
wiki_access_level
string
repository_storage
string
duo_core_features_enabled

[Experimental] Indicates whether GitLab Duo Core features are enabled for the group

boolean
duo_features_enabled
string
lock_duo_features_enabled
string
auto_duo_code_review_enabled
string
web_based_commit_signing_enabled
string
allow_personal_snippets
string
duo_namespace_access_rules
string
built_in_project_templates_enabled
boolean
lock_built_in_project_templates_enabled
boolean
contains_hidden_groups
boolean
report_type
string
protected_branches
object
id
integer format: int64
name
string
push_access_levels
Array<object>
object
id
integer format: int64
access_level
integer
access_level_description
string
deploy_key_id
integer format: int64
user_id
integer format: int64
group_id
integer format: int64
member_role_id
integer format: int64
member_role_name
string
merge_access_levels
Array<object>
object
id
integer format: int64
access_level
integer
access_level_description
string
deploy_key_id
integer format: int64
user_id
integer format: int64
group_id
integer format: int64
member_role_id
integer format: int64
member_role_name
string
allow_force_push
boolean
unprotect_access_levels
Array<object>
object
id
integer format: int64
access_level
integer
access_level_description
string
deploy_key_id
integer format: int64
user_id
integer format: int64
group_id
integer format: int64
member_role_id
integer format: int64
member_role_name
string
code_owner_approval_required
boolean
inherited
boolean
applies_to_all_protected_branches
boolean
coverage_minimum_threshold
number
Example 
{
  "id": 1,
  "name": "QA",
  "rule_type": "regular",
  "eligible_approvers": [
    {
      "id": 1,
      "username": "admin",
      "public_email": "john@example.com",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://gravatar.com/avatar/1",
      "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
      "custom_attributes": [
        {
          "key": "foo",
          "value": "bar"
        }
      ],
      "web_url": "https://gitlab.example.com/root"
    }
  ],
  "approvals_required": 2,
  "users": [
    {
      "id": 1,
      "username": "admin",
      "public_email": "john@example.com",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://gravatar.com/avatar/1",
      "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
      "custom_attributes": [
        {
          "key": "foo",
          "value": "bar"
        }
      ],
      "web_url": "https://gitlab.example.com/root"
    }
  ],
  "groups": [
    {
      "web_url": "http://gitlab.example.com/groups/diaspora",
      "name": "Diaspora",
      "custom_attributes": {
        "key": "foo",
        "value": "bar"
      },
      "ldap_group_links": {
        "cn": "ldap-group-1",
        "group_access": 10,
        "provider": "ldapmain",
        "filter": "id >= 500",
        "member_role_id": 12
      },
      "saml_group_links": {
        "name": "saml-group-1",
        "access_level": 40,
        "member_role_id": 12,
        "provider": "saml"
      }
    }
  ],
  "protected_branches": {
    "id": 1,
    "name": "main",
    "push_access_levels": [
      {
        "id": 1,
        "access_level": 40,
        "access_level_description": "Maintainers",
        "deploy_key_id": 1,
        "user_id": 1,
        "group_id": 1,
        "member_role_id": 42,
        "member_role_name": "Lead Developer"
      }
    ],
    "merge_access_levels": [
      {
        "id": 1,
        "access_level": 40,
        "access_level_description": "Maintainers",
        "deploy_key_id": 1,
        "user_id": 1,
        "group_id": 1,
        "member_role_id": 42,
        "member_role_name": "Lead Developer"
      }
    ],
    "unprotect_access_levels": [
      {
        "id": 1,
        "access_level": 40,
        "access_level_description": "Maintainers",
        "deploy_key_id": 1,
        "user_id": 1,
        "group_id": 1,
        "member_role_id": 42,
        "member_role_name": "Lead Developer"
      }
    ]
  },
  "coverage_minimum_threshold": 80
}

400

Section titled “ 400 ”

Bad Request

404

Section titled “ 404 ”

Not Found