Skip to content

Latest commit

 

History

History
135 lines (115 loc) · 7.12 KB

README.md

File metadata and controls

135 lines (115 loc) · 7.12 KB

Gitlab APIs (V4) - Postman_collection


Usage

  • Open Postman and hit Import, next to the workspace in which you'd like to have such collection;

  • Upload the api_v4_collection.json collection and begin to use it right away!

  • Create two environments - one for Gitlab Sandbox, another for Gitlab Production, fill in the ENV vars for your own domains (within an ENV var named CI_API_V4_URL - use the same var name within each environment) and for authorization (within an ENV var named ACCESS_TOKEN - use the same var name within each environment) towards such domains and then test your infrastructures by easily switching between the environments created. This way, the present collection, powered by Postman, would know to fill in those two ENV vars within every API that would need those, leaving you only the custom options to complete the APIs with company-proprietary information, such a specific commit_sha, project_id, etc., per your own needs, considering the specific APIs used.

Which API Schemas can be found in here?

Note: It's not complete, but contains the most used APIs. You can extend over it!

🟩 BRANCHES
  🟢 GET     Branches
  🟢 GET     Branch
  🟡 POST   Branch
  🟠 DEL     Branch
  🟠 DEL     Merged Branches
  🟢 GET     Protected Branches
  🟢 GET     Protected Branch or Wildcard Branch(es) Protection
  🟡 POST   Protected Branch(es)
  🟤 PATCH Protected Branch
  🟠 DEL     Unprotected Branch(es)

🟩 COMMITS
  🟢 GET     Commits
  🟢 GET     Commit
  🟢 GET     Commit's References
  🟢 GET     Commit's Diff

🟩 GROUPS
  🟢 GET     Groups
  🟢 GET     Group by ID
  🟢 GET     Group(s) by Name
  🟡 POST   Group
  🟠 DEL     Group
  🟢 GET     Group's Subgroups
  🟢 GET     Group's Descendent Groups
  🟢 GET     Group's Projects
  🟢 GET     Group's Shared Projects
  🟢 GET     Group's Push Rules
  🟢 GET     Group's Members
  🟣 PUT     Member's Access
  🟠 DEL     Member

🟩 PROJECTS
  🟢 GET     Projects
  🟢 GET     Project by ID
  🟢 GET     Project(s) by Name
  🟢 GET     Project's Users
  🟢 GET     Project's Members
  🟣 PUT     Member's Access
  🟠 DEL     Member
  🟢 GET     Project's Push Rules
  🟢 GET     Trigger Tokens

🟩 MERGE REQUESTS
  🟢 GET     Merge Request
  🟢 GET     Project's MRs
  🟢 GET     Group's MRs
  🟢 GET     Commit's MRs
  🟢 GET     Merge Request's Diffs
  🟠 DEL     Merge Request
  🟣 PUT     Merge a Merge Request

🟩 PIPELINES
  🟢 GET     Pipelines
  🟢 GET     Pipeline
  🟡 POST   Pipeline
  🟠 DEL     Pipeline
  🟢 GET     Latest Pipeline
  🟢 GET     Scheduled Pipelines
  🟢 GET     Scheduled Pipeline
  🟡 POST   Retry Pipeline's Jobs
  🟡 POST   Cancel a Pipeline

🟩 SEARCH
  🟩 ADVANCED SEARCH
    🟢 GET     Scope: projects
    🟢 GET     Scope: issues
    🟢 GET     Scope: merge requests
    🟢 GET     Scope: milestones
    🟢 GET     Scope: snippet titles
    🟢 GET     Scope: users

  🟩 GROUP SEARCH
    🟢 GET     Scope: projects
    🟢 GET     Scope: issues
    🟢 GET     Scope: merge requests
    🟢 GET     Scope: milestones
    🟢 GET     Scope: users

  🟩 PROJECT SEARCH
    🟢 GET     Scope: issues
    🟢 GET     Scope: merge requests
    🟢 GET     Scope: milestones
    🟢 GET     Scope: users

🟩 TAGS
  🟢 GET     Tags
  🟢 GET     Tag
  🟡 POST   Tag
  🟠 DEL     Tag
  🟢 GET     Protected Tags
  🟢 GET     Protected Tag
  🟡 POST   Protect Tag(s)
  🟠 DEL     Unprotect Tag(s)

🟩 VARIABLES (Group)
  🟢 GET     Variables
  🟢 GET     Variable
  🟡 POST   Variable
  🟣 PUT     Variable
  🟠 DEL     Variable

🟩 VARIABLES (Project)
  🟢 GET     Variables
  🟢 GET     Variable
  🟡 POST   Variable
  🟣 PUT     Variable
  🟠 DEL     Variable

🟩 VERSION (of Gitlab)
  🟢 GET     Version