Submodules

Use this API to update Git submodules.

Update a submodule reference

PUT /api/v4/projects/{id}/repository/submodules/{submodule}

Updates a reference for a specified submodule.

Parameters

Name	Type	Description
`id` Path, required	String	ID or URL-encoded path of the project Example: `gitlab-org/gitlab`
`submodule` Path, required	String	URL-encoded full path to the submodule, for example `lib%2Fclass%2Erb` Example: `gitlab-org/gitlab-shell`

Request body (application/json)

Property	Type	Description
`branch` Required	String	Name of the branch to commit into Example: `main`
`commit_message`	String	Commit message. If omitted, a default message is used Example: `Commit message`
`commit_sha` Required	String	Full commit SHA to update the submodule to Example: `ed899a2f4b50b4370feeea94676502b42383c746`

Responses

Objects returned by the operations above and objects nested in their request bodies.

Property	Type	Description
`author_email`	String	Example: `john@example.com`
`author_name`	String	Example: `John Smith`
`authored_date`	String (date-time)	Example: `2012-05-28T04:42:42-07:00`
`committed_date`	String (date-time)	Example: `2012-05-28T04:42:42-07:00`
`committer_email`	String	Example: `jack@example.com`
`committer_name`	String	Example: `Jack Smith`
`created_at`	String (date-time)	Example: `2017-07-26T11:08:53.000+02:00`
`extended_trailers`	Object	Example: `{"Signed-off-by":["John Doe \u003cjohndoe@gitlab.com\u003e","Jane Doe \u003cjanedoe@gitlab.com\u003e"]}`
`id`	String	Example: `2695effb5807a22ff3d138d593fd856244e155e7`
`last_pipeline`	Object	—
`message`	String	Example: `Initial commit`
`parent_ids`	Array of strings	Example: `["2a4b78934375d7f53875269ffd4f45fd83a84ebe"]`
`project_id`	Integer (int64)	Example: `1`
`short_id`	String	Example: `2695effb`
`stats`	APIEntitiesCommitStats	—
`status`	String	Example: `success`
`title`	String	Example: `Initial commit`
`trailers`	Object	Example: `{"Merged-By":"Jane Doe janedoe@gitlab.com"}`
`web_url`	String	Example: `https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746`