GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation resets the authentication token of a specific GitLab runner identified by its ID. It is useful in scenarios where the runner's authentication token needs to be refreshed or invalidated for security reasons or troubleshooting. For example, if a runner's token is compromised or needs to be rotated, this operation can be used to generate a new token.

Use Case Examples

  1. Resetting the authentication token of a GitLab runner to ensure secure communication between the runner and GitLab server.
  2. Refreshing the token after a security breach or token expiration.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process for the API request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters The path parameters for the API request, specifically the ID of the runner whose authentication token is to be reset.

Output

JSON

  • id - The ID of the runner whose authentication token was reset.
  • token - The new authentication token generated for the runner.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the runner ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API authentication credentials are correctly configured and have the necessary permissions to reset runner tokens.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages may include authentication failures, invalid runner ID, or insufficient permissions. Resolving these typically involves verifying credentials, runner existence, and user permissions.

Links

Discussion