Channels

Update an existing Channel

put/{spaceId}/channels/{id}

Request

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

spaceIdstring required
idstring required

Gets or sets a unique identifier for this resource.

Request body

AutomaticEphemeralEnvironmentDeploymentsboolean
Descriptionstring
EphemeralEnvironmentNameTemplatestring
GitReferenceRulesstring[]

Git reference patterns (e.g. 'refs/heads/main', 'refs/heads/feature/*') restricting which branches or tags can create releases in this channel. Only valid for version-controlled (Config-as-Code) projects. Omit to keep the current rules; an empty list clears them.

Idstring required

Gets or sets a unique identifier for this resource.

IsDefaultboolean
LifecycleIdstring

The lifecycle for this channel. Must be null for ephemeral environment channels.

Namestring required
ParentEnvironmentIdstring

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

ProjectIdstring required
Slugstring
SpaceIdstring required
TenantTagsstring[]

Canonical tenant tag names in 'TagSet/Tag' format restricting which tenants can deploy releases from this channel. Omit to keep the current tags; an empty collection clears them.

Example request

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

Response

Confirms the Channel was modified, containing the updated Channel

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.