GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node interacts with the GitLab API to perform operations related to jobs, specifically the 'getApiV4Job' operation. It allows users to make HTTP requests (GET, POST, PUT, DELETE, HEAD, PATCH) to the GitLab API endpoint for jobs, enabling retrieval or manipulation of job data within GitLab projects. This is useful for automating CI/CD pipeline job management, monitoring job statuses, or integrating job data into other workflows.

Use Case Examples

  1. Retrieve details of a specific job in a GitLab project using the GET method.
  2. Trigger a job-related action by sending a POST request to the job API endpoint.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request, useful for public endpoints or testing.
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 requests are sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, such as GET, POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Hidden property for the schema of parameters accepted by the operation, used internally.
Request Body Schema Hidden property for the schema of the request body accepted by the operation, used internally.
Request Path Hidden property specifying the API path for the job operation, defaulting to /api/v4/job.

Output

JSON

  • responseData - The JSON response data returned from the GitLab API for the job operation.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the baseUrl is correct and accessible to avoid connection errors.
  • If authentication is required and skipped, the request may fail with authorization errors.
  • Verify the HTTP method matches the intended API action to prevent method not allowed errors.
  • Check the request path and parameters for correctness to avoid 404 or bad request errors.

Links

Discussion