Create a badge for a project

POST

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

• GitLab REST API

Creates a badge for a specified project.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

string

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

Request Body ^required

Media type application/json

object

link_url

required

URL of the badge link

string

nullable

image_url

required

URL of the badge image

string

nullable

name

Name for the badge

string

nullable

Example ^generated

{
  "link_url": "example",
  "image_url": "example",
  "name": "example"
}

Responses

201

Created

Media type application/json

object

name

string

link_url

string

image_url

string

rendered_link_url

string

rendered_image_url

string

id

integer format: int64

kind

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",
  "id": 1,
  "kind": "project"
}

400

Bad Request

404

Not Found