Skip to content

BookshelfApi.md

Latest commit

 

History

History
88 lines (58 loc) · 2.7 KB

BookshelfApi.md

File metadata and controls

88 lines (58 loc) · 2.7 KB
Raw

readarr.BookshelfApi

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

Method HTTP request Description
create_bookshelf POST /api/v1/bookshelf

create_bookshelf

create_bookshelf(bookshelf_resource=bookshelf_resource)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import readarr
from readarr.models.bookshelf_resource import BookshelfResource
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.BookshelfApi(api_client)
    bookshelf_resource = readarr.BookshelfResource() # BookshelfResource |  (optional)

    try:
        api_instance.create_bookshelf(bookshelf_resource=bookshelf_resource)
    except Exception as e:
        print("Exception when calling BookshelfApi->create_bookshelf: %s\n" % e)

Parameters

Name Type Description Notes
bookshelf_resource BookshelfResource [optional]

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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