GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves detailed information about a specific deployment within a GitLab project. It is useful for scenarios where users need to monitor or audit deployment statuses, track deployment history, or integrate deployment data into workflows. For example, a DevOps engineer might use this node to fetch deployment details to trigger notifications or update dashboards.

Use Case Examples

  1. Fetch deployment details by providing the project ID and deployment ID to monitor deployment status.
  2. Integrate deployment information into a CI/CD pipeline to automate post-deployment tasks.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request, useful for public or unauthenticated endpoints.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method HTTP method used for the API request, default is GET.
Path Parameters Parameters required in the API path to specify the project and deployment IDs.

Output

JSON

  • id - The unique identifier of the deployment.
  • iid - Internal ID of the deployment within the project.
  • ref - The Git reference (branch or tag) associated with the deployment.
  • sha - The commit SHA associated with the deployment.
  • status - Current status of the deployment (e.g., success, failed, running).
  • created_at - Timestamp when the deployment was created.
  • updated_at - Timestamp when the deployment was last updated.
  • environment - Details about the environment where the deployment occurred.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and deployment ID are correctly provided and exist in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to access deployment information.
  • If skipping authentication, confirm that the GitLab instance allows unauthenticated access to deployment data, which is uncommon.

Links

Discussion