git.pulls.createOpen a pull request
Request syntax
POST /git/api/repositories/{repoId}/pulls
{
"title": "string",
"body": "string",
"sourceBranch": "string",
"targetBranch": "string",
"isDraft": "boolean"
}Path parameters
repoIdRequiredstring
Constraints: uuid
Request body
titleRequiredstring
The title
Constraints: 1-200 chars
bodyOptionalstring
The description (Markdown)
Constraints: max 20000 chars
sourceBranchRequiredstring
The branch with the changes
Constraints: 1-255 chars
targetBranchRequiredstring
The branch to merge them into
Constraints: 1-255 chars
isDraftOptionalboolean
Open it as a draft, which cannot be merged until marked ready; false when absent
Response
201 with the new pull request, its `number` and its `mergeStatus`. 400 when the branches are the same or one does not exist.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
idAlwaysstring
The pull request idorgIdAlwaysstring
The organization that owns itrepoIdAlwaysstring
The repository it belongs tonumberAlwaysnumber
Its number in the repository, as in #12titleAlwaysstring
The titlebodyAlwaysstring, may be null
The description (Markdown); null when there is nonestateAlwaysone of open, closed, merged, draft
open, draft, closed (without merging) or mergedsourceBranchAlwaysstring
The branch with the changestargetBranchAlwaysstring
The branch it merges intosourceOidAlwaysstring, may be null
Head commit of the source branch when mergeability was last computedtargetOidAlwaysstring, may be null
Tip of the target branch when mergeability was last computedmergeStatusAlwaysone of unknown, mergeable, conflicted, up_to_date
Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknownmergeConflictsAlwaysarray of string, may be null
The conflicting paths when conflicted; null when not knownmergeCommitOidAlwaysstring, may be null
The commit the merge produced; null until mergedauthorIamUserIdAlwaysstring
The IAM user who opened it (for an imported one, who ran the import)isDraftAlwaysboolean
A draft, not yet ready for reviewmergedAtAlwaysstring, may be null
When it was merged; null unless mergedclosedAtAlwaysstring, may be null
When it was closed; null while openexternalAuthorAlwaysstring, may be null
For an imported pull request, who opened it at the source; null otherwiseexternalUrlAlwaysstring, may be null
For an imported pull request, its address at the source; null otherwiseautoMergeMethodAlwaysone of merge, squash, rebase, may be null
The method auto-merge will use; null when auto-merge is offautoMergeIamUserIdAlwaysstring, may be null
Who turned auto-merge on, and as whom it merges; null when offautoMergeEnabledAtAlwaysstring, may be null
When auto-merge was turned on; null when offautoMergeBlockedReasonAlwaysstring, may be null
Why the last auto-merge attempt did not merge; null when nothing blocks itcreatedAtAlwaysstring
When it was openedupdatedAtAlwaysstring
When it last changed
Checked against the handlers: every route test validates their answers against this schema.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow git:CreatePullRequest on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud git pulls create repoId --title example --source-branch example --target-branch examplecurl -X POST "https://console.platform-development.deutschecloud.app/git/api/repositories/repoId/pulls" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"example","sourceBranch":"example","targetBranch":"example"}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_pulls_create.