GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation resets the registration token for GitLab group runners. It is useful when you want to invalidate the current registration token for a group's runners and generate a new one, enhancing security or managing runner access. For example, if a group's runner token is compromised or needs to be refreshed, this operation can be triggered to reset it.

Use Case Examples

  1. Resetting the registration token for a specific GitLab group to prevent unauthorized runner registrations.
  2. Automating the process of rotating group runner tokens for security compliance.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used for the request, typically a GitLab API key.
baseUrl The base URL of the GitLab instance to which the request is sent.
Method The HTTP method used for the request, default is GET but POST is used for this operation.
Path Parameters The path parameters for the request, specifically the group ID whose runner registration token is to be reset.

Output

JSON

  • id - The ID of the group for which the runner registration token was reset.
  • runners_token - The new runners registration token generated after reset.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group 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 reset the group's runner registration token.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages may include authentication failures, invalid group ID, or insufficient permissions. Resolving these typically involves verifying credentials, permissions, and input parameters.

Links

Discussion