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 snippets API

Operations about snippets

GitLab CI/CD snippets 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 Snippets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 18 operations across 12 paths, and defines 10 schemas. It is described by OpenAPI 2.0, at version v4.

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

18 operations 12 paths 10 schemas 2 DELETE12 GET2 POST2 PUT

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 snippets 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 18

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

snippets 18

Operations about snippets

GET
/api/v4/projects/{id}/snippets
Get all project snippets
getApiV4ProjectsIdSnippets 3 params → 200404
POST
/api/v4/projects/{id}/snippets
Create a new project snippet
postApiV4ProjectsIdSnippets 2 params → 201400404422
GET
/api/v4/projects/{id}/snippets/{snippet_id}
Get a single project snippet
getApiV4ProjectsIdSnippetsSnippetId 2 params → 200404
PUT
/api/v4/projects/{id}/snippets/{snippet_id}
Update an existing project snippet
putApiV4ProjectsIdSnippetsSnippetId 3 params → 200400404422
DELETE
/api/v4/projects/{id}/snippets/{snippet_id}
Delete a project snippet
deleteApiV4ProjectsIdSnippetsSnippetId 2 params → 204400404
GET
/api/v4/projects/{id}/snippets/{snippet_id}/raw
Get a raw project snippet
getApiV4ProjectsIdSnippetsSnippetIdRaw 2 params → 200404
GET
/api/v4/projects/{id}/snippets/{snippet_id}/files/{ref}/{file_path}/raw
Get raw project snippet file contents from the repository
getApiV4ProjectsIdSnippetsSnippetIdFilesRefFilePathRaw 4 params → 200404
GET
/api/v4/projects/{id}/snippets/{snippet_id}/user_agent_detail
Get the user agent details for a project snippet
getApiV4ProjectsIdSnippetsSnippetIdUserAgentDetail 2 params → 200404
GET
/api/v4/snippets
Get a snippets list for an authenticated user
getApiV4Snippets 4 params → 200404
POST
/api/v4/snippets
Create new snippet
postApiV4Snippets 1 param → 201400404422
GET
/api/v4/snippets/public
List all public personal snippets currentuser has access to
getApiV4SnippetsPublic 4 params → 200404
GET
/api/v4/snippets/all
List all snippets currentuser has access to
getApiV4SnippetsAll 5 params → 200404
GET
/api/v4/snippets/{id}
Get a single snippet
getApiV4SnippetsId 1 param → 200404
PUT
/api/v4/snippets/{id}
Update an existing snippet
putApiV4SnippetsId 2 params → 200400404422
DELETE
/api/v4/snippets/{id}
Remove snippet
deleteApiV4SnippetsId 1 param → 400204404
GET
/api/v4/snippets/{id}/raw
Get a raw snippet
getApiV4SnippetsIdRaw 1 param → 200404
GET
/api/v4/snippets/{id}/files/{ref}/{file_path}/raw
Get raw snippet file contents from the repository
getApiV4SnippetsIdFilesRefFilePathRaw 3 params → 200404
GET
/api/v4/snippets/{id}/user_agent_detail
Get the user agent details for a snippet
getApiV4SnippetsIdUserAgentDetail 1 param → 200404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are API_Entities_ProjectSnippet (17 properties), API_Entities_PersonalSnippet (17 properties), API_Entities_Snippet (17 properties), API_Entities_UserBasic (10 properties). Each schema is shown below with its type and property counts.

API_Entities_UserAgentDetail
object
APIEntitiesUserAgentDetail model
3 properties 3 required
API_Entities_CustomAttribute
object
APIEntitiesCustomAttribute model
2 properties 2 required
putApiV4SnippetsId
object
Update an existing snippet
6 properties
postApiV4Snippets
object
Create new snippet
6 properties 2 required
API_Entities_ProjectSnippet
object
APIEntitiesProjectSnippet model
17 properties 14 required
putApiV4ProjectsIdSnippetsSnippetId
object
Update an existing project snippet
6 properties
API_Entities_UserBasic
object
APIEntitiesUserBasic model
10 properties 8 required
API_Entities_Snippet
object
APIEntitiesSnippet model
17 properties 14 required
postApiV4ProjectsIdSnippets
object
Create a new project snippet
6 properties 3 required
API_Entities_PersonalSnippet
object
APIEntitiesPersonalSnippet model
17 properties 14 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-snippets-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 snippets 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.