---
title: "Test Channel version rules"
method: GET
path: "/channels/rule-test/v1"
tags: ["Channels"]
---

# Test Channel version rules

`GET /channels/rule-test/v1`

## Request

- Base URL: `https://demo.octopus.app/api`
- URL: `https://demo.octopus.app/api/channels/rule-test/v1`
- Auth: one of:
  - API key in header `X-Octopus-ApiKey`
  - API key in query parameter `ApiKey`
  - API key in header `X-NuGet-ApiKey`

## Query parameters

- `deploymentProcessId` string
- `feedId` string
- `feedType` '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

- TestChannelVersionRulesResponseV1
  - `Errors` string[], required
  - `SatisfiesPreReleaseTag` boolean, required
  - `SatisfiesVersionRange` boolean, required
  - `SatisfiesVersionTagRegex` boolean, required: Whether the version satisfies the rule's version-tag regex. Defaults to true (no regex, or a legacy caller, counts as satisfied).

## Other responses

- `400`: Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404`: Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.dev/octopus/apis/octopus-server-api.md) - [All operations](https://skmtc.dev/octopus/apis/octopus-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octopus/apis/octopus-server-api/revisions/fe937c07da34?raw)