Channels

Test Channel version rules

get/spaces/{spaceIdentifier}/channels/rule-test/v1

Request

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

Query parameters

deploymentProcessIdstring
feedIdstring
feedType'None' | 'NuGet' | 'Docker' | 'Maven' | 'OctopusProject' | 'GitHub' | 'Helm' | 'OciRegistry' | 'AwsElasticContainerRegistry' | 'BuiltIn' | 'S3' | 'AzureContainerRegistry' | 'GoogleContainerRegistry' | 'ArtifactoryGeneric' | 'Npm' | 'GcsStorage' | 'PyPi'
preReleaseTagPatternstring
stepNamestring
versionstring required
versionRangestring
versionTagRegexstring

Response

The result of testing the Channel version rules

Errorsstring[] required
SatisfiesPreReleaseTagboolean required
SatisfiesVersionRangeboolean required
SatisfiesVersionTagRegexboolean required

Whether the version satisfies the rule's version-tag regex. Defaults to true (no regex, or a legacy caller, counts as satisfied).

Changes

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