Channels

Get a list of Channels

Lists all of the channels in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

get/{spaceId}/channels/all

Request

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

Query parameters

idsstring[]

A set of Channel IDs to retrieve Channels for. Example: Channel-101,Channel-201

Response

List of all of the channels in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

AutomaticEphemeralEnvironmentDeploymentsboolean
Descriptionstring
EphemeralEnvironmentNameTemplatestring
GitReferenceRulesstring[]
Idstring

Gets or sets a unique identifier for this resource.

IsDefaultboolean
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.

LifecycleIdstring
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
ParentEnvironmentIdstring

The parent environment for all ephemeral environments created in this channel.

ProjectIdstring
Slugstring
SpaceIdstring
TenantTagsstring[]
Typestring

Example response

[
  {
    "Links": {
      "Self": "/api/..."
    },
    "ParentEnvironmentId": "Environments-1",
    "ProjectId": "Projects-1",
    "Rules": [
      {
        "Links": {
          "Self": "/api/..."
        }
      }
    ],
    "SpaceId": "Spaces-1"
  }
]

Changes

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