summaryrefslogtreecommitdiff
path: root/doc/api/forks.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/forks.md')
-rw-r--r--doc/api/forks.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/api/forks.md b/doc/api/forks.md
new file mode 100644
index 0000000..1a5ea80
--- /dev/null
+++ b/doc/api/forks.md
@@ -0,0 +1,23 @@
+# Forks API
+
+This API is intended to aid in the setup and configuration of
+forked projects on Gitlab CI.
+
+__Authentication is done by GitLab user token & GitLab project token__
+
+## Forks
+
+### Create fork for project
+
+
+
+```
+POST /forks
+```
+
+Parameters:
+
+ project_id (required) - The ID of a project
+ project_token (requires) - Project token
+ private_token(required) - User private token
+ data (required) - GitLab project data (name_with_namespace, web_url, default_branch, ssh_url_to_repo)