peertube_python_api/docs/VideoFilesApi.md

peertube.VideoFilesApi

All URIs are relative to https://peertube2.cpy.re

Method	HTTP request	Description
del_video_hls	DELETE /api/v1/videos/{id}/hls	Delete video HLS files
del_video_web_videos	DELETE /api/v1/videos/{id}/web-videos	Delete video Web Video files

del_video_hls

del_video_hls(id)

Delete video HLS files

Example

• OAuth Authentication (OAuth2):

import peertube
from peertube.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://peertube2.cpy.re
# See configuration.py for a list of all supported configuration parameters.
configuration = peertube.Configuration(
    host = "https://peertube2.cpy.re"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with peertube.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = peertube.VideoFilesApi(api_client)
    id = peertube.ApiV1VideosOwnershipIdAcceptPostIdParameter() # ApiV1VideosOwnershipIdAcceptPostIdParameter | The object id, uuid or short uuid

    try:
        # Delete video HLS files
        api_instance.del_video_hls(id)
    except Exception as e:
        print("Exception when calling VideoFilesApi->del_video_hls: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	ApiV1VideosOwnershipIdAcceptPostIdParameter	The object id, uuid or short uuid

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	successful operation	-
404	video does not exist	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

del_video_web_videos

del_video_web_videos(id)

Delete video Web Video files

PeerTube >= 6.0

Example

• OAuth Authentication (OAuth2):

import peertube
from peertube.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://peertube2.cpy.re
# See configuration.py for a list of all supported configuration parameters.
configuration = peertube.Configuration(
    host = "https://peertube2.cpy.re"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with peertube.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = peertube.VideoFilesApi(api_client)
    id = peertube.ApiV1VideosOwnershipIdAcceptPostIdParameter() # ApiV1VideosOwnershipIdAcceptPostIdParameter | The object id, uuid or short uuid

    try:
        # Delete video Web Video files
        api_instance.del_video_web_videos(id)
    except Exception as e:
        print("Exception when calling VideoFilesApi->del_video_web_videos: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	ApiV1VideosOwnershipIdAcceptPostIdParameter	The object id, uuid or short uuid

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	successful operation	-
404	video does not exist	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]