\IndexerAPI

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

Method	HTTP request	Description
CreateIndexer	Post /api/v3/indexer
CreateIndexerActionByName	Post /api/v3/indexer/action/{name}
DeleteIndexer	Delete /api/v3/indexer/{id}
DeleteIndexerBulk	Delete /api/v3/indexer/bulk
GetIndexerById	Get /api/v3/indexer/{id}
ListIndexer	Get /api/v3/indexer
ListIndexerSchema	Get /api/v3/indexer/schema
PutIndexerBulk	Put /api/v3/indexer/bulk
TestIndexer	Post /api/v3/indexer/test
TestallIndexer	Post /api/v3/indexer/testall
UpdateIndexer	Put /api/v3/indexer/{id}

CreateIndexer

IndexerResource CreateIndexer(ctx).ForceSave(forceSave).IndexerResource(indexerResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	forceSave := true // bool |  (optional) (default to false)
	indexerResource := *radarrClient.NewIndexerResource() // IndexerResource |  (optional)

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.IndexerAPI.CreateIndexer(context.Background()).ForceSave(forceSave).IndexerResource(indexerResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IndexerAPI.CreateIndexer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateIndexer`: IndexerResource
	fmt.Fprintf(os.Stdout, "Response from `IndexerAPI.CreateIndexer`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
forceSave	bool		[default to false]
indexerResource	IndexerResource

Return type

IndexerResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: application/json

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

CreateIndexerActionByName

CreateIndexerActionByName(ctx, name).IndexerResource(indexerResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	name := "name_example" // string | 
	indexerResource := *radarrClient.NewIndexerResource() // IndexerResource |  (optional)

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	r, err := apiClient.IndexerAPI.CreateIndexerActionByName(context.Background(), name).IndexerResource(indexerResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IndexerAPI.CreateIndexerActionByName``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string

Other Parameters

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

Name	Type	Description	Notes

indexerResource | IndexerResource | |

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

DeleteIndexer

DeleteIndexer(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	id := int32(56) // int32 | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

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

Name	Type	Description	Notes

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]

DeleteIndexerBulk

DeleteIndexerBulk(ctx).IndexerBulkResource(indexerBulkResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	indexerBulkResource := *radarrClient.NewIndexerBulkResource() // IndexerBulkResource |  (optional)

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	r, err := apiClient.IndexerAPI.DeleteIndexerBulk(context.Background()).IndexerBulkResource(indexerBulkResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IndexerAPI.DeleteIndexerBulk``: %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 apiDeleteIndexerBulkRequest struct via the builder pattern

Name	Type	Description	Notes
indexerBulkResource	IndexerBulkResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

GetIndexerById

IndexerResource GetIndexerById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	id := int32(56) // int32 | 

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.IndexerAPI.GetIndexerById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IndexerAPI.GetIndexerById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetIndexerById`: IndexerResource
	fmt.Fprintf(os.Stdout, "Response from `IndexerAPI.GetIndexerById`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

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

Name	Type	Description	Notes

Return type

IndexerResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

ListIndexer

[]IndexerResource ListIndexer(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.IndexerAPI.ListIndexer(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IndexerAPI.ListIndexer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListIndexer`: []IndexerResource
	fmt.Fprintf(os.Stdout, "Response from `IndexerAPI.ListIndexer`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]IndexerResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListIndexerSchema

[]IndexerResource ListIndexerSchema(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.IndexerAPI.ListIndexerSchema(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IndexerAPI.ListIndexerSchema``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListIndexerSchema`: []IndexerResource
	fmt.Fprintf(os.Stdout, "Response from `IndexerAPI.ListIndexerSchema`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]IndexerResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

PutIndexerBulk

IndexerResource PutIndexerBulk(ctx).IndexerBulkResource(indexerBulkResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	indexerBulkResource := *radarrClient.NewIndexerBulkResource() // IndexerBulkResource |  (optional)

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.IndexerAPI.PutIndexerBulk(context.Background()).IndexerBulkResource(indexerBulkResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IndexerAPI.PutIndexerBulk``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutIndexerBulk`: IndexerResource
	fmt.Fprintf(os.Stdout, "Response from `IndexerAPI.PutIndexerBulk`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
indexerBulkResource	IndexerBulkResource

Return type

IndexerResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: application/json

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

TestIndexer

TestIndexer(ctx).ForceTest(forceTest).IndexerResource(indexerResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	forceTest := true // bool |  (optional) (default to false)
	indexerResource := *radarrClient.NewIndexerResource() // IndexerResource |  (optional)

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	r, err := apiClient.IndexerAPI.TestIndexer(context.Background()).ForceTest(forceTest).IndexerResource(indexerResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IndexerAPI.TestIndexer``: %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 apiTestIndexerRequest struct via the builder pattern

Name	Type	Description	Notes
forceTest	bool		[default to false]
indexerResource	IndexerResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

TestallIndexer

TestallIndexer(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

UpdateIndexer

IndexerResource UpdateIndexer(ctx, id).ForceSave(forceSave).IndexerResource(indexerResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	id := int32(56) // int32 | 
	forceSave := true // bool |  (optional) (default to false)
	indexerResource := *radarrClient.NewIndexerResource() // IndexerResource |  (optional)

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.IndexerAPI.UpdateIndexer(context.Background(), id).ForceSave(forceSave).IndexerResource(indexerResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IndexerAPI.UpdateIndexer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateIndexer`: IndexerResource
	fmt.Fprintf(os.Stdout, "Response from `IndexerAPI.UpdateIndexer`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

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

Name	Type	Description	Notes

Return type

IndexerResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

IndexerAPI.md

Latest commit

History

IndexerAPI.md

File metadata and controls

\IndexerAPI

CreateIndexer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateIndexerActionByName

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteIndexer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteIndexerBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetIndexerById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListIndexer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListIndexerSchema

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PutIndexerBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

TestIndexer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

TestallIndexer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateIndexer

Example

Path Parameters