readarr.RemotePathMappingApi

All URIs are relative to http://localhost:8787

Method	HTTP request	Description
create_remote_path_mapping	POST /api/v1/remotepathmapping
delete_remote_path_mapping	DELETE /api/v1/remotepathmapping/{id}
get_remote_path_mapping_by_id	GET /api/v1/remotepathmapping/{id}
list_remote_path_mapping	GET /api/v1/remotepathmapping
update_remote_path_mapping	PUT /api/v1/remotepathmapping/{id}

create_remote_path_mapping

RemotePathMappingResource create_remote_path_mapping(remote_path_mapping_resource=remote_path_mapping_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.models.remote_path_mapping_resource import RemotePathMappingResource
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# 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.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.RemotePathMappingApi(api_client)
    remote_path_mapping_resource = readarr.RemotePathMappingResource() # RemotePathMappingResource |  (optional)

    try:
        api_response = api_instance.create_remote_path_mapping(remote_path_mapping_resource=remote_path_mapping_resource)
        print("The response of RemotePathMappingApi->create_remote_path_mapping:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotePathMappingApi->create_remote_path_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
remote_path_mapping_resource	RemotePathMappingResource		[optional]

Return type

RemotePathMappingResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

delete_remote_path_mapping

delete_remote_path_mapping(id)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# 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.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.RemotePathMappingApi(api_client)
    id = 56 # int | 

    try:
        api_instance.delete_remote_path_mapping(id)
    except Exception as e:
        print("Exception when calling RemotePathMappingApi->delete_remote_path_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

get_remote_path_mapping_by_id

RemotePathMappingResource get_remote_path_mapping_by_id(id)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.models.remote_path_mapping_resource import RemotePathMappingResource
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# 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.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.RemotePathMappingApi(api_client)
    id = 56 # int | 

    try:
        api_response = api_instance.get_remote_path_mapping_by_id(id)
        print("The response of RemotePathMappingApi->get_remote_path_mapping_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotePathMappingApi->get_remote_path_mapping_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

RemotePathMappingResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

list_remote_path_mapping

List[RemotePathMappingResource] list_remote_path_mapping()

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.models.remote_path_mapping_resource import RemotePathMappingResource
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# 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.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.RemotePathMappingApi(api_client)

    try:
        api_response = api_instance.list_remote_path_mapping()
        print("The response of RemotePathMappingApi->list_remote_path_mapping:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotePathMappingApi->list_remote_path_mapping: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[RemotePathMappingResource]

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

update_remote_path_mapping

RemotePathMappingResource update_remote_path_mapping(id, remote_path_mapping_resource=remote_path_mapping_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.models.remote_path_mapping_resource import RemotePathMappingResource
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# 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.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.RemotePathMappingApi(api_client)
    id = 'id_example' # str | 
    remote_path_mapping_resource = readarr.RemotePathMappingResource() # RemotePathMappingResource |  (optional)

    try:
        api_response = api_instance.update_remote_path_mapping(id, remote_path_mapping_resource=remote_path_mapping_resource)
        print("The response of RemotePathMappingApi->update_remote_path_mapping:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotePathMappingApi->update_remote_path_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
remote_path_mapping_resource	RemotePathMappingResource		[optional]

Return type

RemotePathMappingResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

Files

RemotePathMappingApi.md

Latest commit

History

RemotePathMappingApi.md

File metadata and controls

readarr.RemotePathMappingApi

create_remote_path_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_remote_path_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_remote_path_mapping_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_remote_path_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_remote_path_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details