Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateSourceRepositoryBranch

Creates a branch in a specified source repository in Amazon CodeCatalyst.

Note

This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.

Request Syntax


PUT /v1/spaces/spaceName/projects/projectName/sourceRepositories/sourceRepositoryName/branches/name HTTP/1.1
Content-type: application/json

{
   "headCommitId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

name

The name for the branch you're creating.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

projectName

The name of the project in the space.

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: [a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*

Required: Yes

sourceRepositoryName

The name of the repository where you want to create a branch.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: (?!.*[.]git$)[\w\-.]*

Required: Yes

spaceName

The name of the space.

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: [a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*

Required: Yes

Request Body

The request accepts the following data in JSON format.

headCommitId

The commit ID in an existing branch from which you want to create the new branch.

Type: String

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "headCommitId": "string",
   "lastUpdatedTime": "string",
   "name": "string",
   "ref": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

headCommitId

The commit ID of the tip of the newly created branch.

Type: String

lastUpdatedTime

The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

Type: Timestamp

name

The name of the newly created branch.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

ref

The Git reference name of the branch.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Errors

AccessDeniedException

The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.

HTTP Status Code: 403

ConflictException

The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.

HTTP Status Code: 409

ResourceNotFoundException

The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.

HTTP Status Code: 404

ServiceQuotaExceededException

The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.

HTTP Status Code: 400