How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitLab CI/CD protected_branches API

Operations about protected_branches

GitLab CI/CD protected_branches API is one of 98 APIs that GitLab CI/CD publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Protected Branches. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 2.0, at version v4.

Requests are made against the base URL https://gitlab.com/api/v4.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v4
Base URL
https://gitlab.com/api/v4
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

GitLab CI/CD protected_branches API declares 2 security schemes for authenticating requests. An API key is passed in the header as PRIVATE-TOKEN (access_token_header). An API key is passed in the query as private_token (access_token_query).

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

protected_branches 5

Operations about protectedbranches

GET
/api/v4/projects/{id}/protected_branches
Get a project's protected branches
getApiV4ProjectsIdProtectedBranches 4 params → 200404401
POST
/api/v4/projects/{id}/protected_branches
Protect a single branch
postApiV4ProjectsIdProtectedBranches 2 params → 201422409404401
GET
/api/v4/projects/{id}/protected_branches/{name}
Get a single protected branch
getApiV4ProjectsIdProtectedBranchesName 2 params → 200404401
PATCH
/api/v4/projects/{id}/protected_branches/{name}
Update a protected branch
patchApiV4ProjectsIdProtectedBranchesName 3 params → 200422404401400
DELETE
/api/v4/projects/{id}/protected_branches/{name}
Unprotect a single branch
deleteApiV4ProjectsIdProtectedBranchesName 2 params → 204404401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are postApiV4ProjectsIdProtectedBranches (9 properties), API_Entities_ProtectedBranch (8 properties), patchApiV4ProjectsIdProtectedBranchesName (6 properties), API_Entities_ProtectedRefAccess (6 properties). Each schema is shown below with its type and property counts.

API_Entities_ProtectedRefAccess
object
6 properties 5 required
patchApiV4ProjectsIdProtectedBranchesName
object
Update a protected branch
6 properties
postApiV4ProjectsIdProtectedBranches
object
Protect a single branch
9 properties 1 required
API_Entities_ProtectedBranch
object
APIEntitiesProtectedBranch model
8 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-protected-branches-api-openapi.yml Raw ↑

Other APIs GitLab CI/CD publishes across the network.

GitLab GraphQL API
GitLab CI/CD access_requests API
GitLab CI/CD access_tokens API
GitLab CI/CD agents API
GitLab CI/CD alert_management API
GitLab CI/CD applications API
GitLab CI/CD attestations API
GitLab CI/CD audit_events API
GitLab CI/CD avatars API
GitLab CI/CD award_emoji API
GitLab CI/CD badges API
GitLab CI/CD batched_background_migrations API
Where this information came from

This is an independent, third-party profile of GitLab CI/CD protected_branches API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.