Branches

Create a branch given a project, the base git ref, and the new branch's name

post/projects/{projectId}/git/branches/v2

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/projects/{projectId}/git/branches/v2
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

projectIdstring required

Request body

BaseGitRefstring required
NewBranchNamestring required
ProjectIdstring required
SpaceIdstring required

The ID of the space containing the resource(s).

Example request

{
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Response

The newly-created Branch

CanonicalNamestring required
Idstring

Gets or sets a unique identifier for this resource.

IsProtectedboolean required
LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Namestring required

Example response

{
  "Links": {
    "Self": "/api/..."
  }
}

Changes

No recorded changes to this operation across all 13 revisions of this API.