Pipeline triggers API (FREE)

You can read more about triggering pipelines through the API.

List project triggers

Get a list of project's build triggers.

GET /projects/:id/triggers

Attribute	Type	required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/triggers"

[
    {
        "id": 10,
        "description": "my trigger",
        "created_at": "2016-01-07T09:53:58.235Z",
        "last_used": null,
        "token": "6d056f63e50fe6f8c5f8f4aa10edb7",
        "updated_at": "2016-01-07T09:53:58.235Z",
        "owner": null
    }
]

The trigger token is displayed in full if the trigger token was created by the authenticated user. Trigger tokens created by other users are shortened to four characters.

Get trigger details

Get details of project's build trigger.

GET /projects/:id/triggers/:trigger_id

Attribute	Type	required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user
`trigger_id`	integer	yes	The trigger ID

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/triggers/5"

{
    "id": 10,
    "description": "my trigger",
    "created_at": "2016-01-07T09:53:58.235Z",
    "last_used": null,
    "token": "6d056f63e50fe6f8c5f8f4aa10edb7",
    "updated_at": "2016-01-07T09:53:58.235Z",
    "owner": null
}

Create a project trigger

Create a trigger for a project.

POST /projects/:id/triggers

Attribute	Type	required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user
`description`	string	yes	The trigger name

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --form description="my description" "https://gitlab.example.com/api/v4/projects/1/triggers"

{
    "id": 10,
    "description": "my trigger",
    "created_at": "2016-01-07T09:53:58.235Z",
    "last_used": null,
    "token": "6d056f63e50fe6f8c5f8f4aa10edb7",
    "updated_at": "2016-01-07T09:53:58.235Z",
    "owner": null
}

Update a project trigger

Update a trigger for a project.

PUT /projects/:id/triggers/:trigger_id

Attribute	Type	required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user
`trigger_id`	integer	yes	The trigger ID
`description`	string	no	The trigger name

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     --form description="my description" "https://gitlab.example.com/api/v4/projects/1/triggers/10"

{
    "id": 10,
    "description": "my trigger",
    "created_at": "2016-01-07T09:53:58.235Z",
    "last_used": null,
    "token": "6d056f63e50fe6f8c5f8f4aa10edb7",
    "updated_at": "2016-01-07T09:53:58.235Z",
    "owner": null
}

Remove a project trigger

Remove a project's build trigger.

DELETE /projects/:id/triggers/:trigger_id

Attribute	Type	required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user
`trigger_id`	integer	yes	The trigger ID

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/triggers/5"