Channels

Get a list of Channels

Lists all of the Channels in the supplied Octopus Deploy Space, from all projects, sorted by name.

get/channels

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/channels
  • 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

idsstring[]

Comma separated list of Ids

partialNamestring

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

List of all the Channels in the supplied Octopus Deploy Space, from all projects, sorted by name.

Idstring

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring

The type of item in this list

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.

LastPageNumberinteger
Linksobject

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

NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "Links": {
        "Self": "/api/..."
      },
      "ParentEnvironmentId": "Environments-1",
      "ProjectId": "Projects-1",
      "Rules": [
        {
          "Links": {
            "Self": "/api/..."
          }
        }
      ],
      "SpaceId": "Spaces-1"
    }
  ],
  "ItemsPerPage": 30,
  "ItemType": "Channel",
  "LastPageNumber": 1,
  "Links": {
    "Self": "/api/..."
  },
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

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