Skip to content

SearchApi.md

Latest commit

 

History

History
264 lines (182 loc) · 8.49 KB

SearchApi.md

File metadata and controls

264 lines (182 loc) · 8.49 KB
Raw

prowlarr.SearchApi

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

Method HTTP request Description
create_search POST /api/v1/search
create_search_bulk POST /api/v1/search/bulk
list_search GET /api/v1/search

create_search

ReleaseResource create_search(release_resource=release_resource)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import prowlarr
from prowlarr.models.release_resource import ReleaseResource
from prowlarr.rest import ApiException
from pprint import pprint

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

# 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 prowlarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = prowlarr.SearchApi(api_client)
    release_resource = prowlarr.ReleaseResource() # ReleaseResource |  (optional)

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

Parameters

Name Type Description Notes
release_resource ReleaseResource [optional]

Return type

ReleaseResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json
  • 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]

create_search_bulk

ReleaseResource create_search_bulk(release_resource=release_resource)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import prowlarr
from prowlarr.models.release_resource import ReleaseResource
from prowlarr.rest import ApiException
from pprint import pprint

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

# 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 prowlarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = prowlarr.SearchApi(api_client)
    release_resource = [prowlarr.ReleaseResource()] # List[ReleaseResource] |  (optional)

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

Parameters

Name Type Description Notes
release_resource List[ReleaseResource] [optional]

Return type

ReleaseResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json
  • 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_search

List[ReleaseResource] list_search(query=query, type=type, indexer_ids=indexer_ids, categories=categories, limit=limit, offset=offset)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import prowlarr
from prowlarr.models.release_resource import ReleaseResource
from prowlarr.rest import ApiException
from pprint import pprint

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

# 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 prowlarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = prowlarr.SearchApi(api_client)
    query = 'query_example' # str |  (optional)
    type = 'type_example' # str |  (optional)
    indexer_ids = [56] # List[int] |  (optional)
    categories = [56] # List[int] |  (optional)
    limit = 56 # int |  (optional)
    offset = 56 # int |  (optional)

    try:
        api_response = api_instance.list_search(query=query, type=type, indexer_ids=indexer_ids, categories=categories, limit=limit, offset=offset)
        print("The response of SearchApi->list_search:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SearchApi->list_search: %s\n" % e)

Parameters

Name Type Description Notes
query str [optional]
type str [optional]
indexer_ids List[int] [optional]
categories List[int] [optional]
limit int [optional]
offset int [optional]

Return type

List[ReleaseResource]

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]