{ "opencollection": "1.0.0", "info": { "name": "GitLab api/v4/ Admin Projects API", "version": "v4" }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "deleteApiV4ProjectsIdRepositoryMergedBranches", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.gitlab.com/api/api/v4/projects/:id/repository/merged_branches", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Delete all merged branches" }, { "info": { "name": "getApiV4ProjectsIdRepositoryBranchesBranch", "type": "http" }, "http": { "method": "GET", "url": "https://www.gitlab.com/api/api/v4/projects/:id/repository/branches/:branch", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "42", "type": "path" } ] }, "docs": "Get a single repository branch" }, { "info": { "name": "deleteApiV4ProjectsIdRepositoryBranchesBranch", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.gitlab.com/api/api/v4/projects/:id/repository/branches/:branch", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "main", "type": "path", "description": "The name of the branch" } ] }, "docs": "Delete a branch" }, { "info": { "name": "headApiV4ProjectsIdRepositoryBranchesBranch", "type": "http" }, "http": { "method": "HEAD", "url": "https://www.gitlab.com/api/api/v4/projects/:id/repository/branches/:branch", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch" } ] }, "docs": "Check if a branch exists" }, { "info": { "name": "getApiV4ProjectsIdRepositoryBranches", "type": "http" }, "http": { "method": "GET", "url": "https://www.gitlab.com/api/api/v4/projects/:id/repository/branches", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "42", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "42", "type": "query", "description": "Number of items per page" }, { "name": "search", "value": "example_value", "type": "query", "description": "Return list of branches matching the search criteria" }, { "name": "regex", "value": "example_value", "type": "query", "description": "Return list of branches matching the regex" }, { "name": "sort", "value": "name_asc", "type": "query", "description": "Return list of branches sorted by the given field" }, { "name": "page_token", "value": "glpat-example-token", "type": "query", "description": "Name of branch to start the pagination from" } ] }, "docs": "Get a project repository branches" }, { "info": { "name": "postApiV4ProjectsIdRepositoryBranches", "type": "http" }, "http": { "method": "POST", "url": "https://www.gitlab.com/api/api/v4/projects/:id/repository/branches", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "main", "type": "query", "description": "The name of the branch" }, { "name": "ref", "value": "main", "type": "query", "description": "Create branch from commit sha or existing branch" } ] }, "docs": "Create branch" }, { "info": { "name": "putApiV4ProjectsIdRepositoryBranchesBranchUnprotect", "type": "http" }, "http": { "method": "PUT", "url": "https://www.gitlab.com/api/api/v4/projects/:id/repository/branches/:branch/unprotect", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "main", "type": "path", "description": "The name of the branch" } ] }, "docs": "Unprotect a single branch" }, { "info": { "name": "putApiV4ProjectsIdRepositoryBranchesBranchProtect", "type": "http" }, "http": { "method": "PUT", "url": "https://www.gitlab.com/api/api/v4/projects/:id/repository/branches/:branch/protect", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "main", "type": "path", "description": "The name of the branch" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protect a single branch" }, { "info": { "name": "GitLab Gets a Badge of a Project.", "type": "http" }, "http": { "method": "GET", "url": "https://www.gitlab.com/api/api/v4/projects/:id/badges/:badge_id", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." }, { "name": "badge_id", "value": "42", "type": "path", "description": "The badge ID" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "GitLab Updates a Badge of a Project.", "type": "http" }, "http": { "method": "PUT", "url": "https://www.gitlab.com/api/api/v4/projects/:id/badges/:badge_id", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." }, { "name": "badge_id", "value": "42", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "GitLab Removes a Badge from the Project.", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.gitlab.com/api/api/v4/projects/:id/badges/:badge_id", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." }, { "name": "badge_id", "value": "42", "type": "path", "description": "The badge ID" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "GitLab Gets a List of Project Badges Viewable by the Authenticated User.", "type": "http" }, "http": { "method": "GET", "url": "https://www.gitlab.com/api/api/v4/projects/:id/badges", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." }, { "name": "page", "value": "42", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "42", "type": "query", "description": "Number of items per page" }, { "name": "name", "value": "Example Project", "type": "query", "description": "Name for the badge" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "GitLab Adds a Badge to a Project.", "type": "http" }, "http": { "method": "POST", "url": "https://www.gitlab.com/api/api/v4/projects/:id/badges", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "GitLab Preview a Badge from a Project.", "type": "http" }, "http": { "method": "GET", "url": "https://www.gitlab.com/api/api/v4/projects/:id/badges/render", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." }, { "name": "link_url", "value": "https://gitlab.com/example", "type": "query", "description": "URL of the badge link" }, { "name": "image_url", "value": "https://gitlab.com/example", "type": "query", "description": "URL of the badge image" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "GitLab Denies an Access Request for the Given User.", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.gitlab.com/api/api/v4/projects/:id/access_requests/:user_id", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "user_id", "value": "42", "type": "path", "description": "The user ID of the access requester" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "GitLab Approves an Access Request for the Given User.", "type": "http" }, "http": { "method": "PUT", "url": "https://www.gitlab.com/api/api/v4/projects/:id/access_requests/:user_id/approve", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "user_id", "value": "42", "type": "path", "description": "The user ID of the access requester" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "GitLab Gets a List of Access Requests for a Project.", "type": "http" }, "http": { "method": "GET", "url": "https://www.gitlab.com/api/api/v4/projects/:id/access_requests", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "page", "value": "42", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "42", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "GitLab Requests Access for the Authenticated User to a Project.", "type": "http" }, "http": { "method": "POST", "url": "https://www.gitlab.com/api/api/v4/projects/:id/access_requests", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId", "type": "http" }, "http": { "method": "PUT", "url": "https://www.gitlab.com/api/api/v4/projects/:id/alert_management_alerts/:alert_iid/metric_images/:metric_image_id", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "alert_iid", "value": "42", "type": "path", "description": "The IID of the Alert" }, { "name": "metric_image_id", "value": "42", "type": "path", "description": "The ID of metric image" } ], "body": { "type": "multipart-form", "data": [ { "name": "url", "type": "text", "value": "" }, { "name": "url_text", "type": "text", "value": "" } ] } }, "docs": "Update a metric image for an alert" }, { "info": { "name": "deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.gitlab.com/api/api/v4/projects/:id/alert_management_alerts/:alert_iid/metric_images/:metric_image_id", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "alert_iid", "value": "42", "type": "path", "description": "The IID of the Alert" }, { "name": "metric_image_id", "value": "42", "type": "path", "description": "The ID of metric image" } ] }, "docs": "Remove a metric image for an alert" }, { "info": { "name": "getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages", "type": "http" }, "http": { "method": "GET", "url": "https://www.gitlab.com/api/api/v4/projects/:id/alert_management_alerts/:alert_iid/metric_images", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "alert_iid", "value": "42", "type": "path", "description": "The IID of the Alert" } ] }, "docs": "Metric Images for alert" }, { "info": { "name": "postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages", "type": "http" }, "http": { "method": "POST", "url": "https://www.gitlab.com/api/api/v4/projects/:id/alert_management_alerts/:alert_iid/metric_images", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "alert_iid", "value": "42", "type": "path", "description": "The IID of the Alert" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "url", "type": "text", "value": "" }, { "name": "url_text", "type": "text", "value": "" } ] } }, "docs": "Upload a metric image for an alert" }, { "info": { "name": "postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize", "type": "http" }, "http": { "method": "POST", "url": "https://www.gitlab.com/api/api/v4/projects/:id/alert_management_alerts/:alert_iid/metric_images/authorize", "params": [ { "name": "id", "value": "123456", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "alert_iid", "value": "42", "type": "path", "description": "The IID of the Alert" } ] }, "docs": "Workhorse authorize metric image file upload" }, { "info": { "name": "GitLab List Jobs for a Project", "type": "http" }, "http": { "method": "GET", "url": "https://www.gitlab.com/api/api/v4/projects/:id/jobs", "params": [ { "name": "id", "value": "42", "type": "path", "description": "The ID of the project" }, { "name": "scope", "value": "", "type": "query", "description": "Return all jobs with the specified statuses" } ] }, "docs": "GitLab List Jobs for a Project" }, { "info": { "name": "GitLab Get a Single Job by ID", "type": "http" }, "http": { "method": "GET", "url": "https://www.gitlab.com/api/api/v4/projects/:id/jobs/:job_id", "params": [ { "name": "id", "value": "42", "type": "path", "description": "The ID of the project" }, { "name": "job_id", "value": "42", "type": "path", "description": "The ID of the job" } ] }, "docs": "GitLab Get a Single Job by ID" }, { "info": { "name": "GitLab Run a Manual Job", "type": "http" }, "http": { "method": "POST", "url": "https://www.gitlab.com/api/api/v4/projects/:id/jobs/:job_id/play", "params": [ { "name": "id", "value": "42", "type": "path", "description": "The ID of the project" }, { "name": "job_id", "value": "42", "type": "path", "description": "The ID of the manual job to run" }, { "name": "job_variables_attributes", "value": "", "type": "query", "description": "An array containing the custom variables available to the job" } ] }, "docs": "GitLab Run a Manual Job" } ] } ], "bundled": true }