readarr.MetadataProfileApi

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

Method	HTTP request	Description
create_metadata_profile	POST /api/v1/metadataprofile
delete_metadata_profile	DELETE /api/v1/metadataprofile/{id}
get_metadata_profile_by_id	GET /api/v1/metadataprofile/{id}
list_metadata_profile	GET /api/v1/metadataprofile
update_metadata_profile	PUT /api/v1/metadataprofile/{id}

create_metadata_profile

MetadataProfileResource create_metadata_profile(metadata_profile_resource=metadata_profile_resource)

Example

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

import readarr
from readarr.models.metadata_profile_resource import MetadataProfileResource
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.MetadataProfileApi(api_client)
    metadata_profile_resource = readarr.MetadataProfileResource() # MetadataProfileResource |  (optional)

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

Parameters

Name	Type	Description	Notes
metadata_profile_resource	MetadataProfileResource		[optional]

Return type

MetadataProfileResource

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_metadata_profile

delete_metadata_profile(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.MetadataProfileApi(api_client)
    id = 56 # int | 

    try:
        api_instance.delete_metadata_profile(id)
    except Exception as e:
        print("Exception when calling MetadataProfileApi->delete_metadata_profile: %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_metadata_profile_by_id

MetadataProfileResource get_metadata_profile_by_id(id)

Example

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

import readarr
from readarr.models.metadata_profile_resource import MetadataProfileResource
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.MetadataProfileApi(api_client)
    id = 56 # int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

MetadataProfileResource

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_metadata_profile

List[MetadataProfileResource] list_metadata_profile()

Example

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

import readarr
from readarr.models.metadata_profile_resource import MetadataProfileResource
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.MetadataProfileApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[MetadataProfileResource]

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_metadata_profile

MetadataProfileResource update_metadata_profile(id, metadata_profile_resource=metadata_profile_resource)

Example

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

import readarr
from readarr.models.metadata_profile_resource import MetadataProfileResource
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.MetadataProfileApi(api_client)
    id = 'id_example' # str | 
    metadata_profile_resource = readarr.MetadataProfileResource() # MetadataProfileResource |  (optional)

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

Parameters

Name	Type	Description	Notes
id	str
metadata_profile_resource	MetadataProfileResource		[optional]

Return type

MetadataProfileResource

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

MetadataProfileApi.md

Latest commit

History

MetadataProfileApi.md

File metadata and controls

readarr.MetadataProfileApi

create_metadata_profile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_metadata_profile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_metadata_profile_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_metadata_profile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_metadata_profile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details