GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation allows updating the trace log of a specific job in GitLab by sending a PATCH request to the GitLab API endpoint `/api/v4/jobs/{id}/trace`. It is useful for scenarios where you need to modify or append trace information for a job, such as updating job logs or debugging job execution in CI/CD pipelines.

Use Case Examples

  1. Updating the trace log of a job with a specific job ID to add additional debugging information.
  2. Modifying the job trace to correct or append log data after job execution.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
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.
Method The HTTP method used for the request, which is PATCH for this operation.
Path Parameters The path parameters for the API request, specifically the job ID to identify which job's trace to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the job trace, typically containing the updated trace information or status.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the job ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to update job traces.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages may include authentication failures, invalid job ID, or insufficient permissions. Resolving these involves verifying credentials, job existence, and user permissions.

Links

Discussion