channels

PUT /api/channels/{channelId}/desired-status

Changed on Mar 10, 2023

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/:channelId/desired-status/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channelIdstring uuid required

Headers

Api-Versionstring

The requested API version

Request body

channelIdstring uuid required

desiredStatus'Running' | 'Dead' required

Response

Success

Changes

Mar 10, 20234650ad92794e Revision changes
- breaking
  request body became required
- info
  added the new optional header request parameter Api-Version

Operation history