GitLab API icon

GitLab API

Gitlab

Actions917

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 activities within their GitLab projects. For example, a DevOps engineer might use this node to fetch deployment statuses and details to integrate with a CI/CD dashboard or automate deployment reporting.

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 Option to skip authentication when making 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 list, such as page number, items per page, order, sort direction, date filters, environment name, and deployment status.
Path Parameters Path parameter specifying the project ID or URL-encoded path to identify the project for which deployments are retrieved.

Output

JSON

  • id - Unique identifier of the deployment.
  • iid - Internal ID of the deployment within the project.
  • ref - Reference branch or tag associated with the deployment.
  • status - Current status of the deployment (e.g., created, running, success).
  • 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 - Name of the environment where the deployment occurred.
  • user
    • name - Name of the user who triggered the deployment.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID or URL-encoded path is correct and accessible by the authenticated user to avoid authorization errors.
  • Verify that the base URL is correct, especially if using a self-hosted GitLab instance.
  • Check that the query parameters are formatted correctly, especially date-time filters in ISO 8601 format.
  • Common error messages include 401 Unauthorized (authentication issues), 404 Not Found (invalid project ID or path), and 400 Bad Request (invalid query parameters). Resolving these involves verifying credentials, project identifiers, and parameter formats.

Links

Discussion