GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation resets the authentication token for GitLab runners via the GitLab API. It is useful for managing CI/CD runners in GitLab projects, especially when you need to invalidate and regenerate runner tokens for security or operational reasons. For example, if a runner's token is compromised or needs to be refreshed, this operation can be triggered to reset it securely.

Use Case Examples

  1. Resetting a GitLab runner's authentication token to ensure security after a potential token leak.
  2. Automating the management of runner tokens in a CI/CD pipeline setup to maintain token freshness.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the 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 API request, defaulting to GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Defines the schema for the parameters sent in the request body, required for this operation.
Request Body Schema Defines the schema for the request body, if applicable.
Request Path The API endpoint path for resetting the runner's authentication token.

Output

JSON

  • token - The new authentication token for the GitLab runner after reset.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to reset runner tokens.
  • Verify the baseUrl is correctly set to the GitLab instance URL.
  • Check that the HTTP method is set appropriately, typically POST for this operation.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated requests for this endpoint, which is uncommon.

Links

Discussion