GitLab API icon

GitLab API

Gitlab

Actions1062

Project_import → postApiV4ProjectsRemoteImportS3

AI-generated

Summary

Imports a GitLab project from an S3 bucket by sending a POST request to /api/v4/projects/remote-import-s3.

Inputs

  • region (required) — AWS region
  • bucket_name (required) — Bucket name
  • file_key (required) — File key
  • access_key_id (required) — Access key id
  • secret_access_key (required) — Secret access key
  • path (required) — The new project path and name
  • name — The name of the project to be imported. Defaults to the path of the project if not provided.
  • namespace — The ID or name of the namespace that the project will be imported into. Defaults to the current user's namespace.
  • overwrite — If there is a project in the same namespace and with the same name overwrite it
  • override_params[description] — The description of the project
  • override_params[build_git_strategy] — The Git strategy. Defaults to fetch
  • override_params[build_timeout] — Build timeout
  • override_params[auto_cancel_pending_pipelines] — Auto-cancel pending pipelines
  • override_params[ci_config_path] — The path to CI config file. Defaults to .gitlab-ci.yml
  • override_params[service_desk_enabled] — Disable or enable the service desk
  • override_params[issues_enabled] — Flag indication if the issue tracker is enabled
  • override_params[merge_requests_enabled] — Flag indication if merge requests are enabled
  • override_params[wiki_enabled] — Flag indication if the wiki is enabled
  • override_params[jobs_enabled] — Flag indication if jobs are enabled
  • override_params[snippets_enabled] — Flag indication if snippets are enabled
  • override_params[issues_access_level] — Issues access level. One of disabled, private or enabled
  • override_params[repository_access_level] — Repository access level. One of disabled, private or enabled
  • override_params[merge_requests_access_level] — Merge requests access level. One of disabled, private or enabled
  • override_params[forking_access_level] — Forks access level. One of disabled, private or enabled
  • override_params[wiki_access_level] — Wiki access level. One of disabled, private or enabled
  • override_params[builds_access_level] — Builds access level. One of disabled, private or enabled
  • override_params[snippets_access_level] — Snippets access level. One of disabled, private or enabled
  • override_params[pages_access_level] — Pages access level. One of disabled, private, enabled or public
  • override_params[analytics_access_level] — Analytics access level. One of disabled, private or enabled
  • override_params[container_registry_access_level] — Controls visibility of the container registry. One of disabled, private or enabled. private will make the container registry accessible only to project members (reporter role and above). enabled will make the container registry accessible to everyone who has access to the project. disabled will disable the container registry
  • override_params[security_and_compliance_access_level] — Security and compliance access level. One of disabled, private or enabled
  • override_params[releases_access_level] — Releases access level. One of disabled, private or enabled
  • override_params[environments_access_level] — Environments access level. One of disabled, private or enabled
  • override_params[feature_flags_access_level] — Feature flags access level. One of disabled, private or enabled
  • override_params[infrastructure_access_level] — Infrastructure access level. One of disabled, private or enabled
  • override_params[monitor_access_level] — Monitor access level. One of disabled, private or enabled
  • override_params[model_experiments_access_level] — Model experiments access level. One of disabled, private or enabled
  • override_params[model_registry_access_level] — Model registry access level. One of disabled, private or enabled
  • override_params[emails_disabled] — Deprecated: Use emails_enabled instead.
  • override_params[emails_enabled] — Enable email notifications
  • override_params[show_default_award_emojis] — Show default award emojis
  • override_params[show_diff_preview_in_email] — Include the code diff preview in merge request notification emails
  • override_params[warn_about_potentially_unwanted_characters] — Warn about potentially unwanted characters
  • override_params[enforce_auth_checks_on_uploads] — Enforce auth check on uploads
  • override_params[shared_runners_enabled] — Flag indication if shared runners are enabled for that project
  • override_params[group_runners_enabled] — Flag indication if group runners are enabled for that project
  • override_params[resolve_outdated_diff_discussions] — Automatically resolve merge request diff threads on lines changed with a push
  • override_params[remove_source_branch_after_merge] — Remove the source branch by default after merge
  • override_params[container_registry_enabled] — Deprecated: Use :container_registry_access_level instead. Flag indication if the container registry is enabled for that project
  • override_params[container_expiration_policy_attributes][cadence] — Container expiration policy cadence for recurring job
  • override_params[container_expiration_policy_attributes][keep_n] — Container expiration policy number of images to keep
  • override_params[container_expiration_policy_attributes][older_than] — Container expiration policy remove images older than value
  • override_params[container_expiration_policy_attributes][name_regex] — Container expiration policy regex for image removal
  • override_params[container_expiration_policy_attributes][name_regex_keep] — Container expiration policy regex for image retention
  • override_params[container_expiration_policy_attributes][enabled] — Flag indication if container expiration policy is enabled
  • override_params[lfs_enabled] — Flag indication if Git LFS is enabled for that project
  • override_params[visibility] — The visibility of the project.
  • override_params[public_builds] — Deprecated: Use public_jobs instead.
  • override_params[public_jobs] — Perform public builds
  • override_params[request_access_enabled] — Allow users to request member access
  • override_params[only_allow_merge_if_pipeline_succeeds] — Only allow to merge if builds succeed
  • override_params[allow_merge_on_skipped_pipeline] — Allow to merge if pipeline is skipped
  • override_params[only_allow_merge_if_all_discussions_are_resolved] — Only allow to merge if all threads are resolved
  • override_params[tag_list] — Deprecated: Use :topics instead
  • override_params[topics] — The list of topics for a project
  • override_params[avatar] — Avatar image for project
  • override_params[printing_merge_request_link_enabled] — Show link to create/view merge request when pushing from the command line
  • override_params[merge_method] — The merge method used when merging merge requests
  • override_params[suggestion_commit_message] — The commit message used to apply merge request suggestions
  • override_params[merge_commit_template] — Template used to create merge commit message
  • override_params[squash_commit_template] — Template used to create squash commit message
  • override_params[issue_branch_template] — Template used to create a branch from an issue
  • override_params[auto_devops_enabled] — Flag indication if Auto DevOps is enabled
  • override_params[auto_devops_deploy_strategy] — Auto Deploy strategy
  • override_params[autoclose_referenced_issues] — Flag indication if referenced issues auto-closing is enabled
  • override_params[repository_storage] — Which storage shard the repository is on. Available only to admins
  • override_params[packages_enabled] — Enable project packages feature
  • override_params[squash_option] — Squash default for project. One of never, always, default_on, or default_off.
  • override_params[mr_default_target_self] — Merge requests of this forked project targets itself by default
  • override_params[only_allow_merge_if_all_status_checks_passed] — Blocks merge requests from merging unless all status checks have passed
  • override_params[approvals_before_merge] — How many approvers should approve merge request by default
  • override_params[mirror] — [Deprecated] Enables pull mirroring in a project
  • override_params[mirror_trigger_builds] — [Deprecated] Pull mirroring triggers builds
  • override_params[external_authorization_classification_label] — The classification label for the project
  • override_params[requirements_access_level] — Requirements feature access level. One of disabled, private or enabled
  • override_params[prevent_merge_without_jira_issue] — Require an associated issue from Jira

Output shape

Returns the created project object as JSON.

If the import is queued, returns import status details.

Examples

Example 1: Import project from S3

Provide S3 credentials, bucket, file key, region, and target project path/name.

Links

Discussion