Branches

Get a Git branch by name

Gets a named version control branch for a project.

get/{spaceId}/projects/{projectId}/git/branches/{branchName}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/projects/{projectId}/git/branches/{branchName}
  • 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

spaceIdstring required

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

projectIdstring required

ID of the project

branchNamestring required

Name of the branch

Response

The requested 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.