---
title: "GET /api/channels"
method: GET
path: "/api/channels"
tags: ["channels"]
---

# GET /api/channels

`GET /api/channels`

## Request

- The document declares no server URL.
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/fermyon/apis/fermyon-cloud-api/docs/api/channels/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `searchText` string
- `pageIndex` integer
- `pageSize` integer
- `sortBy` string
- `IsSortedAscending` boolean

## Headers

- `Api-Version` string

## Response `200`

Success

- ChannelItemPage
  - `items` ChannelItem[], required
    - `id` string, uuid, required
    - `appId` string, uuid, required
    - `name` string, required
    - `domain` string, required
    - `revisionSelectionStrategy` 'UseRangeRule' | 'UseSpecifiedRevision', required
    - `desiredStatus` string, required
    - `activeRevision` RevisionItem
      - `id` string, uuid, required
      - `appId` string, uuid, required
      - `revisionNumber` string, required
      - `components` RevisionComponentDto[], required
        - `id` string, uuid, required
        - `source` string, required
        - `name` string, required
        - `route` string, nullable
        - `type` string, nullable
      - `lastModified` string, date-time
    - `lastPublishAt` string, date-time, nullable
    - `rangeRule` string, nullable
    - `lastModified` string, date-time
    - `appSummary` AppSummaryDto
      - `id` string, uuid, required
      - `name` string, required
      - `storageId` string, required
      - `channels` AppChannelListItem[], required
        - `id` string, uuid, required
        - `name` string, required
        - `activeRevisionNumber` string
        - `domain` string
        - `created` string, date-time, required
        - `healthStatus` 'Healthy' | 'Unhealthy' | 'Degraded'
        - `lastModified` string, date-time
      - `lastModified` string, date-time
    - `environmentVariables` EnvironmentVariableItem[], required
      - `channelId` string, uuid, required
      - `key` string, required
      - `value` string, required
  - `totalItems` integer, required
  - `pageIndex` integer, required
  - `pageSize` integer, required
  - `isLastPage` boolean, required

## Changes

- **2024-05-01** `78d366daf86a`: 6 warning
  - removed the optional property `items/items/activeRevision/components/items/channel` from the response with the `200` status (media type: text/plain)
  - removed the optional property `items/items/activeRevision/components/items/channel` from the response with the `200` status (media type: application/json)
  - removed the optional property `items/items/activeRevision/components/items/channel` from the response with the `200` status (media type: text/json)
  - removed the optional property `items/items/activeRevision/type` from the response with the `200` status (media type: text/plain)
  - …2 more
- **2023-09-28** `da6d9622301d`: 12 info
  - added the optional property `items/items/activeRevision/lastModified` to the response with the `200` status (media type: text/plain)
  - added the optional property `items/items/activeRevision/lastModified` to the response with the `200` status (media type: application/json)
  - added the optional property `items/items/activeRevision/lastModified` to the response with the `200` status (media type: text/json)
  - added the optional property `items/items/appSummary/channels/items/lastModified` to the response with the `200` status (media type: text/plain)
  - …8 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/fermyon/apis/fermyon-cloud-api/changes/api/channels/get.md)

---

[API](https://skmtc.dev/fermyon/apis/fermyon-cloud-api.md) - [All operations](https://skmtc.dev/fermyon/apis/fermyon-cloud-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fermyon/apis/fermyon-cloud-api/revisions/78d366daf86a?raw)