Channels

Create a Channel

POST /api/{spaceId}/channels

Also reachable at /api/channels, /api/spaces/{spaceIdentifier}/channels.

Path Parameters

spaceId string (required)

Request Body

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
Custom fields (FieldName plus a human-facing Description) that become mandatory when creating a release in this channel.
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
Maximum length 1000.
GitReferenceRules array of string
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.
GitResourceRules array of object
Rules restricting which Git refs may be used for external Git dependencies referenced by deployment steps. Each rule targets step Git dependencies via GitDependencyActions (DeploymentActionSlug plus GitDependencyName) and lists the allowed Git reference patterns in Rules.
- GitDependencyActions array of object
- Id string
- Rules array of string
IsDefault boolean
LifecycleId string
The lifecycle for this channel. Must be null for ephemeral environment channels.
Name string (required)
Minimum length 1.
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel. Required for ephemeral environment channels.
ProjectId string (required)
Rules array of object
Version rules restricting which package versions may be used when creating a release in this channel. Each rule targets step packages via ActionPackages (DeploymentAction is the step name or ID, PackageReference the package reference name or ID) and constrains versions with a NuGet-style VersionRange (e.g. ‘[1.0,2.0)’) and/or a Tag regex matched against the package’s pre-release tag (e.g. ‘^$’ for stable versions only). Leave each rule’s Id blank; the server assigns it.
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string (required)
TenantTags array of string
Canonical tenant tag names in ‘TagSet/Tag’ format restricting which tenants can deploy releases from this channel.
Type string

Response

201 — Created

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
GitReferenceRules array of string
GitResourceRules array of object
- GitDependencyActions array of object
- Id string
- Rules array of string
Id string
Gets or sets a unique identifier for this resource.
IsDefault boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LifecycleId string
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel.
ProjectId string
Rules array of object
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string
TenantTags array of string
Type string

{
  "AutomaticEphemeralEnvironmentDeployments": true,
  "CustomFieldDefinitions": [
    {
      "Description": "string",
      "FieldName": "string"
    }
  ],
  "Description": "string",
  "EphemeralEnvironmentNameTemplate": "string",
  "GitReferenceRules": [
    "string"
  ],
  "GitResourceRules": [
    {
      "GitDependencyActions": [
        {}
      ],
      "Id": "string",
      "Rules": [
        "string"
      ]
    }
  ],
  "IsDefault": true,
  "LifecycleId": "string",
  "Name": "string",
  "ParentEnvironmentId": "string",
  "ProjectId": "string",
  "Rules": [
    {
      "ActionPackages": [
        {}
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Tag": "string",
      "VersionRange": "string",
      "VersionTagRegex": "string",
      "VersioningStrategy": "string"
    }
  ],
  "Slug": "string",
  "SpaceId": "string",
  "TenantTags": [
    "string"
  ],
  "Type": "string"
}

{
  "AutomaticEphemeralEnvironmentDeployments": true,
  "CustomFieldDefinitions": [
    {
      "Description": "string",
      "FieldName": "string"
    }
  ],
  "Description": "string",
  "EphemeralEnvironmentNameTemplate": "string",
  "GitReferenceRules": [
    "string"
  ],
  "GitResourceRules": [
    {
      "GitDependencyActions": [
        {}
      ],
      "Id": "string",
      "Rules": [
        "string"
      ]
    }
  ],
  "Id": "string",
  "IsDefault": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LifecycleId": "string",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "ParentEnvironmentId": "string",
  "ProjectId": "string",
  "Rules": [
    {
      "ActionPackages": [
        {}
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Tag": "string",
      "VersionRange": "string",
      "VersionTagRegex": "string",
      "VersioningStrategy": "string"
    }
  ],
  "Slug": "string",
  "SpaceId": "string",
  "TenantTags": [
    "string"
  ],
  "Type": "string"
}

Get a list of Channels

GET /api/{spaceId}/channels/all

Also reachable at /api/channels/all, /api/spaces/{spaceIdentifier}/channels/all.

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

Path Parameters

spaceId string (required)

Query Parameters

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

Response

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

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
GitReferenceRules array of string
GitResourceRules array of object
- GitDependencyActions array of object
- Id string
- Rules array of string
Id string
Gets or sets a unique identifier for this resource.
IsDefault boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LifecycleId string
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel.
ProjectId string
Rules array of object
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string
TenantTags array of string
Type string

[
  {
    "AutomaticEphemeralEnvironmentDeployments": true,
    "CustomFieldDefinitions": [
      {
        "Description": "string",
        "FieldName": "string"
      }
    ],
    "Description": "string",
    "EphemeralEnvironmentNameTemplate": "string",
    "GitReferenceRules": [
      "string"
    ],
    "GitResourceRules": [
      {
        "GitDependencyActions": [
          {}
        ],
        "Id": "string",
        "Rules": [
          "string"
        ]
      }
    ],
    "Id": "string",
    "IsDefault": true,
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "LifecycleId": "string",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "Name": "string",
    "ParentEnvironmentId": "string",
    "ProjectId": "string",
    "Rules": [
      {
        "ActionPackages": [
          {}
        ],
        "Id": "string",
        "LastModifiedBy": "string",
        "LastModifiedOn": "2020-01-01T00:00:00.000Z",
        "Links": {},
        "Tag": "string",
        "VersionRange": "string",
        "VersionTagRegex": "string",
        "VersioningStrategy": "string"
      }
    ],
    "Slug": "string",
    "SpaceId": "string",
    "TenantTags": [
      "string"
    ],
    "Type": "string"
  }
]

Perform Channel version rule test against provided Package version

GET /api/{spaceId}/channels/rule-test

Also reachable at /api/channels/rule-test, /api/spaces/{spaceIdentifier}/channels/rule-test.

Path Parameters

spaceId string (required)
The ID of the space containing the resource(s).

Query Parameters

actions array of string
A list of step names to find a package step which the feed type will determine which version format should be used.
feedId string
A feed ID to determine which version format should be used.
feedType enum
A feed type to determine which version format should be used.
Allowed values: None, NuGet, Docker, Maven, OctopusProject, GitHub, Helm, OciRegistry, AwsElasticContainerRegistry, BuiltIn, S3, AzureContainerRegistry, GoogleContainerRegistry, ArtifactoryGeneric, Npm, GcsStorage, PyPi.
preReleaseTag string
A regular expression to test the version pre-release tag against.
projectId string
A deployment process ID in which to search for the steps referenced by the ‘Actions’ parameter.
version string (required)
The version to test.
versionRange string
A version range to test the version against.

Response

200 — Result of testing Channel version rules

Errors array of string
SatisfiesPreReleaseTag boolean
SatisfiesVersionRange boolean

{
  "Errors": [
    "string"
  ],
  "SatisfiesPreReleaseTag": true,
  "SatisfiesVersionRange": true
}

Perform Channel version rule test against provided Package version

POST /api/{spaceId}/channels/rule-test

Path Parameters

spaceId string (required)
The ID of the space containing the resource(s).

Query Parameters

actions array of string
A list of step names to find a package step which the feed type will determine which version format should be used.
feedId string
A feed ID to determine which version format should be used.
feedType enum
A feed type to determine which version format should be used.
Allowed values: None, NuGet, Docker, Maven, OctopusProject, GitHub, Helm, OciRegistry, AwsElasticContainerRegistry, BuiltIn, S3, AzureContainerRegistry, GoogleContainerRegistry, ArtifactoryGeneric, Npm, GcsStorage, PyPi.
preReleaseTag string
A regular expression to test the version pre-release tag against.
projectId string
A deployment process ID in which to search for the steps referenced by the ‘Actions’ parameter.
version string (required)
The version to test.
versionRange string
A version range to test the version against.

Response

200 — Result of testing Channel version rules

Errors array of string
SatisfiesPreReleaseTag boolean
SatisfiesVersionRange boolean

{
  "Errors": [
    "string"
  ],
  "SatisfiesPreReleaseTag": true,
  "SatisfiesVersionRange": true
}

Perform Channel version rule test against provided Package version

POST /api/spaces/{spaceIdentifier}/channels/rule-test

Also reachable at /api/channels/rule-test.

Path Parameters

spaceIdentifier string (required)
Identifier (ID or slug) of the space.

Query Parameters

actions array of string
A list of step names to find a package step which the feed type will determine which version format should be used.
feedId string
A feed ID to determine which version format should be used.
feedType enum
A feed type to determine which version format should be used.
Allowed values: None, NuGet, Docker, Maven, OctopusProject, GitHub, Helm, OciRegistry, AwsElasticContainerRegistry, BuiltIn, S3, AzureContainerRegistry, GoogleContainerRegistry, ArtifactoryGeneric, Npm, GcsStorage, PyPi.
preReleaseTag string
A regular expression to test the version pre-release tag against.
projectId string
A deployment process ID in which to search for the steps referenced by the ‘Actions’ parameter.
version string (required)
The version to test.
versionRange string
A version range to test the version against.

Response

200 — Result of testing Channel version rules

Errors array of string
SatisfiesPreReleaseTag boolean
SatisfiesVersionRange boolean

{
  "Errors": [
    "string"
  ],
  "SatisfiesPreReleaseTag": true,
  "SatisfiesVersionRange": true
}

Test Channel version rules

GET /api/{spaceId}/channels/rule-test/v1

Also reachable at /api/channels/rule-test/v1, /api/spaces/{spaceIdentifier}/channels/rule-test/v1.

Path Parameters

spaceId string (required)

Query Parameters

deploymentProcessId string
feedId string
feedType enum
Allowed values: None, NuGet, Docker, Maven, OctopusProject, GitHub, Helm, OciRegistry, AwsElasticContainerRegistry, BuiltIn, S3, AzureContainerRegistry, GoogleContainerRegistry, ArtifactoryGeneric, Npm, GcsStorage, PyPi.
preReleaseTagPattern string
stepName string
version string (required)
versionRange string
versionTagRegex string

Response

200 — The result of testing the Channel version rules

Errors array of string
SatisfiesPreReleaseTag boolean
SatisfiesVersionRange boolean
SatisfiesVersionTagRegex boolean
Whether the version satisfies the rule’s version-tag regex. Defaults to true (no regex, or a legacy caller, counts as satisfied).

{
  "Errors": [
    "string"
  ],
  "SatisfiesPreReleaseTag": true,
  "SatisfiesVersionRange": true,
  "SatisfiesVersionTagRegex": true
}

Test Channel version rules

POST /api/{spaceId}/channels/rule-test/v1

Path Parameters

spaceId string (required)

Query Parameters

deploymentProcessId string
feedId string
feedType enum
Allowed values: None, NuGet, Docker, Maven, OctopusProject, GitHub, Helm, OciRegistry, AwsElasticContainerRegistry, BuiltIn, S3, AzureContainerRegistry, GoogleContainerRegistry, ArtifactoryGeneric, Npm, GcsStorage, PyPi.
preReleaseTagPattern string
stepName string
version string (required)
versionRange string
versionTagRegex string

Response

200 — The result of testing the Channel version rules

Errors array of string
SatisfiesPreReleaseTag boolean
SatisfiesVersionRange boolean
SatisfiesVersionTagRegex boolean
Whether the version satisfies the rule’s version-tag regex. Defaults to true (no regex, or a legacy caller, counts as satisfied).

{
  "Errors": [
    "string"
  ],
  "SatisfiesPreReleaseTag": true,
  "SatisfiesVersionRange": true,
  "SatisfiesVersionTagRegex": true
}

Test Channel version rules

POST /api/spaces/{spaceIdentifier}/channels/rule-test/v1

Also reachable at /api/channels/rule-test/v1.

Path Parameters

spaceIdentifier string (required)
Identifier (ID or slug) of the space.

Query Parameters

deploymentProcessId string
feedId string
feedType enum
Allowed values: None, NuGet, Docker, Maven, OctopusProject, GitHub, Helm, OciRegistry, AwsElasticContainerRegistry, BuiltIn, S3, AzureContainerRegistry, GoogleContainerRegistry, ArtifactoryGeneric, Npm, GcsStorage, PyPi.
preReleaseTagPattern string
stepName string
version string (required)
versionRange string
versionTagRegex string

Response

200 — The result of testing the Channel version rules

Errors array of string
SatisfiesPreReleaseTag boolean
SatisfiesVersionRange boolean
SatisfiesVersionTagRegex boolean
Whether the version satisfies the rule’s version-tag regex. Defaults to true (no regex, or a legacy caller, counts as satisfied).

{
  "Errors": [
    "string"
  ],
  "SatisfiesPreReleaseTag": true,
  "SatisfiesVersionRange": true,
  "SatisfiesVersionTagRegex": true
}

Update an existing Channel

PUT /api/{spaceId}/channels/{id}

Also reachable at /api/channels/{id}, /api/spaces/{spaceIdentifier}/channels/{id}.

Path Parameters

id string (required)
Gets or sets a unique identifier for this resource.
spaceId string (required)

Request Body

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
Custom fields (FieldName plus a human-facing Description) that become mandatory when creating a release in this channel. Omit to keep the current definitions; an empty list clears them.
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
Maximum length 1000.
GitReferenceRules array of string
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.
GitResourceRules array of object
Rules restricting which Git refs may be used for external Git dependencies referenced by deployment steps. Each rule targets step Git dependencies via GitDependencyActions (DeploymentActionSlug plus GitDependencyName) and lists the allowed Git reference patterns in Rules. Omit to keep the current rules; an empty list clears them.
- GitDependencyActions array of object
- Id string
- Rules array of string
Id string (required)
Gets or sets a unique identifier for this resource.
IsDefault boolean
LifecycleId string
The lifecycle for this channel. Must be null for ephemeral environment channels.
Name string (required)
Minimum length 1.
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel. Required for ephemeral environment channels.
ProjectId string (required)
Rules array of object
Version rules restricting which package versions may be used when creating a release in this channel. Each rule targets step packages via ActionPackages (DeploymentAction is the step name or ID, PackageReference the package reference name or ID) and constrains versions with a NuGet-style VersionRange (e.g. ‘[1.0,2.0)’) and/or a Tag regex matched against the package’s pre-release tag (e.g. ‘^$’ for stable versions only). Keep each existing rule’s Id; leave it blank on new rules. Omit to keep the current rules; an empty list clears them.
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string (required)
TenantTags array of string
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.

Response

200 — Confirms the Channel was modified, containing the updated Channel

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
GitReferenceRules array of string
GitResourceRules array of object
- GitDependencyActions array of object
- Id string
- Rules array of string
Id string
Gets or sets a unique identifier for this resource.
IsDefault boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LifecycleId string
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel.
ProjectId string
Rules array of object
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string
TenantTags array of string
Type string

{
  "AutomaticEphemeralEnvironmentDeployments": true,
  "CustomFieldDefinitions": [
    {
      "Description": "string",
      "FieldName": "string"
    }
  ],
  "Description": "string",
  "EphemeralEnvironmentNameTemplate": "string",
  "GitReferenceRules": [
    "string"
  ],
  "GitResourceRules": [
    {
      "GitDependencyActions": [
        {}
      ],
      "Id": "string",
      "Rules": [
        "string"
      ]
    }
  ],
  "Id": "string",
  "IsDefault": true,
  "LifecycleId": "string",
  "Name": "string",
  "ParentEnvironmentId": "string",
  "ProjectId": "string",
  "Rules": [
    {
      "ActionPackages": [
        {}
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Tag": "string",
      "VersionRange": "string",
      "VersionTagRegex": "string",
      "VersioningStrategy": "string"
    }
  ],
  "Slug": "string",
  "SpaceId": "string",
  "TenantTags": [
    "string"
  ]
}

{
  "AutomaticEphemeralEnvironmentDeployments": true,
  "CustomFieldDefinitions": [
    {
      "Description": "string",
      "FieldName": "string"
    }
  ],
  "Description": "string",
  "EphemeralEnvironmentNameTemplate": "string",
  "GitReferenceRules": [
    "string"
  ],
  "GitResourceRules": [
    {
      "GitDependencyActions": [
        {}
      ],
      "Id": "string",
      "Rules": [
        "string"
      ]
    }
  ],
  "Id": "string",
  "IsDefault": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LifecycleId": "string",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "ParentEnvironmentId": "string",
  "ProjectId": "string",
  "Rules": [
    {
      "ActionPackages": [
        {}
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Tag": "string",
      "VersionRange": "string",
      "VersionTagRegex": "string",
      "VersioningStrategy": "string"
    }
  ],
  "Slug": "string",
  "SpaceId": "string",
  "TenantTags": [
    "string"
  ],
  "Type": "string"
}

Delete a ChannelResource by ID

DELETE /api/{spaceId}/channels/{id}

Also reachable at /api/channels/{id}, /api/spaces/{spaceIdentifier}/channels/{id}.

Deletes an existing channel.

Path Parameters

id string (required)
ID of the ChannelResource to delete.
spaceId string (required)
The ID of the space containing the resource(s).

Response

200 — Success

Get a list of ChannelResources for the given ProjectResource

GET /api/{spaceId}/projects/{projectId}/channels

Also reachable at /api/projects/{projectId}/channels, /api/spaces/{spaceIdentifier}/projects/{projectId}/channels.

Lists all the channels for the given project

Path Parameters

projectId string (required)
ID of the Project.
spaceId string (required)

Query Parameters

partialName string
A partial or complete name to limit the set of retrieved Tenants to. This will perform a “contains” style match against the supplied name or name-fragment.
skip integer
Number of items to skip. Defaults to zero. Minimum 0.
take integer
Number of items to take. Defaults to 30. Minimum 0.

Response

200 — List of all the channels for the given project

Id string
Gets or sets a unique identifier for this resource.
ItemType string
Items array of object
- AutomaticEphemeralEnvironmentDeployments boolean
- CustomFieldDefinitions array of object
- Description string
- EphemeralEnvironmentNameTemplate string
- GitReferenceRules array of string
- GitResourceRules array of object
- Id string
  Gets or sets a unique identifier for this resource.
- IsDefault boolean
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- LifecycleId string
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Name string
- ParentEnvironmentId string
  The parent environment for all ephemeral environments created in this channel.
- ProjectId string
- Rules array of object
- Slug string
- SpaceId string
- TenantTags array of string
- Type string
ItemsPerPage integer
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LastPageNumber integer
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
NumberOfPages integer
TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "AutomaticEphemeralEnvironmentDeployments": true,
      "CustomFieldDefinitions": [
        {}
      ],
      "Description": "string",
      "EphemeralEnvironmentNameTemplate": "string",
      "GitReferenceRules": [
        "string"
      ],
      "GitResourceRules": [
        {}
      ],
      "Id": "string",
      "IsDefault": true,
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "LifecycleId": "string",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "ParentEnvironmentId": "string",
      "ProjectId": "string",
      "Rules": [
        {}
      ],
      "Slug": "string",
      "SpaceId": "string",
      "TenantTags": [
        "string"
      ],
      "Type": "string"
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

Create a Channel

POST /api/{spaceId}/projects/{projectId}/channels

Also reachable at /api/projects/{projectId}/channels, /api/spaces/{spaceIdentifier}/projects/{projectId}/channels.

Path Parameters

projectId string (required)
spaceId string (required)

Request Body

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
Custom fields (FieldName plus a human-facing Description) that become mandatory when creating a release in this channel.
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
Maximum length 1000.
GitReferenceRules array of string
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.
GitResourceRules array of object
Rules restricting which Git refs may be used for external Git dependencies referenced by deployment steps. Each rule targets step Git dependencies via GitDependencyActions (DeploymentActionSlug plus GitDependencyName) and lists the allowed Git reference patterns in Rules.
- GitDependencyActions array of object
- Id string
- Rules array of string
IsDefault boolean
LifecycleId string
The lifecycle for this channel. Must be null for ephemeral environment channels.
Name string (required)
Minimum length 1.
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel. Required for ephemeral environment channels.
ProjectId string (required)
Rules array of object
Version rules restricting which package versions may be used when creating a release in this channel. Each rule targets step packages via ActionPackages (DeploymentAction is the step name or ID, PackageReference the package reference name or ID) and constrains versions with a NuGet-style VersionRange (e.g. ‘[1.0,2.0)’) and/or a Tag regex matched against the package’s pre-release tag (e.g. ‘^$’ for stable versions only). Leave each rule’s Id blank; the server assigns it.
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string (required)
TenantTags array of string
Canonical tenant tag names in ‘TagSet/Tag’ format restricting which tenants can deploy releases from this channel.
Type string

Response

200 — The newly-created Channel

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
GitReferenceRules array of string
GitResourceRules array of object
- GitDependencyActions array of object
- Id string
- Rules array of string
Id string
Gets or sets a unique identifier for this resource.
IsDefault boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LifecycleId string
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel.
ProjectId string
Rules array of object
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string
TenantTags array of string
Type string

{
  "AutomaticEphemeralEnvironmentDeployments": true,
  "CustomFieldDefinitions": [
    {
      "Description": "string",
      "FieldName": "string"
    }
  ],
  "Description": "string",
  "EphemeralEnvironmentNameTemplate": "string",
  "GitReferenceRules": [
    "string"
  ],
  "GitResourceRules": [
    {
      "GitDependencyActions": [
        {}
      ],
      "Id": "string",
      "Rules": [
        "string"
      ]
    }
  ],
  "IsDefault": true,
  "LifecycleId": "string",
  "Name": "string",
  "ParentEnvironmentId": "string",
  "ProjectId": "string",
  "Rules": [
    {
      "ActionPackages": [
        {}
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Tag": "string",
      "VersionRange": "string",
      "VersionTagRegex": "string",
      "VersioningStrategy": "string"
    }
  ],
  "Slug": "string",
  "SpaceId": "string",
  "TenantTags": [
    "string"
  ],
  "Type": "string"
}

{
  "AutomaticEphemeralEnvironmentDeployments": true,
  "CustomFieldDefinitions": [
    {
      "Description": "string",
      "FieldName": "string"
    }
  ],
  "Description": "string",
  "EphemeralEnvironmentNameTemplate": "string",
  "GitReferenceRules": [
    "string"
  ],
  "GitResourceRules": [
    {
      "GitDependencyActions": [
        {}
      ],
      "Id": "string",
      "Rules": [
        "string"
      ]
    }
  ],
  "Id": "string",
  "IsDefault": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LifecycleId": "string",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "ParentEnvironmentId": "string",
  "ProjectId": "string",
  "Rules": [
    {
      "ActionPackages": [
        {}
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Tag": "string",
      "VersionRange": "string",
      "VersionTagRegex": "string",
      "VersioningStrategy": "string"
    }
  ],
  "Slug": "string",
  "SpaceId": "string",
  "TenantTags": [
    "string"
  ],
  "Type": "string"
}

Determine if a git reference satisfies the rules of a channel

GET /api/{spaceId}/projects/{projectId}/channels/{channelId}/git-reference-rule-validation/v1

Also reachable at /api/spaces/{spaceIdentifier}/projects/{projectId}/channels/{channelId}/git-reference-rule-validation/v1.

Path Parameters

channelId string (required)
projectId string (required)
spaceId string (required)

Query Parameters

gitReference string (required)

Response

200 — Represents the result of testing Channel git protection rules.

Errors array of string
SatisfiesGitReferenceRules boolean

{
  "Errors": [
    "string"
  ],
  "SatisfiesGitReferenceRules": true
}

Determine if a git reference satisfies a channel’s Git resource rules

GET /api/{spaceId}/projects/{projectId}/channels/{channelId}/git-resource-rule-validation/v1

Also reachable at /api/spaces/{spaceIdentifier}/projects/{projectId}/channels/{channelId}/git-resource-rule-validation/v1.

Path Parameters

channelId string (required)
projectId string (required)
spaceId string (required)

Query Parameters

deploymentActionSlug string (required)
gitDependencyName string (required)
gitReference string (required)

Response

200 — Represents the result of testing Channel Git resource rules.

Errors array of string
SatisfiesGitResourceRules boolean

{
  "Errors": [
    "string"
  ],
  "SatisfiesGitResourceRules": true
}

Get a Channel by ID

GET /api/{spaceId}/projects/{projectId}/channels/{id}

Also reachable at /api/projects/{projectId}/channels/{id}, /api/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}.

Path Parameters

id string (required)
ID or name of a space channel, or the slug of a templated Channel to load.
projectId string (required)
ID of the Project.
spaceId string (required)

Response

200 — The channel matching the supplied Id

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
GitReferenceRules array of string
GitResourceRules array of object
- GitDependencyActions array of object
- Id string
- Rules array of string
Id string
Gets or sets a unique identifier for this resource.
IsDefault boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LifecycleId string
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel.
ProjectId string
Rules array of object
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string
TenantTags array of string
Type string

{
  "AutomaticEphemeralEnvironmentDeployments": true,
  "CustomFieldDefinitions": [
    {
      "Description": "string",
      "FieldName": "string"
    }
  ],
  "Description": "string",
  "EphemeralEnvironmentNameTemplate": "string",
  "GitReferenceRules": [
    "string"
  ],
  "GitResourceRules": [
    {
      "GitDependencyActions": [
        {}
      ],
      "Id": "string",
      "Rules": [
        "string"
      ]
    }
  ],
  "Id": "string",
  "IsDefault": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LifecycleId": "string",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "ParentEnvironmentId": "string",
  "ProjectId": "string",
  "Rules": [
    {
      "ActionPackages": [
        {}
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Tag": "string",
      "VersionRange": "string",
      "VersionTagRegex": "string",
      "VersioningStrategy": "string"
    }
  ],
  "Slug": "string",
  "SpaceId": "string",
  "TenantTags": [
    "string"
  ],
  "Type": "string"
}

Update an existing Channel

PUT /api/{spaceId}/projects/{projectId}/channels/{id}

Also reachable at /api/projects/{projectId}/channels/{id}, /api/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}.

Path Parameters

id string (required)
Gets or sets a unique identifier for this resource.
projectId string (required)
spaceId string (required)

Request Body

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
Custom fields (FieldName plus a human-facing Description) that become mandatory when creating a release in this channel. Omit to keep the current definitions; an empty list clears them.
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
Maximum length 1000.
GitReferenceRules array of string
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.
GitResourceRules array of object
Rules restricting which Git refs may be used for external Git dependencies referenced by deployment steps. Each rule targets step Git dependencies via GitDependencyActions (DeploymentActionSlug plus GitDependencyName) and lists the allowed Git reference patterns in Rules. Omit to keep the current rules; an empty list clears them.
- GitDependencyActions array of object
- Id string
- Rules array of string
Id string (required)
Gets or sets a unique identifier for this resource.
IsDefault boolean
LifecycleId string
The lifecycle for this channel. Must be null for ephemeral environment channels.
Name string (required)
Minimum length 1.
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel. Required for ephemeral environment channels.
ProjectId string (required)
Rules array of object
Version rules restricting which package versions may be used when creating a release in this channel. Each rule targets step packages via ActionPackages (DeploymentAction is the step name or ID, PackageReference the package reference name or ID) and constrains versions with a NuGet-style VersionRange (e.g. ‘[1.0,2.0)’) and/or a Tag regex matched against the package’s pre-release tag (e.g. ‘^$’ for stable versions only). Keep each existing rule’s Id; leave it blank on new rules. Omit to keep the current rules; an empty list clears them.
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string (required)
TenantTags array of string
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.

Response

200 — Confirms the Channel was modified, containing the updated Channel

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
GitReferenceRules array of string
GitResourceRules array of object
- GitDependencyActions array of object
- Id string
- Rules array of string
Id string
Gets or sets a unique identifier for this resource.
IsDefault boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LifecycleId string
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel.
ProjectId string
Rules array of object
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string
TenantTags array of string
Type string

{
  "AutomaticEphemeralEnvironmentDeployments": true,
  "CustomFieldDefinitions": [
    {
      "Description": "string",
      "FieldName": "string"
    }
  ],
  "Description": "string",
  "EphemeralEnvironmentNameTemplate": "string",
  "GitReferenceRules": [
    "string"
  ],
  "GitResourceRules": [
    {
      "GitDependencyActions": [
        {}
      ],
      "Id": "string",
      "Rules": [
        "string"
      ]
    }
  ],
  "Id": "string",
  "IsDefault": true,
  "LifecycleId": "string",
  "Name": "string",
  "ParentEnvironmentId": "string",
  "ProjectId": "string",
  "Rules": [
    {
      "ActionPackages": [
        {}
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Tag": "string",
      "VersionRange": "string",
      "VersionTagRegex": "string",
      "VersioningStrategy": "string"
    }
  ],
  "Slug": "string",
  "SpaceId": "string",
  "TenantTags": [
    "string"
  ]
}

{
  "AutomaticEphemeralEnvironmentDeployments": true,
  "CustomFieldDefinitions": [
    {
      "Description": "string",
      "FieldName": "string"
    }
  ],
  "Description": "string",
  "EphemeralEnvironmentNameTemplate": "string",
  "GitReferenceRules": [
    "string"
  ],
  "GitResourceRules": [
    {
      "GitDependencyActions": [
        {}
      ],
      "Id": "string",
      "Rules": [
        "string"
      ]
    }
  ],
  "Id": "string",
  "IsDefault": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LifecycleId": "string",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "ParentEnvironmentId": "string",
  "ProjectId": "string",
  "Rules": [
    {
      "ActionPackages": [
        {}
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Tag": "string",
      "VersionRange": "string",
      "VersionTagRegex": "string",
      "VersioningStrategy": "string"
    }
  ],
  "Slug": "string",
  "SpaceId": "string",
  "TenantTags": [
    "string"
  ],
  "Type": "string"
}

Delete a ChannelResource by ID

DELETE /api/{spaceId}/projects/{projectId}/channels/{id}

Also reachable at /api/projects/{projectId}/channels/{id}, /api/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}.

Deletes an existing channel.

Path Parameters

id string (required)
ID of the ChannelResource to delete.
projectId string (required)
The ID of the project.
spaceId string (required)
The ID of the space containing the resource(s).

Response

200 — Success

Delete a ChannelResource by ID

DELETE /api/{spaceId}/projects/{projectId}/channels/{id}/v2

Also reachable at /api/projects/{projectId}/channels/{id}/v2, /api/spaces/{spaceIdentifier}/projects/{projectId}/channels/{id}/v2.

Deletes an existing channel.

Path Parameters

id string (required)
ID of the ChannelResource to delete.
projectId string (required)
The ID of the project.
spaceId string (required)
The ID of the space containing the resource(s).

Response

200 — Confirmation that the Channel has been deleted

{}

Get a list of Channels

GET /api/{spaceId}/channels

Also reachable at /api/channels, /api/spaces/{spaceIdentifier}/channels.

Deprecated. This endpoint may be removed in a future release.

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

Path Parameters

spaceId string (required)

Query Parameters

ids array of string
Comma separated list of Ids.
partialName string
A partial or complete name to search on. This will perform a “contains” style match against the supplied name or name-fragment.
skip integer
Number of items to skip. Defaults to zero. Minimum 0.
take integer
Number of items to take. Defaults to 30. Minimum 0.

Response

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

Id string
Gets or sets a unique identifier for this resource.
ItemType string
Items array of object
- AutomaticEphemeralEnvironmentDeployments boolean
- CustomFieldDefinitions array of object
- Description string
- EphemeralEnvironmentNameTemplate string
- GitReferenceRules array of string
- GitResourceRules array of object
- Id string
  Gets or sets a unique identifier for this resource.
- IsDefault boolean
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- LifecycleId string
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Name string
- ParentEnvironmentId string
  The parent environment for all ephemeral environments created in this channel.
- ProjectId string
- Rules array of object
- Slug string
- SpaceId string
- TenantTags array of string
- Type string
ItemsPerPage integer
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LastPageNumber integer
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
NumberOfPages integer
TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "AutomaticEphemeralEnvironmentDeployments": true,
      "CustomFieldDefinitions": [
        {}
      ],
      "Description": "string",
      "EphemeralEnvironmentNameTemplate": "string",
      "GitReferenceRules": [
        "string"
      ],
      "GitResourceRules": [
        {}
      ],
      "Id": "string",
      "IsDefault": true,
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "LifecycleId": "string",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "ParentEnvironmentId": "string",
      "ProjectId": "string",
      "Rules": [
        {}
      ],
      "Slug": "string",
      "SpaceId": "string",
      "TenantTags": [
        "string"
      ],
      "Type": "string"
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

Get a Channel by ID

GET /api/{spaceId}/channels/{id}

Also reachable at /api/channels/{id}, /api/spaces/{spaceIdentifier}/channels/{id}.

Deprecated. This endpoint may be removed in a future release.

Path Parameters

id string (required)
ID of the Channel to load.
spaceId string (required)

Response

200 — Success

AutomaticEphemeralEnvironmentDeployments boolean
CustomFieldDefinitions array of object
- Description string
- FieldName string
Description string
EphemeralEnvironmentNameTemplate string
GitReferenceRules array of string
GitResourceRules array of object
- GitDependencyActions array of object
- Id string
- Rules array of string
Id string
Gets or sets a unique identifier for this resource.
IsDefault boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LifecycleId string
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
ParentEnvironmentId string
The parent environment for all ephemeral environments created in this channel.
ProjectId string
Rules array of object
- ActionPackages array of object
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Tag string
- VersionRange string
- VersionTagRegex string
- VersioningStrategy string
Slug string
SpaceId string
TenantTags array of string
Type string

{
  "AutomaticEphemeralEnvironmentDeployments": true,
  "CustomFieldDefinitions": [
    {
      "Description": "string",
      "FieldName": "string"
    }
  ],
  "Description": "string",
  "EphemeralEnvironmentNameTemplate": "string",
  "GitReferenceRules": [
    "string"
  ],
  "GitResourceRules": [
    {
      "GitDependencyActions": [
        {}
      ],
      "Id": "string",
      "Rules": [
        "string"
      ]
    }
  ],
  "Id": "string",
  "IsDefault": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LifecycleId": "string",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "ParentEnvironmentId": "string",
  "ProjectId": "string",
  "Rules": [
    {
      "ActionPackages": [
        {}
      ],
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Tag": "string",
      "VersionRange": "string",
      "VersionTagRegex": "string",
      "VersioningStrategy": "string"
    }
  ],
  "Slug": "string",
  "SpaceId": "string",
  "TenantTags": [
    "string"
  ],
  "Type": "string"
}