\ApplicationAPI

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

Method	HTTP request	Description
CreateApplications	Post /api/v1/applications
CreateApplicationsActionByName	Post /api/v1/applications/action/{name}
DeleteApplications	Delete /api/v1/applications/{id}
DeleteApplicationsBulk	Delete /api/v1/applications/bulk
GetApplicationsById	Get /api/v1/applications/{id}
ListApplications	Get /api/v1/applications
ListApplicationsSchema	Get /api/v1/applications/schema
PutApplicationsBulk	Put /api/v1/applications/bulk
TestApplications	Post /api/v1/applications/test
TestallApplications	Post /api/v1/applications/testall
UpdateApplications	Put /api/v1/applications/{id}

CreateApplications

ApplicationResource CreateApplications(ctx).ForceSave(forceSave).ApplicationResource(applicationResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	forceSave := true // bool |  (optional) (default to false)
	applicationResource := *prowlarrClient.NewApplicationResource() // ApplicationResource |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
forceSave	bool		[default to false]
applicationResource	ApplicationResource

Return type

ApplicationResource

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]

CreateApplicationsActionByName

CreateApplicationsActionByName(ctx, name).ApplicationResource(applicationResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	name := "name_example" // string | 
	applicationResource := *prowlarrClient.NewApplicationResource() // ApplicationResource |  (optional)

	configuration := prowlarrClient.NewConfiguration()
	apiClient := prowlarrClient.NewAPIClient(configuration)
	r, err := apiClient.ApplicationAPI.CreateApplicationsActionByName(context.Background(), name).ApplicationResource(applicationResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.CreateApplicationsActionByName``: %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 apiCreateApplicationsActionByNameRequest struct via the builder pattern

Name	Type	Description	Notes

applicationResource | ApplicationResource | |

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]

DeleteApplications

DeleteApplications(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

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

	configuration := prowlarrClient.NewConfiguration()
	apiClient := prowlarrClient.NewAPIClient(configuration)
	r, err := apiClient.ApplicationAPI.DeleteApplications(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.DeleteApplications``: %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 apiDeleteApplicationsRequest 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]

DeleteApplicationsBulk

DeleteApplicationsBulk(ctx).ApplicationBulkResource(applicationBulkResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	applicationBulkResource := *prowlarrClient.NewApplicationBulkResource() // ApplicationBulkResource |  (optional)

	configuration := prowlarrClient.NewConfiguration()
	apiClient := prowlarrClient.NewAPIClient(configuration)
	r, err := apiClient.ApplicationAPI.DeleteApplicationsBulk(context.Background()).ApplicationBulkResource(applicationBulkResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.DeleteApplicationsBulk``: %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 apiDeleteApplicationsBulkRequest struct via the builder pattern

Name	Type	Description	Notes
applicationBulkResource	ApplicationBulkResource

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]

GetApplicationsById

ApplicationResource GetApplicationsById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

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

	configuration := prowlarrClient.NewConfiguration()
	apiClient := prowlarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationAPI.GetApplicationsById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.GetApplicationsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetApplicationsById`: ApplicationResource
	fmt.Fprintf(os.Stdout, "Response from `ApplicationAPI.GetApplicationsById`: %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 apiGetApplicationsByIdRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ApplicationResource

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]

ListApplications

[]ApplicationResource ListApplications(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]ApplicationResource

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]

ListApplicationsSchema

[]ApplicationResource ListApplicationsSchema(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]ApplicationResource

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]

PutApplicationsBulk

ApplicationResource PutApplicationsBulk(ctx).ApplicationBulkResource(applicationBulkResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	applicationBulkResource := *prowlarrClient.NewApplicationBulkResource() // ApplicationBulkResource |  (optional)

	configuration := prowlarrClient.NewConfiguration()
	apiClient := prowlarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationAPI.PutApplicationsBulk(context.Background()).ApplicationBulkResource(applicationBulkResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.PutApplicationsBulk``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutApplicationsBulk`: ApplicationResource
	fmt.Fprintf(os.Stdout, "Response from `ApplicationAPI.PutApplicationsBulk`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
applicationBulkResource	ApplicationBulkResource

Return type

ApplicationResource

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]

TestApplications

TestApplications(ctx).ForceTest(forceTest).ApplicationResource(applicationResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	forceTest := true // bool |  (optional) (default to false)
	applicationResource := *prowlarrClient.NewApplicationResource() // ApplicationResource |  (optional)

	configuration := prowlarrClient.NewConfiguration()
	apiClient := prowlarrClient.NewAPIClient(configuration)
	r, err := apiClient.ApplicationAPI.TestApplications(context.Background()).ForceTest(forceTest).ApplicationResource(applicationResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.TestApplications``: %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 apiTestApplicationsRequest struct via the builder pattern

Name	Type	Description	Notes
forceTest	bool		[default to false]
applicationResource	ApplicationResource

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]

TestallApplications

TestallApplications(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {

	configuration := prowlarrClient.NewConfiguration()
	apiClient := prowlarrClient.NewAPIClient(configuration)
	r, err := apiClient.ApplicationAPI.TestallApplications(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.TestallApplications``: %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 apiTestallApplicationsRequest 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]

UpdateApplications

ApplicationResource UpdateApplications(ctx, id).ForceSave(forceSave).ApplicationResource(applicationResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	id := "id_example" // string | 
	forceSave := true // bool |  (optional) (default to false)
	applicationResource := *prowlarrClient.NewApplicationResource() // ApplicationResource |  (optional)

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

ApplicationResource

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]

FilesExpand file tree

ApplicationAPI.md

Latest commit

History

ApplicationAPI.md

File metadata and controls

\ApplicationAPI

CreateApplications

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateApplicationsActionByName

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteApplications

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteApplicationsBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetApplicationsById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListApplications

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListApplicationsSchema

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PutApplicationsBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

TestApplications

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

TestallApplications

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateApplications

Example

Path Parameters