GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves deployment information for a specific project in GitLab using the GitLab API. It is useful for scenarios where users want to monitor or analyze deployment statuses, history, or details for a project they own or have access to. For example, a DevOps engineer might use this node to fetch deployment data to integrate with a dashboard or automate deployment status checks.

Use Case Examples

  1. Fetch deployments for a project by its ID to monitor deployment statuses.
  2. Retrieve deployments filtered by environment or status to analyze deployment success rates.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters to filter and paginate the deployments data.
Path Parameters Path parameters for the request, 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.
  • ref - Reference branch or tag for 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.
  • deployable
    • status - Status of the deployable associated with the deployment.

Dependencies

  • GitLab API authentication token or credentials

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, particularly date-time filters in ISO 8601 format.
  • Common error messages may include authentication failures, invalid project ID, or rate limiting by the GitLab API. Resolving these involves checking credentials, project access rights, and API usage limits.

Links

Discussion