GitLab API

GitlabTool

Actions1095

Environments → getApiV4ProjectsIdEnvironments

AI-generated

Summary

Lists environments for a GitLab project with a GET request to /api/v4/projects/{id}/environments by default. Set the project ID or URL-encoded path, then optionally filter by name, search text, or environment state and choose pagination values.

Inputs

  • skipAuthentication — Skips authentication when enabled; authentication is enabled by default.
  • baseUrl — GitLab instance URL; defaults to https://gitlab.com. The node source says the actual base URL is defined in the GitLab API credential.
  • method — HTTP method, defaulting to GET. The UI also offers POST, PUT, DELETE, HEAD, and PATCH.
  • pathParameters.id (required) — Project ID or URL-encoded project path.
  • queryParameters.page — Page number for pagination; the API schema defaults to 1.
  • queryParameters.per_page — Number of environments per page; the API schema defaults to 20.
  • queryParameters.name — Return the environment with this exact name; mutually exclusive with search.
  • queryParameters.search — Search for matching environments. Mutually exclusive with name and must be at least 3 characters.
  • queryParameters.states — Filter by available, stopping, or stopped; omit to include all states.

Output shape

A response from the GitLab environments API.

The supplied source shows the node delegates request handling to its OpenAPI base class, so it does not establish the exact response shape. The API schema describes a list of environments with pagination parameters.

Links

Discussion