Skip to content
forgit api docs

Unstar a project

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

Unstars 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

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Created

Media type application/json
object
id
integer format: int64
description
string
name
string
name_with_namespace
string
path
string
path_with_namespace
string
created_at
string format: date-time
default_branch
string
tag_list
Array<string>
topics
Array<string>
ssh_url_to_repo
string
http_url_to_repo
string
web_url
string
readme_url
string
forks_count
integer
license_url
string
license
object
key
string
name
string
nickname
string
html_url
string
source_url
string
avatar_url
string
star_count
integer
last_activity_at
string format: date-time
visibility
string
namespace
object
id
integer format: int64
name
string
path
string
kind
string
full_path
string
parent_id
integer format: int64
avatar_url
string
web_url
string
custom_attributes
object
key
string
value
string
repository_storage
string
forked_from_project
object
id
integer format: int64
description
string
name
string
name_with_namespace
string
path
string
path_with_namespace
string
created_at
string format: date-time
default_branch
string
tag_list
Array<string>
topics
Array<string>
ssh_url_to_repo
string
http_url_to_repo
string
web_url
string
readme_url
string
forks_count
integer
license_url
string
license
object
key
string
name
string
nickname
string
html_url
string
source_url
string
avatar_url
string
star_count
integer
last_activity_at
string format: date-time
visibility
string
namespace
object
id
integer format: int64
name
string
path
string
kind
string
full_path
string
parent_id
integer format: int64
avatar_url
string
web_url
string
custom_attributes
object
key
string
value
string
repository_storage
string
container_registry_image_prefix
string
_links
object
marked_for_deletion_at
string format: date-time
marked_for_deletion_on
string format: date-time
packages_enabled
boolean
empty_repo
boolean
archived
boolean
owner
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
resolve_outdated_diff_discussions
boolean
container_expiration_policy
object
cadence
string
enabled
string
keep_n
string
older_than
string
name_regex
string
name_regex_keep
string
next_run_at
string
repository_object_format
string
issues_enabled
boolean
merge_requests_enabled
boolean
wiki_enabled
boolean
jobs_enabled
boolean
snippets_enabled
boolean
container_registry_enabled
boolean
service_desk_enabled
boolean
service_desk_address
string
can_create_merge_request_in
boolean
issues_access_level
string
repository_access_level
string
merge_requests_access_level
string
forking_access_level
string
wiki_access_level
string
builds_access_level
string
snippets_access_level
string
pages_access_level
string
analytics_access_level
string
container_registry_access_level
string
security_and_compliance_access_level
string
releases_access_level
string
environments_access_level
string
feature_flags_access_level
string
infrastructure_access_level
string
monitor_access_level
string
model_experiments_access_level
string
model_registry_access_level
string
package_registry_access_level
string
emails_disabled
boolean
emails_enabled
boolean
show_diff_preview_in_email
boolean
shared_runners_enabled
boolean
lfs_enabled
boolean
creator_id
integer format: int64
mr_default_target_self
boolean
import_url
string
import_type
string
import_status
string
import_error
string
open_issues_count
integer
description_html
string
updated_at
string format: date-time
ci_default_git_depth
integer
ci_delete_pipelines_in_seconds
integer
ci_forward_deployment_enabled
boolean
ci_forward_deployment_rollback_allowed
boolean
ci_job_token_scope_enabled
boolean
ci_separated_caches
boolean
ci_allow_fork_pipelines_to_run_in_parent_project
boolean
ci_id_token_sub_claim_components
Array<string>
build_git_strategy
string
keep_latest_artifact
boolean
restrict_user_defined_variables
boolean
ci_pipeline_variables_minimum_override_role
string
runner_token_expiration_interval
integer
group_runners_enabled
boolean
resource_group_default_process_mode
string
auto_cancel_pending_pipelines
string
build_timeout
integer
auto_devops_enabled
boolean
auto_devops_deploy_strategy
string
ci_push_repository_for_job_token_allowed
boolean
protect_merge_request_pipelines
boolean
ci_display_pipeline_variables
boolean
runners_token
string
ci_config_path
string
public_jobs
boolean
shared_with_groups
Array<object>
object
only_allow_merge_if_pipeline_succeeds
boolean
allow_merge_on_skipped_pipeline
boolean
request_access_enabled
boolean
only_allow_merge_if_all_discussions_are_resolved
boolean
remove_source_branch_after_merge
boolean
printing_merge_request_link_enabled
boolean
merge_method
string
squash_option
string
enforce_auth_checks_on_uploads
boolean
suggestion_commit_message
string
merge_commit_template
string
squash_commit_template
string
mr_default_title_template
string
issue_branch_template
string
statistics
object
commit_count
integer
storage_size
integer
repository_size
integer
wiki_size
integer
lfs_objects_size
integer
job_artifacts_size
integer
pipeline_artifacts_size
integer
packages_size
integer
snippets_size
integer
uploads_size
integer
container_registry_size
integer
warn_about_potentially_unwanted_characters
boolean
autoclose_referenced_issues
boolean
max_artifacts_size
integer
approvals_before_merge
string
mirror
string
mirror_user_id
string
mirror_trigger_builds
string
only_mirror_protected_branches
string
mirror_overwrites_diverged_branches
string
external_authorization_classification_label
string
requirements_enabled
string
requirements_access_level
string
security_and_compliance_enabled
string
secret_push_protection_enabled
boolean
pre_receive_secret_detection_enabled
boolean
compliance_frameworks
string
issues_template
string
merge_requests_template
string
ci_restrict_pipeline_cancellation_role
string
merge_pipelines_enabled
string
merge_trains_enabled
string
merge_trains_skip_train_allowed
string
merge_train_enforcement
string
max_pipelines_per_merge_train
string
only_allow_merge_if_all_status_checks_passed
string
allow_pipeline_trigger_approve_deployment
boolean
prevent_merge_without_jira_issue
string
auto_duo_code_review_enabled
string
reviewer_assignment_strategy
string
duo_remote_flows_enabled
string
duo_foundational_flows_enabled
string
duo_sast_fp_detection_enabled
string
duo_secret_detection_fp_enabled
string
duo_dependency_bump_breaking_changes_enabled
string
duo_sast_vr_workflow_enabled
string
web_based_commit_signing_enabled
string
spp_repository_pipeline_access

The spp_repository_pipeline_access setting is only visible if the security_orchestration_policies feature is available.

boolean
security_policy_pipeline_must_succeed

Require all security policy pipelines to succeed before merge requests can be merged.

boolean
merge_request_title_regex
string
merge_request_title_regex_description
string
Example 
{
  "id": 1,
  "description": "desc",
  "name": "project1",
  "name_with_namespace": "John Doe / project1",
  "path": "project1",
  "path_with_namespace": "namespace1/project1",
  "created_at": "2020-05-07T04:27:17.016Z",
  "default_branch": "main",
  "tag_list": [
    "tag"
  ],
  "topics": [
    "topic"
  ],
  "ssh_url_to_repo": "git@gitlab.example.com:gitlab/gitlab.git",
  "http_url_to_repo": "https://gitlab.example.com/gitlab/gitlab.git",
  "web_url": "https://gitlab.example.com/gitlab/gitlab",
  "readme_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/README.md",
  "forks_count": 1,
  "license_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE",
  "license": {
    "key": "gpl-3.0",
    "name": "GNU General Public License v3.0",
    "nickname": "GNU GPLv3",
    "html_url": "http://choosealicense.com/licenses/gpl-3.0"
  },
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "star_count": 1,
  "last_activity_at": "2013-09-30T13:46:02Z",
  "visibility": "public",
  "namespace": {
    "id": 2,
    "name": "project",
    "path": "my_project",
    "kind": "project",
    "full_path": "group/my_project",
    "parent_id": 1,
    "avatar_url": "https://example.com/avatar/12345",
    "web_url": "https://example.com/group/my_project"
  },
  "custom_attributes": {
    "key": "foo",
    "value": "bar"
  },
  "repository_storage": "default",
  "forked_from_project": {
    "id": 1,
    "description": "desc",
    "name": "project1",
    "name_with_namespace": "John Doe / project1",
    "path": "project1",
    "path_with_namespace": "namespace1/project1",
    "created_at": "2020-05-07T04:27:17.016Z",
    "default_branch": "main",
    "tag_list": [
      "tag"
    ],
    "topics": [
      "topic"
    ],
    "ssh_url_to_repo": "git@gitlab.example.com:gitlab/gitlab.git",
    "http_url_to_repo": "https://gitlab.example.com/gitlab/gitlab.git",
    "web_url": "https://gitlab.example.com/gitlab/gitlab",
    "readme_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/README.md",
    "forks_count": 1,
    "license_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE",
    "license": {
      "key": "gpl-3.0",
      "name": "GNU General Public License v3.0",
      "nickname": "GNU GPLv3",
      "html_url": "http://choosealicense.com/licenses/gpl-3.0"
    },
    "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
    "star_count": 1,
    "last_activity_at": "2013-09-30T13:46:02Z",
    "visibility": "public",
    "namespace": {
      "id": 2,
      "name": "project",
      "path": "my_project",
      "kind": "project",
      "full_path": "group/my_project",
      "parent_id": 1,
      "avatar_url": "https://example.com/avatar/12345",
      "web_url": "https://example.com/group/my_project"
    },
    "custom_attributes": {
      "key": "foo",
      "value": "bar"
    },
    "repository_storage": "default"
  },
  "container_registry_image_prefix": "registry.gitlab.example.com/gitlab/gitlab-client",
  "marked_for_deletion_at": "2020-05-07T04:27:17.016Z",
  "marked_for_deletion_on": "2020-05-07T04:27:17.016Z",
  "owner": {
    "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"
  },
  "repository_object_format": "sha1",
  "service_desk_address": "address@example.com",
  "issues_access_level": "enabled",
  "repository_access_level": "enabled",
  "merge_requests_access_level": "enabled",
  "forking_access_level": "enabled",
  "wiki_access_level": "enabled",
  "builds_access_level": "enabled",
  "snippets_access_level": "enabled",
  "pages_access_level": "enabled",
  "analytics_access_level": "enabled",
  "container_registry_access_level": "enabled",
  "security_and_compliance_access_level": "enabled",
  "releases_access_level": "enabled",
  "environments_access_level": "enabled",
  "feature_flags_access_level": "enabled",
  "infrastructure_access_level": "enabled",
  "monitor_access_level": "enabled",
  "model_experiments_access_level": "enabled",
  "model_registry_access_level": "enabled",
  "package_registry_access_level": "enabled",
  "creator_id": 1,
  "import_url": "https://gitlab.com/gitlab/gitlab.git",
  "import_type": "git",
  "import_status": "none",
  "import_error": "Import error",
  "open_issues_count": 1,
  "updated_at": "2020-05-07T04:27:17.016Z",
  "ci_default_git_depth": 20,
  "ci_delete_pipelines_in_seconds": 86400,
  "build_git_strategy": "fetch",
  "runner_token_expiration_interval": 3600,
  "resource_group_default_process_mode": "unordered",
  "auto_cancel_pending_pipelines": "enabled",
  "build_timeout": 3600,
  "auto_devops_deploy_strategy": "continuous",
  "runners_token": "b8547b1dc37721d05889db52fa2f02",
  "ci_config_path": "",
  "merge_method": "merge",
  "squash_option": "default_off",
  "suggestion_commit_message": "Suggestion message",
  "merge_commit_template": "%(title)",
  "squash_commit_template": "%(source_branch)",
  "mr_default_title_template": "%(source_branch)",
  "issue_branch_template": "%(title)",
  "statistics": {
    "commit_count": 37,
    "storage_size": 1038090,
    "repository_size": 1038090,
    "wiki_size": 0,
    "lfs_objects_size": 0,
    "job_artifacts_size": 0,
    "pipeline_artifacts_size": 0,
    "packages_size": 0,
    "snippets_size": 0,
    "uploads_size": 0,
    "container_registry_size": 0
  },
  "reviewer_assignment_strategy": "code_owners",
  "merge_request_title_regex": "/Title of merge request/",
  "merge_request_title_regex_description": "This requires the title to include a Jira label"
}

304

Section titled “ 304 ”

Not modified

400

Section titled “ 400 ”

Bad Request

403

Section titled “ 403 ”

Unauthenticated

404

Section titled “ 404 ”

Not Found