GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node interacts with the GitLab API to perform HTTP requests on the /api/v4/job endpoint, specifically supporting the 'getApiV4Job' operation. It allows users to retrieve job-related information from GitLab by making GET or other HTTP method requests to the specified API path. This is useful for automating CI/CD pipeline job queries or integrating job status checks into workflows.

Use Case Examples

  1. Retrieve details of a specific GitLab CI/CD job by making a GET request to /api/v4/job endpoint.
  2. Use POST or other HTTP methods to interact with the job API for advanced operations if supported.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request, useful for public or unauthenticated API access.
Authentication Selects the authentication method, defaulting to GitLab API key authentication, hidden if Skip Authentication is true.
baseUrl Base URL of the GitLab instance to which the API requests are sent, defaulting to https://gitlab.com.
Method 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 for the getApiV4Job operation, used internally.
Request Body Schema Hidden property for the schema of the request body for the getApiV4Job operation, used internally.
Request Path Hidden property specifying the API endpoint path, defaulting to /api/v4/job for this operation.

Output

JSON

  • response - The JSON response from the GitLab API for the job request, containing job details or status information.

Dependencies

  • GitLab API key credential for authentication unless Skip Authentication is enabled.

Troubleshooting

  • Ensure the baseUrl is correct and accessible; incorrect URLs will cause connection failures.
  • If authentication is required, verify that the GitLab API key credential is valid and has sufficient permissions.
  • HTTP method must be appropriate for the API endpoint; using unsupported methods may result in errors.
  • Check that the request path is correctly set to /api/v4/job for this operation.
  • Common errors include authentication failures (401 Unauthorized), resource not found (404), or permission denied (403). Verify API permissions and endpoint correctness.

Links

Discussion