GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 specifying the project ID and filter by deployment status or date range.
  2. Retrieve paginated deployment records ordered by creation date for audit or reporting purposes.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated access.
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 filters and pagination parameters for the deployments request, such as page number, items per page, order, sort direction, date filters, environment name, and deployment status.
Path Parameters Path parameters including the project ID or URL-encoded path to specify which project's deployments to retrieve.

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
  • ref - Git reference (branch or tag) associated with the deployment
  • environment - Name of the environment where the deployment occurred
  • status - Current status of the deployment (e.g., created, running, success, failed, canceled, skipped, blocked)

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly specified in the path parameters to avoid 404 errors.
  • Verify that the authentication token has sufficient permissions to access the project's deployment data.
  • Check that date filters are in ISO 8601 format to prevent request validation errors.
  • If skipping authentication, confirm that the GitLab instance allows unauthenticated access to deployment data.

Links

Discussion