GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves deployment information for a specific project from the GitLab API (v4). It is useful for users who want to monitor or analyze deployment statuses, environments, and timelines within their GitLab projects. For example, a DevOps engineer might use this node to fetch recent deployment data to track deployment success rates or to filter deployments by status or environment.

Use Case Examples

  1. Fetch all deployments for a project with ID '123' to monitor deployment history.
  2. Retrieve deployments filtered by status 'success' to analyze successful deployments only.
  3. Get deployments updated after a specific date to track recent deployment activities.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Parameter Schema Defines the parameters accepted by the API endpoint, including path and query parameters such as project ID, pagination, sorting, filtering by date, environment, and status.
Query Parameters Collection of optional query parameters to filter and paginate the deployments, such as page number, items per page, order, sort direction, date filters, environment name, and deployment status.
Path Parameters Path parameters required by the API endpoint, specifically the project ID or URL-encoded path.

Output

JSON

  • id - Unique identifier of the deployment.
  • iid - Internal ID of the deployment within the project.
  • created_at - Timestamp when the deployment was created.
  • updated_at - Timestamp when the deployment was last updated.
  • finished_at - Timestamp when the deployment finished.
  • environment - Name of the environment where the deployment occurred.
  • status - Current status of the deployment, e.g., created, running, success, failed, canceled, skipped, or blocked.

Dependencies

  • Requires GitLab API credentials for authentication unless skipping authentication is enabled.

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • Verify that the GitLab API credentials are valid and have sufficient permissions to access deployment data.
  • Check that date filters (updated_after, updated_before, finished_after, finished_before) are in ISO 8601 format to avoid request errors.
  • If no deployments are returned, confirm that the project has deployments matching the filter criteria.

Links

Discussion