Retrieve a badge preview for a group

GET

/api/v4/groups/{id}/badges/render

• GitLab REST API

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

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

string

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

Query Parameters

link_url

required

string

nullable

URL of the badge link

image_url

required

string

nullable

URL of the badge image

Responses

200

OK

Media type application/json

object

name

string

link_url

string

image_url

string

rendered_link_url

string

rendered_image_url

string

Example

{
  "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"
}

400

Bad Request

404

Not Found