GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to update the authenticated user's status via a PUT request to the /api/v4/user/status endpoint. It is useful for automating status updates in GitLab, such as setting availability or custom status messages programmatically.

Use Case Examples

  1. Automatically set a user's GitLab status to 'In a meeting' during calendar events.
  2. Clear the user's GitLab status at the end of the workday.

Properties

Name Meaning
Skip Authentication If true, the node will skip using authentication for the request.
Authentication The authentication method used for the request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET but set to PUT for this operation.
Parameter Schema Defines the schema for the parameters sent in the request body for the putApiV4UserStatus operation.
Request Body Schema Defines the schema for the request body for the putApiV4UserStatus operation.
Request Path The API endpoint path for updating the user status, fixed to /api/v4/user/status.

Output

JSON

  • status - The updated user status information returned from GitLab API after the PUT request.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is valid and has permission to update user status.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that the request body matches the expected schema for updating user status to avoid validation errors.

Links

Discussion