Preview a badge from a project.

GET /projects/{id}/badges/render
Api key auth

This feature was introduced in GitLab 10.6.

Path parameters

  • id string Required

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

Query parameters

  • image_url string Required

    URL of the badge image

Responses

  • 200 application/json

    Preview a badge from a project.

    Hide response attributes Show response attributes object
    • name string
    • link_url string
    • image_url string
    • rendered_link_url string
    • rendered_image_url string
GET /projects/{id}/badges/render 
curl \
 --request GET 'https://www.gitlab.com/api/v4/projects/{id}/badges/render?link_url=string&image_url=string' \
 --header "Private-Token: $API_KEY"
Response examples (200) 
{
  "name": "string",
  "link_url": "string",
  "image_url": "string",
  "rendered_link_url": "string",
  "rendered_image_url": "string"
}