GitLab API icon

GitLab API

Gitlab

Actions1062

Badges → getApiV4ProjectsIdBadgesRender

AI-generated

Summary

Render a badge image for a specified GitLab project using the project's ID or URL-encoded path and return the badge's rendered output as served by the GitLab API.

Inputs

  • id (required) — The ID or URL-encoded path of the project owned by the authenticated user to which the badge belongs.
  • link_url (required) — The URL that the badge will link to when clicked.
  • image_url (required) — The URL of the badge image to render.
  • method — HTTP method to use for the request, defaulting to GET.
  • baseUrl — The base URL of the GitLab instance, defaulting to https://gitlab.com.
  • skipAuthentication — Optional flag to skip authentication. Defaults to false, meaning authentication is used.

Output shape

binary data stream representing the rendered badge image or content served by the GitLab badges render endpoint

The response is the raw output of the API call to /api/v4/projects/{id}/badges/render and may vary by content type. Pagination does not apply and errors are returned as HTTP responses.

Links

Discussion