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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
GitLab CI/CD

GitLab CI/CD environments API

Operations related to environments

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

8 operations 5 paths 22 schemas 2 DELETE2 GET3 POST1 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 environments 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 8

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

environments 8

Operations related to environments

GET
/api/v4/projects/{id}/environments
List environments
getApiV4ProjectsIdEnvironments 6 params → 200401404
POST
/api/v4/projects/{id}/environments
Create a new environment
postApiV4ProjectsIdEnvironments 2 params → 201400401404
PUT
/api/v4/projects/{id}/environments/{environment_id}
Update an existing environment
putApiV4ProjectsIdEnvironmentsEnvironmentId 3 params → 200400401404
DELETE
/api/v4/projects/{id}/environments/{environment_id}
Delete an environment
deleteApiV4ProjectsIdEnvironmentsEnvironmentId 2 params → 401204404
GET
/api/v4/projects/{id}/environments/{environment_id}
Get a specific environment
getApiV4ProjectsIdEnvironmentsEnvironmentId 2 params → 200401404
DELETE
/api/v4/projects/{id}/environments/review_apps
Delete multiple stopped review apps
deleteApiV4ProjectsIdEnvironmentsReviewApps 4 params → 400204401404409
POST
/api/v4/projects/{id}/environments/{environment_id}/stop
Stop an environment
postApiV4ProjectsIdEnvironmentsEnvironmentIdStop 3 params → 201400401404
POST
/api/v4/projects/{id}/environments/stop_stale
Stop stale environments
postApiV4ProjectsIdEnvironmentsStopStale 2 params → 201400401

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are API_Entities_User (27 properties), API_Entities_Ci_Job (27 properties), API_Entities_BasicProjectDetails (24 properties), API_Entities_Environment (16 properties). Each schema is shown below with its type and property counts.

API_Entities_CustomAttribute
object
APIEntitiesCustomAttribute model
2 properties 2 required
API_Entities_Ci_Runner
object
APIEntitiesCiRunner model
13 properties 12 required
API_Entities_Ci_RunnerManager
object
APIEntitiesCiRunnerManager model
11 properties 11 required
API_Entities_UserBasic
object
APIEntitiesUserBasic model
10 properties 8 required
postApiV4ProjectsIdEnvironmentsStopStale
object
Stop stale environments
1 property 1 required
API_Entities_ProjectIdentity
object
7 properties 7 required
API_Entities_User
object
27 properties 21 required
API_Entities_Environment
object
APIEntitiesEnvironment model
16 properties 12 required
postApiV4ProjectsIdEnvironmentsEnvironmentIdStop
object
Stop an environment
1 property
API_Entities_Ci_PipelineBasic
object
APIEntitiesCiPipelineBasic model
10 properties 10 required
API_Entities_Ci_JobArtifact
object
4 properties 4 required
API_Entities_Commit
object
APIEntitiesCommit model
15 properties 15 required
API_Entities_EnvironmentBasic
object
APIEntitiesEnvironmentBasic model
6 properties 6 required
postApiV4ProjectsIdEnvironments
object
Create a new environment
8 properties 1 required
API_Entities_NamespaceBasic
object
8 properties 8 required
API_Entities_BasicProjectDetails
object
APIEntitiesBasicProjectDetails model
24 properties 17 required
putApiV4ProjectsIdEnvironmentsEnvironmentId
object
Update an existing environment
7 properties
API_Entities_Clusters_Agent
object
APIEntitiesClustersAgent model
6 properties 6 required
API_Entities_Deployment
object
APIEntitiesDeployment model
10 properties 10 required
API_Entities_Ci_Job
object
APIEntitiesCiJob model
27 properties 24 required
API_Entities_Ci_JobArtifactFile
object
2 properties 2 required
API_Entities_LicenseBasic
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-environments-api-openapi.yml Raw ↑

Other APIs GitLab CI/CD publishes across the network.

GitLab GraphQL API
AE Profile APIs.io
GitLab CI/CD access_requests API
AE Profile APIs.io
GitLab CI/CD access_tokens API
AE Profile APIs.io
GitLab CI/CD agents API
AE Profile APIs.io
GitLab CI/CD alert_management API
AE Profile APIs.io
GitLab CI/CD applications API
AE Profile APIs.io
GitLab CI/CD attestations API
AE Profile APIs.io
GitLab CI/CD audit_events API
AE Profile APIs.io
GitLab CI/CD avatars API
AE Profile APIs.io
GitLab CI/CD award_emoji API
AE Profile APIs.io
GitLab CI/CD badges API
AE Profile APIs.io
GitLab CI/CD batched_background_migrations API
AE Profile APIs.io
#Environments
← Back to G APIs
API Details
ID
gitlab-ci:gitlab-ci-environments-api
Base URL
https://gitlab.com/api/v4
Docs
https://docs.gitlab.com/api/
Provider
GitLab CI/CD
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=gitlab-ci-environments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gitlab-ci-environments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of GitLab CI/CD environments 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.