GIgitlab
badges

Retrieve a badge preview for a project

Previews the final link_url and image_url for a specified project after resolving the placeholder interpolation.

get/api/v4/projects/{id}/badges/render

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID or URL-encoded path of the project owned by the authenticated user.

Query parameters

link_urlstring required

URL of the badge link

image_urlstring required

URL of the badge image

Response

Retrieve a badge preview for a project

namestring required
link_urlstring required
image_urlstring required
rendered_link_urlstring required
rendered_image_urlstring required

Example response

{
  "name": "Pipeline Status",
  "link_url": "https://example.gitlab.com",
  "image_url": "https://example.gitlab.com",
  "rendered_link_url": "https://example.gitlab.com",
  "rendered_image_url": "https://example.gitlab.com"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.