From defa20c5580dde56b01acb95c7fce635a700505b Mon Sep 17 00:00:00 2001 From: Mattias Buelens Date: Fri, 6 Mar 2026 15:09:06 +0100 Subject: [PATCH 1/3] Fix THEOlive v1 docs to point to other v1 docs --- theolive_versioned_docs/version-v1/api/index.mdx | 2 +- .../version-v1/contribution/software-encoders/obs.md | 4 ++-- .../version-v1/contribution/software-encoders/vmix.md | 2 +- .../contribution/software-encoders/wirecast.md | 2 +- .../version-v1/contribution/stream-configuration.mdx | 2 +- theolive_versioned_docs/version-v1/getting-started.mdx | 10 +++++----- .../version-v1/platform/multi-channel.md | 10 +++++----- .../platform/real-time-update-with-webhooks.mdx | 4 ++-- .../version-v1/platform/redundancy.md | 4 ++-- .../version-v1/platform/scheduler.mdx | 8 ++++---- .../version-v1/platform/security/geo-blocking.md | 6 +++--- .../version-v1/platform/security/ip-blocking.md | 6 +++--- .../platform/security/token-based-security.mdx | 2 +- .../playback/android/token-based-security.mdx | 2 +- .../playback/react-native/token-based-security.mdx | 2 +- .../version-v1/playback/roku/00-getting-started.mdx | 2 +- .../playback/roku/01-token-based-security.mdx | 2 +- .../version-v1/playback/web/token-based-security.mdx | 2 +- 18 files changed, 36 insertions(+), 36 deletions(-) diff --git a/theolive_versioned_docs/version-v1/api/index.mdx b/theolive_versioned_docs/version-v1/api/index.mdx index a5251b82247b..1f8c74858ba9 100644 --- a/theolive_versioned_docs/version-v1/api/index.mdx +++ b/theolive_versioned_docs/version-v1/api/index.mdx @@ -9,6 +9,6 @@ import SidebarCategoryDocCardList from '@site/src/components/SidebarCategoryDocC THEOlive provides a REST API to manage channels, receive events, create reports, and set up webhooks. Alternatively, you can perform the most common actions directly from the THEOlive management console. -See [our getting started guide](/theolive/getting-started.mdx) for more information. +See [our getting started guide](../getting-started.mdx) for more information. diff --git a/theolive_versioned_docs/version-v1/contribution/software-encoders/obs.md b/theolive_versioned_docs/version-v1/contribution/software-encoders/obs.md index b219125e26f6..9a92e85b48d6 100644 --- a/theolive_versioned_docs/version-v1/contribution/software-encoders/obs.md +++ b/theolive_versioned_docs/version-v1/contribution/software-encoders/obs.md @@ -10,7 +10,7 @@ sidebar_label: OBS See the official [obsproject.com](https://obsproject.com) documentation for installation instructions and additional support about using OBS. :::tip Getting Started -If you haven't already, begin by following the [Getting Started](/theolive/getting-started.mdx) tutorial to create a THEOlive channel and start your first broadcast. +If you haven't already, begin by following the [Getting Started](../../getting-started.mdx) tutorial to create a THEOlive channel and start your first broadcast. ::: ## Setting up a broadcast @@ -60,7 +60,7 @@ Hit apply on settings, close the window, and click on _Start Streaming_ in the _ Your THEOlive channel must be started in order to receive video ingest from OBS. You can choose to start up your channel before or after you start streaming via OBS. -Starting a channel can be done either [through the API](/theolive/api/channels/start-channel) or via [the console](https://console.theo.live/). +Starting a channel can be done either [through the API](../../api/channels/start-channel.api.mdx) or via [the console](https://console.theo.live/). ![Start your channel](../../assets/img/consolechannelstart.png) diff --git a/theolive_versioned_docs/version-v1/contribution/software-encoders/vmix.md b/theolive_versioned_docs/version-v1/contribution/software-encoders/vmix.md index 8e739017e8b2..8a2883fab257 100644 --- a/theolive_versioned_docs/version-v1/contribution/software-encoders/vmix.md +++ b/theolive_versioned_docs/version-v1/contribution/software-encoders/vmix.md @@ -57,4 +57,4 @@ You can now save and exit out of all the _Streaming Settings_ menus and click th ## 4. Start your THEOlive channel -This can be done either through the [API](/theolive/api/channels/start-channel) or via the [management console](https://console.theo.live/). +This can be done either through the [API](../../api/channels/start-channel.api.mdx) or via the [management console](https://console.theo.live/). diff --git a/theolive_versioned_docs/version-v1/contribution/software-encoders/wirecast.md b/theolive_versioned_docs/version-v1/contribution/software-encoders/wirecast.md index e4202e2f53f6..1e38aa33ad9e 100644 --- a/theolive_versioned_docs/version-v1/contribution/software-encoders/wirecast.md +++ b/theolive_versioned_docs/version-v1/contribution/software-encoders/wirecast.md @@ -68,4 +68,4 @@ Click the "Stream" button. Wirecast will make a connection to the THEOlive RTMP ## 4. Start your THEOlive channel -This can be done either through the [API](/theolive/api/channels/start-channel) or via the [management console](https://console.theo.live/). +This can be done either through the [API](../../api/channels/start-channel.api.mdx) or via the [management console](https://console.theo.live/). diff --git a/theolive_versioned_docs/version-v1/contribution/stream-configuration.mdx b/theolive_versioned_docs/version-v1/contribution/stream-configuration.mdx index 2f4b1e6d8605..bd916abc7cd9 100644 --- a/theolive_versioned_docs/version-v1/contribution/stream-configuration.mdx +++ b/theolive_versioned_docs/version-v1/contribution/stream-configuration.mdx @@ -14,7 +14,7 @@ THEOlive offers pre-defined ABR profiles (or "presets") which allows you to adju ## Setting the stream configuration via the `streamConfig` object -The goal is to pass a `streamConfig` object during the [creation](/theolive/api/channels/create-channel) of a channel, or when [updating](/theolive/api/channels/update-channel) it. This object consists of: +The goal is to pass a `streamConfig` object during the [creation](../api/channels/create-channel.api.mdx) of a channel, or when [updating](../api/channels/update-channel.api.mdx) it. This object consists of: - `bitrate`: the max bitrate value that will be used in Mbps. - `resolution`: the max resolution that will be used. Possible values: `"1080p"`, `"720p"`, `"576p"`, `"480p"`. diff --git a/theolive_versioned_docs/version-v1/getting-started.mdx b/theolive_versioned_docs/version-v1/getting-started.mdx index cc4f7ada6be8..25bd83518ecd 100644 --- a/theolive_versioned_docs/version-v1/getting-started.mdx +++ b/theolive_versioned_docs/version-v1/getting-started.mdx @@ -5,7 +5,7 @@ sidebar_label: Getting started # Backend -THEOlive provides a REST API to manage channels, configure them and start / stop them. Each possible call can be found at our [API Reference](/theolive/api/channels/create-channel). +THEOlive provides a REST API to manage channels, configure them and start / stop them. Each possible call can be found at our [API Reference](./api/channels/create-channel.api.mdx). However, to make things easier for non-developers, we built a management console on top of these API calls which makes it straightforward to perform the basic actions. To be able to create and use a THEOlive channel, you should register for an account and get a token to perform [authenticated requests](./platform/authorization.mdx) to our API. @@ -19,7 +19,7 @@ Once you've entered your username and password, you can already create your firs :::info 📘 API reference -This guide describes how to get started with the THEOlive management console. Please consult the [API reference](/theolive/api/channels/create-channel) and [Authorization](./platform/authorization.mdx) if you would like to work with API calls. +This guide describes how to get started with the THEOlive management console. Please consult the [API reference](./api/channels/create-channel.api.mdx) and [Authorization](./platform/authorization.mdx) if you would like to work with API calls. ::: ## 2. Create your first channel @@ -32,7 +32,7 @@ When hitting 'Create', you will be navigated towards the Details page of your ne ![](assets/img/467abb8-overview.PNG 'Management console: Details page with the possibility to start your channel and options to customize your player.') -A channel can also be created through an API call to the `channels` endpoint, passing an ingest location and a name. It will return an `id` that you can use to start, stop, update or delete the channel later on. Also, a `streamKey` and `rtmpPushUrl` will be returned to stream your content to. More information about the Create channel endpoint and how to pass advanced properties can be found [here](/theolive/api/channels/create-channel). +A channel can also be created through an API call to the `channels` endpoint, passing an ingest location and a name. It will return an `id` that you can use to start, stop, update or delete the channel later on. Also, a `streamKey` and `rtmpPushUrl` will be returned to stream your content to. More information about the Create channel endpoint and how to pass advanced properties can be found [here](./api/channels/create-channel.api.mdx). ```curl curl --location --request POST 'https://api.theo.live/channels' @@ -95,7 +95,7 @@ You can easily start your channel on the channel details page, by clicking on th ![](assets/img/cbe288c-start.PNG) -In the background this will make a `POST` request to the `channels/start` endpoint. You can also start a channel via the Start channel API call, for which you can find more information [here](/theolive/api/channels/start-channel). As mentioned in the last section, you can optionally pass the `rtmpPullUrl` property in the body of the request for pull-based streaming. Don't forget to stop streaming when you are done! +In the background this will make a `POST` request to the `channels/start` endpoint. You can also start a channel via the Start channel API call, for which you can find more information [here](./api/channels/start-channel.api.mdx). As mentioned in the last section, you can optionally pass the `rtmpPullUrl` property in the body of the request for pull-based streaming. Don't forget to stop streaming when you are done! ```curl curl --location --request POST 'https://api.theo.live/channels/{channel-id}/start' \ @@ -108,7 +108,7 @@ curl --location --request POST 'https://api.theo.live/channels/{channel-id}/star ## 6. Stop the channel -Have you finished your real-time streaming? Make sure to stop your channel by making a request to the `channels/stop` endpoint, either through a [Stop channel](/theolive/api/channels/stop-channel) API call or by pressing the red "stop" button in the management console. +Have you finished your real-time streaming? Make sure to stop your channel by making a request to the `channels/stop` endpoint, either through a [Stop channel](./api/channels/stop-channel.api.mdx) API call or by pressing the red "stop" button in the management console. ```curl curl --location --request POST 'https://api.theo.live/channels/{channel-id}/stop' \ diff --git a/theolive_versioned_docs/version-v1/platform/multi-channel.md b/theolive_versioned_docs/version-v1/platform/multi-channel.md index d41730039b80..0fdd37ecf117 100644 --- a/theolive_versioned_docs/version-v1/platform/multi-channel.md +++ b/theolive_versioned_docs/version-v1/platform/multi-channel.md @@ -7,7 +7,7 @@ sidebar_label: Alias This guide outlines THEOlive’s multi-channel approach: ingest your stream once and create multiple channel aliases, each with its own unique playout configuration. In addition to customized settings per alias, THEOlive also allows you to apply individual security features—such as geoblocking and token-based authentication on a per-alias basis. -You can configure this via the [THEOlive management console](https://console.theo.live), as well via the [THEOlive API](/theolive/api/channels/create-channel-alias). +You can configure this via the [THEOlive management console](https://console.theo.live), as well via the [THEOlive API](../api/channels/create-channel-alias.api.mdx). ## Multi-channel: player aliases @@ -25,7 +25,7 @@ Including an alias is straightforward: Copy the alias’s Channel ID and paste i ### Managing your alias -At any time, you can [update](/theolive/api/channels/update-channel-alias), [enable](/theolive/api/channels/enable-channel-alias), [disable](/theolive/api/channels/disable-channel-alias) or [delete](/theolive/api/channels/delete-channel-alias) a channel alias. The default alias can't be deleted, you'll have to delete your whole channel in case you want to do so. +At any time, you can [update](../api/channels/update-channel-alias.api.mdx), [enable](../api/channels/enable-channel-alias.api.mdx), [disable](../api/channels/disable-channel-alias.api.mdx) or [delete](../api/channels/delete-channel-alias.api.mdx) a channel alias. The default alias can't be deleted, you'll have to delete your whole channel in case you want to do so. ![Icon buttons to disable, enable or delete an alias](../assets/img/8751d4a-alias-settings.PNG) @@ -33,7 +33,7 @@ At any time, you can [update](/theolive/api/channels/update-channel-alias), [ena You can visualize data for each channel alias individually. In the Console, the Analytics section of the Channel Details page provides insights such as concurrent viewers, latency, viewer locations, browser and operating system breakdowns, and total viewing minutes. Click on any of the links in the Analytics section to view detailed metrics for a specific alias. -THEOlive also offers an API endpoint where you can query the minutes viewed on an hourly basis per channel alias. You can read more about it [here](/theolive/api/channels/get-channel-alias-analytics). +THEOlive also offers an API endpoint where you can query the minutes viewed on an hourly basis per channel alias. You can read more about it [here](../api/channels/get-channel-alias-analytics.api.mdx). ![Link to viewing insights and channel usage page where analytics are stored per channel alias](../assets/img/3c77b57-channel-alias-analytics.png) @@ -41,5 +41,5 @@ THEOlive also offers an API endpoint where you can query the minutes viewed on a Creating channel aliases can serve useful in a couple of different ways. Here are a couple of examples where creating a channel alias can simplify your workflow -- Creating a stream that requires multiple stream [redundancy](/theolive/platform/redundancy/) or fallback solutions -- Creating a stream that requires different [geo-blocking](/theolive/platform/security/geo-blocking) rules for different countries +- Creating a stream that requires multiple stream [redundancy](./redundancy.md) or fallback solutions +- Creating a stream that requires different [geo-blocking](./security/geo-blocking.md) rules for different countries diff --git a/theolive_versioned_docs/version-v1/platform/real-time-update-with-webhooks.mdx b/theolive_versioned_docs/version-v1/platform/real-time-update-with-webhooks.mdx index 847139b146f9..9665aa0a4cdb 100644 --- a/theolive_versioned_docs/version-v1/platform/real-time-update-with-webhooks.mdx +++ b/theolive_versioned_docs/version-v1/platform/real-time-update-with-webhooks.mdx @@ -21,7 +21,7 @@ The main advantage of webhooks is that THEOlive informs you in real-time when an ## 2. Create and manage your webhooks -You can create a webhook through the THEOlive API, or via the management console. In this document we will mainly describe the console approach, the full API reference for the actions and methods can be found [here](/theolive/api/webhooks/create-webhook). +You can create a webhook through the THEOlive API, or via the management console. In this document we will mainly describe the console approach, the full API reference for the actions and methods can be found [here](../api/webhooks/create-webhook.api.mdx). To create a webhook, click on "Webhooks" on the sidebar, followed by "Create". A webhook expects a name, a valid HTTPS endpoint, an optional description and a list of events it should listen and act on. A full list of events can be found at the bottom of this page. You can also select to listen to all possible events. When using the API, you can pass `events: ["*"]` when a webhook should listen to all events. @@ -50,7 +50,7 @@ app.listen(port, () => { :::warning 🚧 Newly created webhooks will be disabled by default -When you create a webhook, it won't be active yet. THEOlive does this so you can test things out before we actually start firing events to your endpoint. When you think you are fully ready to receive webhook messages from THEOlive, you can enable the webhook through the console, or via the [/webhooks/$\{webhook-id\}/enable](/theolive/api/webhooks/enable-webhook) endpoint. +When you create a webhook, it won't be active yet. THEOlive does this so you can test things out before we actually start firing events to your endpoint. When you think you are fully ready to receive webhook messages from THEOlive, you can enable the webhook through the console, or via the [/webhooks/$\{webhook-id\}/enable](../api/webhooks/enable-webhook.api.mdx) endpoint. ::: When a webhook is created, you can update or delete it through the API or management console. At the details page you can also see the history of all message that have been sent to your endpoint, and if they've failed or not. diff --git a/theolive_versioned_docs/version-v1/platform/redundancy.md b/theolive_versioned_docs/version-v1/platform/redundancy.md index f34a950d424f..a3b5aa5050ca 100644 --- a/theolive_versioned_docs/version-v1/platform/redundancy.md +++ b/theolive_versioned_docs/version-v1/platform/redundancy.md @@ -23,7 +23,7 @@ In what follows, we describe the approach to set a fallback for one channel. ## 1. Create two channels and start them. -You'll need to create two THEOlive channels via the [API](/theolive/api/channels/create-channel) or [management console](https://console.theo.live/). Let's say for example that we have the following channels with fictive IDs: +You'll need to create two THEOlive channels via the [API](../api/channels/create-channel.api.mdx) or [management console](https://console.theo.live/). Let's say for example that we have the following channels with fictive IDs: - Channel `` which is located in the `us-west` region - Channel `` which is located in the `us-east` region @@ -52,7 +52,7 @@ This will work as follows: 5. This process will continue to work this way. If both streams are unavailable, the pre-live settings will be shown (an announcement message and optionally a poster image too). 6. When the primary channel is stopped, all players will stop playing (even if the fallback channel is still streaming). -For more information, please visit our [API Reference](/theolive/api/channels/update-channel). +For more information, please visit our [API Reference](../api/channels/update-channel.api.mdx). Note that the fallback can also easily be set in our management console on the Channel Details page. Scroll down to the **Playout Configurations** section and select the _Fallback_ tab. diff --git a/theolive_versioned_docs/version-v1/platform/scheduler.mdx b/theolive_versioned_docs/version-v1/platform/scheduler.mdx index 60342062fdc8..55a235e3c79b 100644 --- a/theolive_versioned_docs/version-v1/platform/scheduler.mdx +++ b/theolive_versioned_docs/version-v1/platform/scheduler.mdx @@ -46,12 +46,12 @@ Approximately 15 minutes after the scheduler ends, THEOlive generates a usage re ## Creating and managing a scheduler through the API -Setting up a schedule via the THEOlive API is quick and straightforward. For full implementation details, refer to the [Create scheduler](/theolive/api/schedulers/create-scheduler) API documentation. +Setting up a schedule via the THEOlive API is quick and straightforward. For full implementation details, refer to the [Create scheduler](../api/schedulers/create-scheduler.api.mdx) API documentation. - **Updating a scheduler**: You can modify a scheduler at any time before or during its active period. -- **Manual termination**: If your events ends early or you didn't set an end time, you can manually stop the scheduler using the [Terminate scheduler](/theolive/api/schedulers/terminate-scheduler) endpoint. -- **Deleting a scheduler**: If the scheduler hasn’t started yet, it can be removed using the [Delete scheduler](/theolive/api/schedulers/delete-scheduler) endpoint. -- **Accessing usage reports**: About 15 minutes after a scheduler has ended or been terminated, a detailed report becomes available via the [Get scheduler report](/theolive/api/schedulers/get-scheduler-report) endpoint. +- **Manual termination**: If your events ends early or you didn't set an end time, you can manually stop the scheduler using the [Terminate scheduler](../api/schedulers/terminate-scheduler.api.mdx) endpoint. +- **Deleting a scheduler**: If the scheduler hasn’t started yet, it can be removed using the [Delete scheduler](../api/schedulers/delete-scheduler.api.mdx) endpoint. +- **Accessing usage reports**: About 15 minutes after a scheduler has ended or been terminated, a detailed report becomes available via the [Get scheduler report](../api/schedulers/get-scheduler-report.api.mdx) endpoint. ## Scheduler management in the console diff --git a/theolive_versioned_docs/version-v1/platform/security/geo-blocking.md b/theolive_versioned_docs/version-v1/platform/security/geo-blocking.md index dee5cc9cdc7c..adb19af13db2 100644 --- a/theolive_versioned_docs/version-v1/platform/security/geo-blocking.md +++ b/theolive_versioned_docs/version-v1/platform/security/geo-blocking.md @@ -1,6 +1,6 @@ # Geo-blocking -Geo-blocking refers to the action of restricting ("blacklisting") or allowing ("whitelisting") access to certain content based on the geographical location of the user. Filtering can be allowed or denied by countries as well as [IP addresses](/theolive/platform/security/ip-blocking). Geo-blocking enables content providers to adhere to specific licensing agreements and distribution rights, protect copyrighted material, or service another layer of privacy when working on private content. +Geo-blocking refers to the action of restricting ("blacklisting") or allowing ("whitelisting") access to certain content based on the geographical location of the user. Filtering can be allowed or denied by countries as well as [IP addresses](./ip-blocking.md). Geo-blocking enables content providers to adhere to specific licensing agreements and distribution rights, protect copyrighted material, or service another layer of privacy when working on private content. Geo-blocking can be configured via the API or the console. @@ -8,7 +8,7 @@ Geo-blocking can be configured via the API or the console. ### Main channel -You can enable geo-blocking on a channel by [updating](/theolive/api/channels/update-channel) the `geoBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: +You can enable geo-blocking on a channel by [updating](../../api/channels/update-channel.api.mdx) the `geoBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: - `whitelist`: Used by default when no `mode` is passed. This will make the content only available in the countries that have been specified in the `countries` property. Countries not listed in the `countries` property will not receive the stream. - `blacklist`: Blocks the content in the countries that have been specified in the `countries` property. All other countries not specified in the `countries` property will be able to view the content. @@ -63,7 +63,7 @@ If you would like to make your content available anywhere **except** Belgium, yo ### Channel alias -Geo-blocking can also be done on a [channel alias](/theolive/platform/multi-channel) using the specified channel alias [endpoint](/theolive/api/channels/update-channel-alias) or via the console. +Geo-blocking can also be done on a [channel alias](../multi-channel.md) using the specified channel alias [endpoint](../../api/channels/update-channel-alias.api.mdx) or via the console. ## Geo-blocking on main channel and alias diff --git a/theolive_versioned_docs/version-v1/platform/security/ip-blocking.md b/theolive_versioned_docs/version-v1/platform/security/ip-blocking.md index 66dac892f4a3..90fd698c934c 100644 --- a/theolive_versioned_docs/version-v1/platform/security/ip-blocking.md +++ b/theolive_versioned_docs/version-v1/platform/security/ip-blocking.md @@ -1,6 +1,6 @@ # IP-blocking -IP-blocking (or IP-banning) refers to a security measure that restricts access to content for specific IP addresses. Filtering can be allowed or denied by IP addresses or by [countries](/theolive/platform/security/geo-blocking) as well. Only IPv4 and IPv6 CIDRs (Classless Inter-Domain Routing) are allowed. +IP-blocking (or IP-banning) refers to a security measure that restricts access to content for specific IP addresses. Filtering can be allowed or denied by IP addresses or by [countries](./geo-blocking.md) as well. Only IPv4 and IPv6 CIDRs (Classless Inter-Domain Routing) are allowed. IP-blocking can be configured via the API or the console. @@ -8,7 +8,7 @@ IP-blocking can be configured via the API or the console. ### Main channel -You can enable IP-blocking on a channel by [updating](/theolive/api/channels/update-channel) the `ipBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: +You can enable IP-blocking on a channel by [updating](../../api/channels/update-channel.api.mdx) the `ipBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: - `whitelist`: Used by default when no `mode` is passed. This will make the content only available for the CIDRs that have been specified in the `cidrs` property. CIDRs not listed in the `cidrs` property will not receive the stream. - `blacklist`: Blocks the content for the CIDRs that have been specified in the `cidrs` property. All CIDRs not specified in the `cidrs` property will be able to view the content. @@ -29,7 +29,7 @@ For example: If you want to restrict certain CIDRs from viewing your content, yo ### Channel Alias -IP-blocking can also be done on a [channel alias](/theolive/platform/multi-channel) using the specified channel alias [endpoint](/theolive/api/channels/update-channel-alias) or via the console. +IP-blocking can also be done on a [channel alias](../multi-channel.md) using the specified channel alias [endpoint](../../api/channels/update-channel-alias.api.mdx) or via the console. ## IP-blocking via the console diff --git a/theolive_versioned_docs/version-v1/platform/security/token-based-security.mdx b/theolive_versioned_docs/version-v1/platform/security/token-based-security.mdx index f5a4716a2dd2..986715a36894 100644 --- a/theolive_versioned_docs/version-v1/platform/security/token-based-security.mdx +++ b/theolive_versioned_docs/version-v1/platform/security/token-based-security.mdx @@ -40,7 +40,7 @@ It was signed with the following random secret: `d2e166fdda89824a6c493d8a2af7a07 ## Enable or disable token security for an alias -Please refer to the [Enable token security for alias](/theolive/api/channels/enable-token-security-for-alias) and [Disable token security for alias](/theolive/api/channels/disable-token-security-for-alias) API endpoints to manage the token security settings for an alias. +Please refer to the [Enable token security for alias](../../api/channels/enable-token-security-for-alias.api.mdx) and [Disable token security for alias](../../api/channels/disable-token-security-for-alias.api.mdx) API endpoints to manage the token security settings for an alias. When enabling for the first time, you have to pass the `key` property in the body. If you disable token security later on, and make it active again, you can omit this property if it should stay the same. diff --git a/theolive_versioned_docs/version-v1/playback/android/token-based-security.mdx b/theolive_versioned_docs/version-v1/playback/android/token-based-security.mdx index c408cc755341..f126581df31e 100644 --- a/theolive_versioned_docs/version-v1/playback/android/token-based-security.mdx +++ b/theolive_versioned_docs/version-v1/playback/android/token-based-security.mdx @@ -4,7 +4,7 @@ sidebar_position: 2 # Token based security -THEOlive offers the option to enable JWT token security on a distribution (formerly referred to as an alias) level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](/theolive/platform/security/token-based-security). +THEOlive offers the option to enable JWT token security on a distribution (formerly referred to as an alias) level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](../../platform/security/token-based-security.mdx). This page will demonstrate how to configure the Android SDK for playback of channels with token based security enabled. diff --git a/theolive_versioned_docs/version-v1/playback/react-native/token-based-security.mdx b/theolive_versioned_docs/version-v1/playback/react-native/token-based-security.mdx index fb037eea8fd4..51c6ce999bd1 100644 --- a/theolive_versioned_docs/version-v1/playback/react-native/token-based-security.mdx +++ b/theolive_versioned_docs/version-v1/playback/react-native/token-based-security.mdx @@ -1,6 +1,6 @@ # Token based security -THEOlive offers the option to enable JWT token security on channel distribution level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](/theolive/platform/security/token-based-security). +THEOlive offers the option to enable JWT token security on channel distribution level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](../../platform/security/token-based-security.mdx). This page will demonstrate how to configure the React Native Player SDK for playback of channels with token based security enabled. diff --git a/theolive_versioned_docs/version-v1/playback/roku/00-getting-started.mdx b/theolive_versioned_docs/version-v1/playback/roku/00-getting-started.mdx index 169cce837f18..7b029cc836fe 100644 --- a/theolive_versioned_docs/version-v1/playback/roku/00-getting-started.mdx +++ b/theolive_versioned_docs/version-v1/playback/roku/00-getting-started.mdx @@ -45,4 +45,4 @@ m.player.callFunc("configure", playerConfiguration) ## More information - [API references](/theoplayer/api-reference/roku) -- [Migrating to THEOlive v2](/theolive/playback/roku/02-migrating-to-v2.mdx) +- [Migrating to THEOlive v2](./02-migrating-to-v2.mdx) diff --git a/theolive_versioned_docs/version-v1/playback/roku/01-token-based-security.mdx b/theolive_versioned_docs/version-v1/playback/roku/01-token-based-security.mdx index d056c1427ad3..1a09e536cc83 100644 --- a/theolive_versioned_docs/version-v1/playback/roku/01-token-based-security.mdx +++ b/theolive_versioned_docs/version-v1/playback/roku/01-token-based-security.mdx @@ -1,6 +1,6 @@ # Token based security -THEOlive offers the option to enable JWT token security on channel distribution level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](/theolive/platform/security/token-based-security). +THEOlive offers the option to enable JWT token security on channel distribution level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](../../platform/security/token-based-security.mdx). This page will demonstrate how to configure the Roku Player SDK for playback of channels with token based security enabled. diff --git a/theolive_versioned_docs/version-v1/playback/web/token-based-security.mdx b/theolive_versioned_docs/version-v1/playback/web/token-based-security.mdx index 210da8f5dcb8..52368f2b03a0 100644 --- a/theolive_versioned_docs/version-v1/playback/web/token-based-security.mdx +++ b/theolive_versioned_docs/version-v1/playback/web/token-based-security.mdx @@ -4,7 +4,7 @@ sidebar_position: 6 # Token based security -THEOlive offers the option to enable JWT token security on a distribution (formerly referred to as an alias) level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](/theolive/platform/security/token-based-security). +THEOlive offers the option to enable JWT token security on a distribution (formerly referred to as an alias) level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](../../platform/security/token-based-security.mdx). This page will demonstrate how to configure the Web SDK for playback of channels with token based security enabled. From 975f3e243512f66dbc1e4297c20c90a8761ed14c Mon Sep 17 00:00:00 2001 From: Mattias Buelens Date: Fri, 6 Mar 2026 15:14:33 +0100 Subject: [PATCH 2/3] Use relative links --- theolive/api/index.mdx | 2 +- theolive/contribution/software-encoders/obs.md | 2 +- theolive/platform/multi-channel.md | 4 ++-- theolive/platform/security/geo-blocking.md | 4 ++-- theolive/platform/security/ip-blocking.md | 4 ++-- theolive/playback/android/token-based-security.mdx | 2 +- theolive/playback/react-native/token-based-security.mdx | 2 +- theolive/playback/roku/00-getting-started.mdx | 2 +- theolive/playback/roku/01-token-based-security.mdx | 2 +- theolive/playback/web/token-based-security.mdx | 2 +- 10 files changed, 13 insertions(+), 13 deletions(-) diff --git a/theolive/api/index.mdx b/theolive/api/index.mdx index e9ebe9cc9573..8d0e34c6613e 100644 --- a/theolive/api/index.mdx +++ b/theolive/api/index.mdx @@ -9,6 +9,6 @@ import SidebarCategoryDocCardList from '@site/src/components/SidebarCategoryDocC THEOlive provides a REST API to manage channels, receive events, create reports, and set up webhooks. Alternatively, you can perform the most common actions directly from the THEOlive management console. -See [our getting started guide](/theolive/getting-started.mdx) for more information. +See [our getting started guide](../getting-started.mdx) for more information. diff --git a/theolive/contribution/software-encoders/obs.md b/theolive/contribution/software-encoders/obs.md index b219125e26f6..a9ceae4f1461 100644 --- a/theolive/contribution/software-encoders/obs.md +++ b/theolive/contribution/software-encoders/obs.md @@ -10,7 +10,7 @@ sidebar_label: OBS See the official [obsproject.com](https://obsproject.com) documentation for installation instructions and additional support about using OBS. :::tip Getting Started -If you haven't already, begin by following the [Getting Started](/theolive/getting-started.mdx) tutorial to create a THEOlive channel and start your first broadcast. +If you haven't already, begin by following the [Getting Started](../../getting-started.mdx) tutorial to create a THEOlive channel and start your first broadcast. ::: ## Setting up a broadcast diff --git a/theolive/platform/multi-channel.md b/theolive/platform/multi-channel.md index d41730039b80..653d9e160fb0 100644 --- a/theolive/platform/multi-channel.md +++ b/theolive/platform/multi-channel.md @@ -41,5 +41,5 @@ THEOlive also offers an API endpoint where you can query the minutes viewed on a Creating channel aliases can serve useful in a couple of different ways. Here are a couple of examples where creating a channel alias can simplify your workflow -- Creating a stream that requires multiple stream [redundancy](/theolive/platform/redundancy/) or fallback solutions -- Creating a stream that requires different [geo-blocking](/theolive/platform/security/geo-blocking) rules for different countries +- Creating a stream that requires multiple stream [redundancy](./redundancy.md) or fallback solutions +- Creating a stream that requires different [geo-blocking](./security/geo-blocking.md) rules for different countries diff --git a/theolive/platform/security/geo-blocking.md b/theolive/platform/security/geo-blocking.md index dee5cc9cdc7c..cd66007be932 100644 --- a/theolive/platform/security/geo-blocking.md +++ b/theolive/platform/security/geo-blocking.md @@ -1,6 +1,6 @@ # Geo-blocking -Geo-blocking refers to the action of restricting ("blacklisting") or allowing ("whitelisting") access to certain content based on the geographical location of the user. Filtering can be allowed or denied by countries as well as [IP addresses](/theolive/platform/security/ip-blocking). Geo-blocking enables content providers to adhere to specific licensing agreements and distribution rights, protect copyrighted material, or service another layer of privacy when working on private content. +Geo-blocking refers to the action of restricting ("blacklisting") or allowing ("whitelisting") access to certain content based on the geographical location of the user. Filtering can be allowed or denied by countries as well as [IP addresses](./ip-blocking.md). Geo-blocking enables content providers to adhere to specific licensing agreements and distribution rights, protect copyrighted material, or service another layer of privacy when working on private content. Geo-blocking can be configured via the API or the console. @@ -63,7 +63,7 @@ If you would like to make your content available anywhere **except** Belgium, yo ### Channel alias -Geo-blocking can also be done on a [channel alias](/theolive/platform/multi-channel) using the specified channel alias [endpoint](/theolive/api/channels/update-channel-alias) or via the console. +Geo-blocking can also be done on a [channel alias](../multi-channel.md) using the specified channel alias [endpoint](/theolive/api/channels/update-channel-alias) or via the console. ## Geo-blocking on main channel and alias diff --git a/theolive/platform/security/ip-blocking.md b/theolive/platform/security/ip-blocking.md index 66dac892f4a3..644a5b3966bc 100644 --- a/theolive/platform/security/ip-blocking.md +++ b/theolive/platform/security/ip-blocking.md @@ -1,6 +1,6 @@ # IP-blocking -IP-blocking (or IP-banning) refers to a security measure that restricts access to content for specific IP addresses. Filtering can be allowed or denied by IP addresses or by [countries](/theolive/platform/security/geo-blocking) as well. Only IPv4 and IPv6 CIDRs (Classless Inter-Domain Routing) are allowed. +IP-blocking (or IP-banning) refers to a security measure that restricts access to content for specific IP addresses. Filtering can be allowed or denied by IP addresses or by [countries](./geo-blocking.md) as well. Only IPv4 and IPv6 CIDRs (Classless Inter-Domain Routing) are allowed. IP-blocking can be configured via the API or the console. @@ -29,7 +29,7 @@ For example: If you want to restrict certain CIDRs from viewing your content, yo ### Channel Alias -IP-blocking can also be done on a [channel alias](/theolive/platform/multi-channel) using the specified channel alias [endpoint](/theolive/api/channels/update-channel-alias) or via the console. +IP-blocking can also be done on a [channel alias](../multi-channel.md) using the specified channel alias [endpoint](/theolive/api/channels/update-channel-alias) or via the console. ## IP-blocking via the console diff --git a/theolive/playback/android/token-based-security.mdx b/theolive/playback/android/token-based-security.mdx index c408cc755341..f126581df31e 100644 --- a/theolive/playback/android/token-based-security.mdx +++ b/theolive/playback/android/token-based-security.mdx @@ -4,7 +4,7 @@ sidebar_position: 2 # Token based security -THEOlive offers the option to enable JWT token security on a distribution (formerly referred to as an alias) level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](/theolive/platform/security/token-based-security). +THEOlive offers the option to enable JWT token security on a distribution (formerly referred to as an alias) level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](../../platform/security/token-based-security.mdx). This page will demonstrate how to configure the Android SDK for playback of channels with token based security enabled. diff --git a/theolive/playback/react-native/token-based-security.mdx b/theolive/playback/react-native/token-based-security.mdx index fb037eea8fd4..51c6ce999bd1 100644 --- a/theolive/playback/react-native/token-based-security.mdx +++ b/theolive/playback/react-native/token-based-security.mdx @@ -1,6 +1,6 @@ # Token based security -THEOlive offers the option to enable JWT token security on channel distribution level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](/theolive/platform/security/token-based-security). +THEOlive offers the option to enable JWT token security on channel distribution level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](../../platform/security/token-based-security.mdx). This page will demonstrate how to configure the React Native Player SDK for playback of channels with token based security enabled. diff --git a/theolive/playback/roku/00-getting-started.mdx b/theolive/playback/roku/00-getting-started.mdx index 169cce837f18..7b029cc836fe 100644 --- a/theolive/playback/roku/00-getting-started.mdx +++ b/theolive/playback/roku/00-getting-started.mdx @@ -45,4 +45,4 @@ m.player.callFunc("configure", playerConfiguration) ## More information - [API references](/theoplayer/api-reference/roku) -- [Migrating to THEOlive v2](/theolive/playback/roku/02-migrating-to-v2.mdx) +- [Migrating to THEOlive v2](./02-migrating-to-v2.mdx) diff --git a/theolive/playback/roku/01-token-based-security.mdx b/theolive/playback/roku/01-token-based-security.mdx index d056c1427ad3..1a09e536cc83 100644 --- a/theolive/playback/roku/01-token-based-security.mdx +++ b/theolive/playback/roku/01-token-based-security.mdx @@ -1,6 +1,6 @@ # Token based security -THEOlive offers the option to enable JWT token security on channel distribution level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](/theolive/platform/security/token-based-security). +THEOlive offers the option to enable JWT token security on channel distribution level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](../../platform/security/token-based-security.mdx). This page will demonstrate how to configure the Roku Player SDK for playback of channels with token based security enabled. diff --git a/theolive/playback/web/token-based-security.mdx b/theolive/playback/web/token-based-security.mdx index 210da8f5dcb8..52368f2b03a0 100644 --- a/theolive/playback/web/token-based-security.mdx +++ b/theolive/playback/web/token-based-security.mdx @@ -4,7 +4,7 @@ sidebar_position: 6 # Token based security -THEOlive offers the option to enable JWT token security on a distribution (formerly referred to as an alias) level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](/theolive/platform/security/token-based-security). +THEOlive offers the option to enable JWT token security on a distribution (formerly referred to as an alias) level. This can be interesting if you only want valid users to access your stream. Read more about the feature and configuring it on your channels on the [token based security guide](../../platform/security/token-based-security.mdx). This page will demonstrate how to configure the Web SDK for playback of channels with token based security enabled. From 8935d2b23587113d73e861c6545f08556f5dbba3 Mon Sep 17 00:00:00 2001 From: Mattias Buelens Date: Fri, 6 Mar 2026 15:17:01 +0100 Subject: [PATCH 3/3] Link to THEOlive v2 API --- theolive/contribution/software-encoders/obs.md | 2 +- theolive/contribution/software-encoders/vmix.md | 2 +- theolive/contribution/software-encoders/wirecast.md | 2 +- theolive/contribution/stream-configuration.mdx | 2 +- theolive/getting-started.mdx | 10 +++++----- theolive/platform/redundancy.md | 4 ++-- theolive/platform/security/geo-blocking.md | 2 +- theolive/platform/security/ip-blocking.md | 2 +- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/theolive/contribution/software-encoders/obs.md b/theolive/contribution/software-encoders/obs.md index a9ceae4f1461..979f6cb27416 100644 --- a/theolive/contribution/software-encoders/obs.md +++ b/theolive/contribution/software-encoders/obs.md @@ -60,7 +60,7 @@ Hit apply on settings, close the window, and click on _Start Streaming_ in the _ Your THEOlive channel must be started in order to receive video ingest from OBS. You can choose to start up your channel before or after you start streaming via OBS. -Starting a channel can be done either [through the API](/theolive/api/channels/start-channel) or via [the console](https://console.theo.live/). +Starting a channel can be done either [through the API](../../api/start-a-channel-by-id.api.mdx) or via [the console](https://console.theo.live/). ![Start your channel](../../assets/img/consolechannelstart.png) diff --git a/theolive/contribution/software-encoders/vmix.md b/theolive/contribution/software-encoders/vmix.md index 8e739017e8b2..135e69b14723 100644 --- a/theolive/contribution/software-encoders/vmix.md +++ b/theolive/contribution/software-encoders/vmix.md @@ -57,4 +57,4 @@ You can now save and exit out of all the _Streaming Settings_ menus and click th ## 4. Start your THEOlive channel -This can be done either through the [API](/theolive/api/channels/start-channel) or via the [management console](https://console.theo.live/). +This can be done either through the [API](../../api/start-a-channel-by-id.api.mdx) or via the [management console](https://console.theo.live/). diff --git a/theolive/contribution/software-encoders/wirecast.md b/theolive/contribution/software-encoders/wirecast.md index e4202e2f53f6..597b4ffe964a 100644 --- a/theolive/contribution/software-encoders/wirecast.md +++ b/theolive/contribution/software-encoders/wirecast.md @@ -68,4 +68,4 @@ Click the "Stream" button. Wirecast will make a connection to the THEOlive RTMP ## 4. Start your THEOlive channel -This can be done either through the [API](/theolive/api/channels/start-channel) or via the [management console](https://console.theo.live/). +This can be done either through the [API](../../api/start-a-channel-by-id.api.mdx) or via the [management console](https://console.theo.live/). diff --git a/theolive/contribution/stream-configuration.mdx b/theolive/contribution/stream-configuration.mdx index 2f4b1e6d8605..d31d0fd59501 100644 --- a/theolive/contribution/stream-configuration.mdx +++ b/theolive/contribution/stream-configuration.mdx @@ -14,7 +14,7 @@ THEOlive offers pre-defined ABR profiles (or "presets") which allows you to adju ## Setting the stream configuration via the `streamConfig` object -The goal is to pass a `streamConfig` object during the [creation](/theolive/api/channels/create-channel) of a channel, or when [updating](/theolive/api/channels/update-channel) it. This object consists of: +The goal is to pass a `streamConfig` object during the [creation](../api/create-a-new-channel.api.mdx) of a channel, or when [updating](../api/update-a-channel-by-id.api.mdx) it. This object consists of: - `bitrate`: the max bitrate value that will be used in Mbps. - `resolution`: the max resolution that will be used. Possible values: `"1080p"`, `"720p"`, `"576p"`, `"480p"`. diff --git a/theolive/getting-started.mdx b/theolive/getting-started.mdx index cc4f7ada6be8..601ebc500e28 100644 --- a/theolive/getting-started.mdx +++ b/theolive/getting-started.mdx @@ -5,7 +5,7 @@ sidebar_label: Getting started # Backend -THEOlive provides a REST API to manage channels, configure them and start / stop them. Each possible call can be found at our [API Reference](/theolive/api/channels/create-channel). +THEOlive provides a REST API to manage channels, configure them and start / stop them. Each possible call can be found at our [API Reference](./api/create-a-new-channel.api.mdx). However, to make things easier for non-developers, we built a management console on top of these API calls which makes it straightforward to perform the basic actions. To be able to create and use a THEOlive channel, you should register for an account and get a token to perform [authenticated requests](./platform/authorization.mdx) to our API. @@ -19,7 +19,7 @@ Once you've entered your username and password, you can already create your firs :::info 📘 API reference -This guide describes how to get started with the THEOlive management console. Please consult the [API reference](/theolive/api/channels/create-channel) and [Authorization](./platform/authorization.mdx) if you would like to work with API calls. +This guide describes how to get started with the THEOlive management console. Please consult the [API reference](./api/create-a-new-channel.api.mdx) and [Authorization](./platform/authorization.mdx) if you would like to work with API calls. ::: ## 2. Create your first channel @@ -32,7 +32,7 @@ When hitting 'Create', you will be navigated towards the Details page of your ne ![](assets/img/467abb8-overview.PNG 'Management console: Details page with the possibility to start your channel and options to customize your player.') -A channel can also be created through an API call to the `channels` endpoint, passing an ingest location and a name. It will return an `id` that you can use to start, stop, update or delete the channel later on. Also, a `streamKey` and `rtmpPushUrl` will be returned to stream your content to. More information about the Create channel endpoint and how to pass advanced properties can be found [here](/theolive/api/channels/create-channel). +A channel can also be created through an API call to the `channels` endpoint, passing an ingest location and a name. It will return an `id` that you can use to start, stop, update or delete the channel later on. Also, a `streamKey` and `rtmpPushUrl` will be returned to stream your content to. More information about the Create channel endpoint and how to pass advanced properties can be found [here](./api/create-a-new-channel.api.mdx). ```curl curl --location --request POST 'https://api.theo.live/channels' @@ -95,7 +95,7 @@ You can easily start your channel on the channel details page, by clicking on th ![](assets/img/cbe288c-start.PNG) -In the background this will make a `POST` request to the `channels/start` endpoint. You can also start a channel via the Start channel API call, for which you can find more information [here](/theolive/api/channels/start-channel). As mentioned in the last section, you can optionally pass the `rtmpPullUrl` property in the body of the request for pull-based streaming. Don't forget to stop streaming when you are done! +In the background this will make a `POST` request to the `channels/start` endpoint. You can also start a channel via the Start channel API call, for which you can find more information [here](./api/start-a-channel-by-id.api.mdx). As mentioned in the last section, you can optionally pass the `rtmpPullUrl` property in the body of the request for pull-based streaming. Don't forget to stop streaming when you are done! ```curl curl --location --request POST 'https://api.theo.live/channels/{channel-id}/start' \ @@ -108,7 +108,7 @@ curl --location --request POST 'https://api.theo.live/channels/{channel-id}/star ## 6. Stop the channel -Have you finished your real-time streaming? Make sure to stop your channel by making a request to the `channels/stop` endpoint, either through a [Stop channel](/theolive/api/channels/stop-channel) API call or by pressing the red "stop" button in the management console. +Have you finished your real-time streaming? Make sure to stop your channel by making a request to the `channels/stop` endpoint, either through a [Stop channel](./api/stop-a-channel-by-id.api.mdx) API call or by pressing the red "stop" button in the management console. ```curl curl --location --request POST 'https://api.theo.live/channels/{channel-id}/stop' \ diff --git a/theolive/platform/redundancy.md b/theolive/platform/redundancy.md index f34a950d424f..da968ff5eb5b 100644 --- a/theolive/platform/redundancy.md +++ b/theolive/platform/redundancy.md @@ -23,7 +23,7 @@ In what follows, we describe the approach to set a fallback for one channel. ## 1. Create two channels and start them. -You'll need to create two THEOlive channels via the [API](/theolive/api/channels/create-channel) or [management console](https://console.theo.live/). Let's say for example that we have the following channels with fictive IDs: +You'll need to create two THEOlive channels via the [API](../api/create-a-new-channel.api.mdx) or [management console](https://console.theo.live/). Let's say for example that we have the following channels with fictive IDs: - Channel `` which is located in the `us-west` region - Channel `` which is located in the `us-east` region @@ -52,7 +52,7 @@ This will work as follows: 5. This process will continue to work this way. If both streams are unavailable, the pre-live settings will be shown (an announcement message and optionally a poster image too). 6. When the primary channel is stopped, all players will stop playing (even if the fallback channel is still streaming). -For more information, please visit our [API Reference](/theolive/api/channels/update-channel). +For more information, please visit our [API Reference](../api/update-a-channel-by-id.api.mdx). Note that the fallback can also easily be set in our management console on the Channel Details page. Scroll down to the **Playout Configurations** section and select the _Fallback_ tab. diff --git a/theolive/platform/security/geo-blocking.md b/theolive/platform/security/geo-blocking.md index cd66007be932..65990fe30976 100644 --- a/theolive/platform/security/geo-blocking.md +++ b/theolive/platform/security/geo-blocking.md @@ -8,7 +8,7 @@ Geo-blocking can be configured via the API or the console. ### Main channel -You can enable geo-blocking on a channel by [updating](/theolive/api/channels/update-channel) the `geoBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: +You can enable geo-blocking on a channel by [updating](../../api/update-a-channel-by-id.api.mdx) the `geoBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: - `whitelist`: Used by default when no `mode` is passed. This will make the content only available in the countries that have been specified in the `countries` property. Countries not listed in the `countries` property will not receive the stream. - `blacklist`: Blocks the content in the countries that have been specified in the `countries` property. All other countries not specified in the `countries` property will be able to view the content. diff --git a/theolive/platform/security/ip-blocking.md b/theolive/platform/security/ip-blocking.md index 644a5b3966bc..727085d908e3 100644 --- a/theolive/platform/security/ip-blocking.md +++ b/theolive/platform/security/ip-blocking.md @@ -8,7 +8,7 @@ IP-blocking can be configured via the API or the console. ### Main channel -You can enable IP-blocking on a channel by [updating](/theolive/api/channels/update-channel) the `ipBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: +You can enable IP-blocking on a channel by [updating](../../api/update-a-channel-by-id.api.mdx) the `ipBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: - `whitelist`: Used by default when no `mode` is passed. This will make the content only available for the CIDRs that have been specified in the `cidrs` property. CIDRs not listed in the `cidrs` property will not receive the stream. - `blacklist`: Blocks the content for the CIDRs that have been specified in the `cidrs` property. All CIDRs not specified in the `cidrs` property will be able to view the content.