PlatformHub

Request the list of Branches for the Platform Hub

get/platformhub/git/branches

Request

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

Query parameters

searchByNamestring

A partial or complete name to search on. This will perform a "contains" style match against the supplied name or name-fragment

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 30

Response

Success

ItemsPerPageinteger
ItemTypestring

The type of item in this list

LastPageNumberinteger
NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "Links": {
        "Self": "/api/..."
      }
    }
  ],
  "ItemsPerPage": 30,
  "ItemType": "GitBranch",
  "LastPageNumber": 1,
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

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