FileSystemAPI.md

\FileSystemAPI

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

Method	HTTP request	Description
GetFileSystem	Get /api/v1/filesystem
GetFileSystemMediafiles	Get /api/v1/filesystem/mediafiles
GetFileSystemType	Get /api/v1/filesystem/type

GetFileSystem

GetFileSystem(ctx).Path(path).IncludeFiles(includeFiles).AllowFoldersWithoutTrailingSlashes(allowFoldersWithoutTrailingSlashes).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	path := "path_example" // string |  (optional)
	includeFiles := true // bool |  (optional) (default to false)
	allowFoldersWithoutTrailingSlashes := true // bool |  (optional) (default to false)

	configuration := readarrClient.NewConfiguration()
	apiClient := readarrClient.NewAPIClient(configuration)
	r, err := apiClient.FileSystemAPI.GetFileSystem(context.Background()).Path(path).IncludeFiles(includeFiles).AllowFoldersWithoutTrailingSlashes(allowFoldersWithoutTrailingSlashes).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FileSystemAPI.GetFileSystem``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetFileSystemRequest struct via the builder pattern

Name	Type	Description	Notes
path	string
includeFiles	bool		[default to false]
allowFoldersWithoutTrailingSlashes	bool		[default to false]

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

GetFileSystemMediafiles

GetFileSystemMediafiles(ctx).Path(path).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	path := "path_example" // string |  (optional)

	configuration := readarrClient.NewConfiguration()
	apiClient := readarrClient.NewAPIClient(configuration)
	r, err := apiClient.FileSystemAPI.GetFileSystemMediafiles(context.Background()).Path(path).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FileSystemAPI.GetFileSystemMediafiles``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetFileSystemMediafilesRequest struct via the builder pattern

Name	Type	Description	Notes
path	string

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

GetFileSystemType

GetFileSystemType(ctx).Path(path).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	path := "path_example" // string |  (optional)

	configuration := readarrClient.NewConfiguration()
	apiClient := readarrClient.NewAPIClient(configuration)
	r, err := apiClient.FileSystemAPI.GetFileSystemType(context.Background()).Path(path).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FileSystemAPI.GetFileSystemType``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetFileSystemTypeRequest struct via the builder pattern

Name	Type	Description	Notes
path	string

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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