GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves deploy tokens for a specific project in GitLab using the GitLab API. It is useful for scenarios where you need to manage or audit deploy tokens associated with a project, such as automating token retrieval for deployment automation or security reviews.

Use Case Examples

  1. Retrieve all deploy tokens for a project by specifying the project ID.
  2. Filter deploy tokens by active status to get only currently valid tokens.
  3. Paginate through deploy tokens if there are many, by setting page and per_page parameters.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key.
baseUrl The base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Query Parameters Optional query parameters to filter or paginate the deploy tokens.
Path Parameters Path parameters required for the API endpoint, specifically the project ID.

Output

JSON

  • ``
    • id - The unique identifier of each deploy token.
    • name - The name of each deploy token.
    • username - The username associated with each deploy token.
    • expires_at - The expiration date of each deploy token.
    • scopes - The scopes or permissions granted to each deploy token.
    • active - The active status of each deploy token.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access deploy tokens.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • If pagination parameters are used, ensure they are valid integers and within allowed ranges.

Links

Discussion