Channels

Get a Channel by ID

get/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}
  • 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

spaceIdentifierstring required

Identifier (ID or slug) of the space

projectIdstring required

ID of the Project

idstring required

ID or name of a space channel, or the slug of a templated Channel to load

Response

The channel matching the supplied Id

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.