GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation allows creating a new environment within a specified GitLab project by sending a POST request to the GitLab API endpoint `/api/v4/projects/{id}/environments`. It is useful for automating environment management in GitLab projects, such as setting up staging, production, or testing environments programmatically.

Use Case Examples

  1. Automatically create a new deployment environment in a GitLab project when a new feature branch is merged.
  2. Set up multiple environments for a project during CI/CD pipeline execution.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but here POST is used for creating environments.
Path Parameters Parameters included in the request path, specifically the project ID or URL-encoded path required to identify the project in GitLab.

Output

JSON

  • id - The unique identifier of the created environment.
  • name - The name of the created environment.
  • slug - A URL-friendly slug for the environment.
  • external_url - The external URL associated with the environment.
  • project_id - The ID of the project to which the environment belongs.
  • state - The current state of the environment (e.g., available, stopped).
  • created_at - Timestamp when the environment was created.
  • updated_at - Timestamp when the environment was last updated.

Dependencies

  • Requires GitLab API authentication credentials unless 'Skip Authentication' is enabled.

Troubleshooting

  • Ensure the project ID provided in path parameters is correct and accessible by the authenticated user.
  • Verify that the authentication credentials are valid and have sufficient permissions to create environments in the project.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 401 Unauthorized (authentication failure), 404 Not Found (invalid project ID), and 400 Bad Request (invalid request body). Resolving these involves correcting credentials, project ID, or request payload respectively.

Links

Discussion