gronod/ombi-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
m7-admin-wire-contracts
ombi-mcp/docs/api/raml/api.raml
T
gronod 722108ebd0 Initial commit: Ombi MCP server design docs and Go skeleton 
Schema docs (docs/schema) cover tool mapping, input/output contracts and
endpoint coverage for all 31 MCP tools; megaplan M1 phases 01-03 applied
(namespace rename to read_*/write_*, input schema rectification).
Go module provides config loading, Ombi client, and tool registry
skeleton for implementation.
2026-09-18 15:55:44 +01:00

6653 lines
204 KiB
Plaintext
Raw Permalink Blame History

#%RAML 1.0
title: Ombi Api V1
version: v1
baseUri: https://ombi.i3omb.com
mediaType: application/json
securitySchemes:
ApiKeyAuth: !include securitySchemes/api_key.raml
securedBy:
- ApiKeyAuth
/api/v2/Calendar:
get:
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.V2.CalendarViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.V2.CalendarViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.V2.CalendarViewModel.raml
/api/v1/CouchPotato/profile:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Api.External.ExternalApis.CouchPotato.Models.CouchPotatoProfiles.raml
/api/v1/CouchPotato/apikey:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Api.External.ExternalApis.CouchPotato.Models.CouchPotatoApiKey.raml
/api/v1/CustomPage:
get:
description: |
Gets the Custom Page Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.CustomPageSettings.raml
post:
description: |
Saves the Custom Page Settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.CustomPageSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.CustomPageSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.CustomPageSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.CustomPageSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Emby:
post:
description: |
Signs into the Emby Api
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.EmbySettings.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbySettings.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbySettings.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.EmbySettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbySettings.raml
/api/v1/Emby/info:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Api.External.MediaServers.Emby.Models.PublicInfo.raml
/api/v1/Emby/users:
get:
description: |
Gets the emby users.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Models.External.UsersViewModel.raml
/api/v1/Emby/Library:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Api.External.MediaServers.Emby.Models.EmbyItemContainer_1__Ombi.Api.External.MediaServers.Emby.Models.Media.MediaFolders__Ombi.Api.External__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Features:
get:
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
application/json:
type: array
items: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
text/json:
type: array
items: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
/api/v2/Features/enable:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
application/json:
type: array
items: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
text/json:
type: array
items: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
/api/v2/Features/disable:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
application/json:
type: array
items: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
text/json:
type: array
items: !include types/Ombi.Settings.Settings.Models.FeatureEnablement.raml
/api/v2/Hub/Users:
get:
description: |
Returns the currently connected users in Ombi
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Models.ConnectedUsersViewModel.raml
application/json:
type: array
items: !include types/Ombi.Models.ConnectedUsersViewModel.raml
text/json:
type: array
items: !include types/Ombi.Models.ConnectedUsersViewModel.raml
/api/v1/Identity/Users:
get:
description: |
Gets all users.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.UI.UserViewModel.raml
/api/v1/Identity/dropdown/Users:
get:
description: |
Gets all users for dropdown purposes.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.UI.UserViewModelDropdown.raml
/api/v1/Identity:
get:
description: |
Gets the current logged in user.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
post:
description: |
Creates the user.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.Identity.IdentityResult.raml
put:
description: |
Updates the user.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.Identity.IdentityResult.raml
/api/v1/Identity/language:
post:
description: |
Sets the current users language
body:
application/json-patch+json:
type: !include types/Ombi.Models.Identity.UserLanguage.raml
application/json:
type: !include types/Ombi.Models.Identity.UserLanguage.raml
text/json:
type: !include types/Ombi.Models.Identity.UserLanguage.raml
application/*+json:
type: !include types/Ombi.Models.Identity.UserLanguage.raml
responses:
200:
description: |
Success
/api/v1/Identity/streamingcountry:
get:
description: |
Returns the supported country codes that we have streaming data for
responses:
200:
description: |
Success
post:
description: |
Sets the current users country streaming preference
body:
application/json-patch+json:
type: !include types/Ombi.Models.Identity.CountryStreamingPreference.raml
application/json:
type: !include types/Ombi.Models.Identity.CountryStreamingPreference.raml
text/json:
type: !include types/Ombi.Models.Identity.CountryStreamingPreference.raml
application/*+json:
type: !include types/Ombi.Models.Identity.CountryStreamingPreference.raml
responses:
200:
description: |
Success
/api/v1/Identity/User/{id}:
get:
description: |
Gets the user by the user id.
uriParameters:
id:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
/api/v1/Identity/local:
put:
description: |
This is for the local user to change their details.
body:
application/json-patch+json:
type: !include types/Ombi.Models.Identity.UpdateLocalUserModel.raml
application/json:
type: !include types/Ombi.Models.Identity.UpdateLocalUserModel.raml
text/json:
type: !include types/Ombi.Models.Identity.UpdateLocalUserModel.raml
application/*+json:
type: !include types/Ombi.Models.Identity.UpdateLocalUserModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.Identity.IdentityResult.raml
/api/v1/Identity/{userId}:
delete:
description: |
Deletes the user.
uriParameters:
userId:
description: |
The user. type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.Identity.IdentityResult.raml
/api/v1/Identity/claims:
get:
description: |
Gets all available claims in the system.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.UI.ClaimCheckboxes.raml
/api/v1/Identity/welcomeEmail:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.UserViewModel.raml
responses:
200:
description: |
Success
/api/v1/Identity/notificationpreferences:
get:
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.UserNotificationPreferences.raml
/api/v1/Identity/notificationpreferences/{userId}:
get:
uriParameters:
userId:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.UserNotificationPreferences.raml
/api/v1/Identity/NotificationPreferences:
post:
body:
application/json-patch+json:
type: array
items: !include types/Ombi.Models.Identity.AddNotificationPreference.raml
application/json:
type: array
items: !include types/Ombi.Models.Identity.AddNotificationPreference.raml
text/json:
type: array
items: !include types/Ombi.Models.Identity.AddNotificationPreference.raml
application/*+json:
type: array
items: !include types/Ombi.Models.Identity.AddNotificationPreference.raml
responses:
404:
description: |
Not Found
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
401:
description: |
Unauthorized
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Identity/newsletter/unsubscribe/{userId}:
get:
uriParameters:
userId:
type: string
required: true
responses:
200:
description: |
Success
/api/v1/Images/tv/{tvdbid}:
get:
uriParameters:
tvdbid:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Images/poster:
get:
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Images/poster/movie/{movieDbId}:
get:
uriParameters:
movieDbId:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Images/poster/tv/{tvdbid}:
get:
uriParameters:
tvdbid:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Images/poster/tv/tmdb/{tmdbId}:
get:
uriParameters:
tmdbId:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Images/background/movie/{movieDbId}:
get:
uriParameters:
movieDbId:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Images/banner/movie/{movieDbId}:
get:
uriParameters:
movieDbId:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Images/background/tv/{tvdbid}:
get:
uriParameters:
tvdbid:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Images/background/tv/tmdb/{id}:
get:
uriParameters:
id:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Images/background:
get:
responses:
200:
description: |
Success
/api/v1/Images/background/info:
get:
responses:
200:
description: |
Success
/api/v2/Issues/{position}/{take}/{status}:
get:
uriParameters:
position:
type: integer
required: true
take:
type: integer
required: true
status:
type: !include types/Ombi.Store.Entities.Requests.IssueStatus.raml
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Engine.V2.IssuesSummaryModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Engine.V2.IssuesSummaryModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Engine.V2.IssuesSummaryModel.raml
/api/v2/Issues/details/{providerId}:
get:
uriParameters:
providerId:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Engine.V2.IssuesSummaryModel.raml
application/json:
type: !include types/Ombi.Core.Engine.V2.IssuesSummaryModel.raml
text/json:
type: !include types/Ombi.Core.Engine.V2.IssuesSummaryModel.raml
/api/v1/Issues/categories:
get:
description: |
Get's all categories
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.IssueCategory.raml
post:
description: |
Creates a new category
body:
application/json-patch+json:
type: !include types/Ombi.Store.Entities.Requests.IssueCategory.raml
application/json:
type: !include types/Ombi.Store.Entities.Requests.IssueCategory.raml
text/json:
type: !include types/Ombi.Store.Entities.Requests.IssueCategory.raml
application/*+json:
type: !include types/Ombi.Store.Entities.Requests.IssueCategory.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Issues/categories/{catId}:
delete:
description: |
Deletes a Category
uriParameters:
catId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Issues:
get:
description: |
Returns all the issues
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.Issues.raml
post:
description: |
Create Movie Issue
body:
application/json-patch+json:
type: !include types/Ombi.Store.Entities.Requests.Issues.raml
application/json:
type: !include types/Ombi.Store.Entities.Requests.Issues.raml
text/json:
type: !include types/Ombi.Store.Entities.Requests.Issues.raml
application/*+json:
type: !include types/Ombi.Store.Entities.Requests.Issues.raml
responses:
200:
description: |
Success
body:
application/json:
type: integer
/api/v1/Issues/{take}/{skip}/{status}:
get:
description: |
Returns all the issues
uriParameters:
take:
type: integer
required: true
skip:
type: integer
required: true
status:
type: !include types/Ombi.Store.Entities.Requests.IssueStatus.raml
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.Issues.raml
/api/v1/Issues/count:
get:
description: |
Returns all the issues count
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.IssueCountModel.raml
/api/v1/Issues/{id}:
get:
description: |
Returns the issue by Id
uriParameters:
id:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Store.Entities.Requests.Issues.raml
delete:
uriParameters:
id:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Issues/request/{id}:
get:
uriParameters:
id:
type: integer
required: true
responses:
200:
description: |
Success
/api/v1/Issues/provider/{id}:
get:
uriParameters:
id:
type: string
required: true
responses:
200:
description: |
Success
/api/v1/Issues/{id}/comments:
get:
description: |
Get's all the issue comments by id
uriParameters:
id:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Models.IssueCommentChatViewModel.raml
/api/v1/Issues/comments:
post:
description: |
Adds a comment on an issue
body:
application/json-patch+json:
type: !include types/Ombi.Models.NewIssueCommentViewModel.raml
application/json:
type: !include types/Ombi.Models.NewIssueCommentViewModel.raml
text/json:
type: !include types/Ombi.Models.NewIssueCommentViewModel.raml
application/*+json:
type: !include types/Ombi.Models.NewIssueCommentViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Store.Entities.Requests.IssueComments.raml
/api/v1/Issues/comments/{id}:
delete:
description: |
Deletes a comment on a issue
uriParameters:
id:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Issues/status:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Models.IssueStateViewModel.raml
application/json:
type: !include types/Ombi.Models.IssueStateViewModel.raml
text/json:
type: !include types/Ombi.Models.IssueStateViewModel.raml
application/*+json:
type: !include types/Ombi.Models.IssueStateViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Jellyfin:
post:
description: |
Signs into the Jellyfin Api
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinSettings.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinSettings.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinSettings.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinSettings.raml
/api/v1/Jellyfin/info:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Api.External.MediaServers.Jellyfin.Models.PublicInfo.raml
/api/v1/Jellyfin/Library:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Api.External.MediaServers.Jellyfin.Models.JellyfinItemContainer_1__Ombi.Api.External.MediaServers.Jellyfin.Models.MediaFolders__Ombi.Api.External__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v1/Jellyfin/users:
get:
description: |
Gets the jellyfin users.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Models.External.UsersViewModel.raml
/api/v1/Job/update:
post:
description: |
Runs the update job
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Checks for an update
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/plexuserimporter:
post:
description: |
Runs the Plex User importer
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/plexwatchlist:
post:
description: |
Runs the Plex Watchlist Importer
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/embyuserimporter:
post:
description: |
Runs the Emby User importer
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/jellyfinuserimporter:
post:
description: |
Runs the Jellyfin User importer
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/plexcontentcacher:
post:
description: |
Runs the Plex Content Cacher
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/clearmediaserverdata:
post:
description: |
Clear out the media server and resync
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/plexrecentlyadded:
post:
description: |
Runs a smaller version of the content cacher
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/embycontentcacher:
post:
description: |
Runs the Emby Content Cacher
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/embyrecentlyadded:
post:
description: |
Runs a smaller version of the content cacher
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/jellyfincontentcacher:
post:
description: |
Runs the Jellyfin Content Cacher
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/arrAvailability:
post:
description: |
Runs the Arr Availability Checker
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/autodeleterequests:
post:
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Job/newsletter:
post:
description: |
Runs the newsletter
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/LandingPage:
get:
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.MediaSeverAvailibilityViewModel.raml
/api/v1/Lidarr/enabled:
get:
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Lidarr/Profiles:
post:
description: |
Gets the Lidarr profiles.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Lidarr.Models.LidarrProfile.raml
get:
description: |
Gets the Lidarr profiles using the saved settings
<remarks>The data is cached for an hour</remarks>
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Lidarr.Models.LidarrProfile.raml
/api/v1/Lidarr/RootFolders:
post:
description: |
Gets the Lidarr root folders.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Lidarr.Models.LidarrRootFolder.raml
get:
description: |
Gets the Lidarr root folders using the saved settings.
<remarks>The data is cached for an hour</remarks>
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Lidarr.Models.LidarrRootFolder.raml
/api/v1/Lidarr/Metadata:
post:
description: |
Gets the Lidarr metadata profiles.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Lidarr.Models.MetadataProfile.raml
/api/v1/Logging:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Models.UiLoggingModel.raml
application/json:
type: !include types/Ombi.Models.UiLoggingModel.raml
text/json:
type: !include types/Ombi.Models.UiLoggingModel.raml
application/*+json:
type: !include types/Ombi.Models.UiLoggingModel.raml
responses:
200:
description: |
Success
/api/v1/request/music/{count}/{position}/{orderType}/{statusType}/{availabilityType}:
get:
description: |
Gets album requests.
uriParameters:
count:
description: |
The count of items you want to return. type: integer
required: true
position:
description: |
The position. type: integer
required: true
orderType:
description: |
The way we want to order. type: integer
required: true
statusType:
type: integer
required: true
availabilityType:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v1/request/music/total:
get:
description: |
Gets the total amount of album requests.
responses:
200:
description: |
Success
body:
application/json:
type: integer
/api/v1/request/music:
get:
description: |
Gets all album requests.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.AlbumRequest.raml
post:
description: |
Requests a album.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.MusicAlbumRequestViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.MusicAlbumRequestViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.MusicAlbumRequestViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.MusicAlbumRequestViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/request/music/search/{searchTerm}:
get:
description: |
Searches for a specific album request
uriParameters:
searchTerm:
description: |
The search term. type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.AlbumRequest.raml
/api/v1/request/music/{requestId}:
delete:
description: |
Deletes the specified album request.
uriParameters:
requestId:
description: |
The request identifier. type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/request/music/approve:
post:
description: |
Approves the specified album request.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/request/music/available:
post:
description: |
Set's the specified album as available
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/request/music/unavailable:
post:
description: |
Set's the specified album as unavailable
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.AlbumUpdateModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/request/music/deny:
put:
description: |
Denies the specified album request.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.DenyAlbumModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.DenyAlbumModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.DenyAlbumModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.DenyAlbumModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/request/music/remaining:
get:
description: |
Gets model containing remaining number of music requests.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.RequestQuotaCountModel.raml
/api/v1/Notifications/massemail:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.MassEmailModel.raml
application/json:
type: !include types/Ombi.Core.Models.MassEmailModel.raml
text/json:
type: !include types/Ombi.Core.Models.MassEmailModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.MassEmailModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Plex:
post:
description: |
Signs into the Plex API.
body:
application/json-patch+json:
type: !include types/Ombi.Api.External.MediaServers.Plex.Models.UserRequest.raml
application/json:
type: !include types/Ombi.Api.External.MediaServers.Plex.Models.UserRequest.raml
text/json:
type: !include types/Ombi.Api.External.MediaServers.Plex.Models.UserRequest.raml
application/*+json:
type: !include types/Ombi.Api.External.MediaServers.Plex.Models.UserRequest.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Api.External.MediaServers.Plex.Models.PlexAuthentication.raml
/api/v1/Plex/Libraries:
post:
description: |
Gets the plex libraries.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.PlexServers.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.PlexServers.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.PlexServers.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.PlexServers.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.External.PlexLibrariesResponse.raml
/api/v1/Plex/Libraries/{machineId}:
get:
uriParameters:
machineId:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.External.PlexLibrariesLiteResponse.raml
/api/v1/Plex/user:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Models.External.PlexUserViewModel.raml
application/json:
type: !include types/Ombi.Models.External.PlexUserViewModel.raml
text/json:
type: !include types/Ombi.Models.External.PlexUserViewModel.raml
application/*+json:
type: !include types/Ombi.Models.External.PlexUserViewModel.raml
responses:
200:
description: |
Success
/api/v1/Plex/servers:
get:
description: |
Gets the plex servers.
responses:
200:
description: |
Success
post:
description: |
Gets the plex servers.
body:
application/json-patch+json:
type: !include types/Ombi.Api.External.MediaServers.Plex.Models.UserRequest.raml
application/json:
type: !include types/Ombi.Api.External.MediaServers.Plex.Models.UserRequest.raml
text/json:
type: !include types/Ombi.Api.External.MediaServers.Plex.Models.UserRequest.raml
application/*+json:
type: !include types/Ombi.Api.External.MediaServers.Plex.Models.UserRequest.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.External.PlexServersViewModel.raml
/api/v1/Plex/friends:
get:
description: |
Gets the plex friends.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Models.External.UsersViewModel.raml
/api/v1/Plex/oauth:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Models.PlexOAuthViewModel.raml
application/json:
type: !include types/Ombi.Models.PlexOAuthViewModel.raml
text/json:
type: !include types/Ombi.Models.PlexOAuthViewModel.raml
application/*+json:
type: !include types/Ombi.Models.PlexOAuthViewModel.raml
responses:
200:
description: |
Success
/api/v1/Plex/WatchlistUsers:
get:
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.PlexUserWatchlistModel.raml
/api/v1/Plex/WatchlistUsers/revalidate:
post:
responses:
200:
description: |
Success
/api/v1/Radarr/Profiles:
post:
description: |
Gets the Radarr profiles.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
responses:
200:
description: |
Success
get:
description: |
Gets the Radarr profiles using the saved settings
<remarks>The data is cached for an hour</remarks>
responses:
200:
description: |
Success
/api/v1/Radarr/enabled:
get:
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Radarr/RootFolders:
post:
description: |
Gets the Radarr root folders.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Radarr.Models.RadarrRootFolder.raml
get:
description: |
Gets the Radarr root folders using the saved settings.
<remarks>The data is cached for an hour</remarks>
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Radarr.Models.RadarrRootFolder.raml
/api/v1/Radarr/Profiles/4k:
get:
description: |
Gets the Radarr 4K profiles using the saved settings
<remarks>The data is cached for an hour</remarks>
responses:
200:
description: |
Success
/api/v1/Radarr/RootFolders/4k:
get:
description: |
Gets the Radarr 4K root folders using the saved settings.
<remarks>The data is cached for an hour</remarks>
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Radarr.Models.RadarrRootFolder.raml
/api/v1/Radarr/tags:
post:
description: |
Gets the Radarr tags
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Radarr.Models.Tag.raml
get:
description: |
Gets the Radarr tags
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Radarr.Models.Tag.raml
/api/v1/RecentlyAdded/movies:
get:
description: |
Returns the recently added movies for the past 7 days
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.RecentlyAddedMovieModel.raml
/api/v1/RecentlyAdded/tv:
get:
description: |
Returns the recently added tv shows for the past 7 days
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.RecentlyAddedMovieModel.raml
/api/v1/RecentlyAdded/tv/grouped:
get:
description: |
Returns the recently added tv shows for the past 7 days and groups them by season
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.RecentlyAddedMovieModel.raml
/api/v1/Request/movie/{count}/{position}/{orderType}/{statusType}/{availabilityType}:
get:
description: |
Gets movie requests.
uriParameters:
count:
description: |
The count of items you want to return. type: integer
required: true
position:
description: |
The position. type: integer
required: true
orderType:
description: |
The way we want to order. type: integer
required: true
statusType:
type: integer
required: true
availabilityType:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v1/Request/movie/info/{requestId}:
get:
description: |
Returns information about the Single Movie Request
uriParameters:
requestId:
description: |
the movie request id type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Store.Entities.Requests.MovieRequests.raml
/api/v1/Request/movie/total:
get:
description: |
Gets the total amount of movie requests.
responses:
200:
description: |
Success
body:
application/json:
type: integer
/api/v1/Request/movie:
get:
description: |
Gets all movie requests.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.MovieRequests.raml
post:
description: |
Requests a movie.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.MovieRequestViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.MovieRequestViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.MovieRequestViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.MovieRequestViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
put:
description: |
Updates the specified movie request.
body:
application/json-patch+json:
type: !include types/Ombi.Store.Entities.Requests.MovieRequests.raml
application/json:
type: !include types/Ombi.Store.Entities.Requests.MovieRequests.raml
text/json:
type: !include types/Ombi.Store.Entities.Requests.MovieRequests.raml
application/*+json:
type: !include types/Ombi.Store.Entities.Requests.MovieRequests.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Store.Entities.Requests.MovieRequests.raml
/api/v1/Request/movie/search/{searchTerm}:
get:
description: |
Searches for a specific movie request
uriParameters:
searchTerm:
description: |
The search term. type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.MovieRequests.raml
/api/v1/Request/movie/{requestId}:
delete:
description: |
Deletes the specified movie request.
uriParameters:
requestId:
description: |
The request identifier. type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/Request/movie/all:
delete:
description: |
Deletes the all movie request.
responses:
200:
description: |
Success
/api/v1/Request/movie/approve:
post:
description: |
Approves the specified movie request.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/Request/movie/available:
post:
description: |
Set's the specified Movie as available
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/Request/movie/unavailable:
post:
description: |
Set's the specified Movie as unavailable
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.MovieUpdateModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/Request/movie/deny:
put:
description: |
Denies the specified movie request.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.DenyMovieModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.DenyMovieModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.DenyMovieModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.DenyMovieModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/Request/tv/total:
get:
description: |
Gets the total amount of TV requests.
responses:
200:
description: |
Success
body:
application/json:
type: integer
/api/v1/Request/tv/{count}/{position}/{orderType}/{statusFilterType}/{availabilityFilterType}:
get:
description: |
Gets the tv requests.
uriParameters:
count:
description: |
The count of items you want to return. type: integer
required: true
position:
description: |
The position. type: integer
required: true
orderType:
type: integer
required: true
statusFilterType:
type: string
required: true
availabilityFilterType:
type: string
required: true
queryParameters:
statusType:
type: integer
required: false
availabilityType:
type: integer
required: false
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.TvRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v1/Request/tvlite/{count}/{position}/{orderType}/{statusFilterType}/{availabilityFilterType}:
get:
description: |
Gets the tv requests lite.
uriParameters:
count:
description: |
The count of items you want to return. type: integer
required: true
position:
description: |
The position. type: integer
required: true
orderType:
type: integer
required: true
statusFilterType:
type: string
required: true
availabilityFilterType:
type: string
required: true
queryParameters:
statusType:
type: integer
required: false
availabilityType:
type: integer
required: false
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.TvRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v1/Request/tv:
get:
description: |
Gets the tv requests.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.TvRequests.raml
post:
description: |
Requests a tv show/episode/season.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.TvRequestViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.TvRequestViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.TvRequestViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.TvRequestViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
put:
description: |
Updates the a specific tv request
body:
application/json-patch+json:
type: !include types/Ombi.Store.Entities.Requests.TvRequests.raml
application/json:
type: !include types/Ombi.Store.Entities.Requests.TvRequests.raml
text/json:
type: !include types/Ombi.Store.Entities.Requests.TvRequests.raml
application/*+json:
type: !include types/Ombi.Store.Entities.Requests.TvRequests.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Store.Entities.Requests.TvRequests.raml
/api/v1/Request/tvlite:
get:
description: |
Gets the tv requests without the whole object graph (Does not include seasons/episodes).
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.TvRequests.raml
/api/v1/Request/tv/{requestId}:
get:
description: |
Returns the full request object for the specified requestId
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Store.Entities.Requests.TvRequests.raml
delete:
description: |
Deletes the a specific tv request
uriParameters:
requestId:
description: |
The request identifier. type: integer
required: true
responses:
200:
description: |
Success
/api/v1/Request/tv/search/{searchTerm}:
get:
description: |
Searches for a specific tv request
uriParameters:
searchTerm:
description: |
The search term. type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.TvRequests.raml
/api/v1/Request/tv/root/{requestId}/{rootFolderId}:
put:
description: |
Updates the root path for this tv show
uriParameters:
requestId:
type: integer
required: true
rootFolderId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Request/tv/quality/{requestId}/{qualityId}:
put:
description: |
Updates the quality profile for this tv show
uriParameters:
requestId:
type: integer
required: true
qualityId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Request/tv/child:
put:
description: |
Updates the a specific child request
body:
application/json-patch+json:
type: !include types/Ombi.Store.Entities.Requests.ChildRequests.raml
application/json:
type: !include types/Ombi.Store.Entities.Requests.ChildRequests.raml
text/json:
type: !include types/Ombi.Store.Entities.Requests.ChildRequests.raml
application/*+json:
type: !include types/Ombi.Store.Entities.Requests.ChildRequests.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Store.Entities.Requests.ChildRequests.raml
/api/v1/Request/tv/deny:
put:
description: |
Denies the a specific child request
body:
application/json-patch+json:
type: !include types/Ombi.Models.DenyTvModel.raml
application/json:
type: !include types/Ombi.Models.DenyTvModel.raml
text/json:
type: !include types/Ombi.Models.DenyTvModel.raml
application/*+json:
type: !include types/Ombi.Models.DenyTvModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/Request/tv/available:
post:
description: |
Set's the specified tv child as available
body:
application/json-patch+json:
type: !include types/Ombi.Models.TvUpdateModel.raml
application/json:
type: !include types/Ombi.Models.TvUpdateModel.raml
text/json:
type: !include types/Ombi.Models.TvUpdateModel.raml
application/*+json:
type: !include types/Ombi.Models.TvUpdateModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/Request/tv/unavailable:
post:
description: |
Set's the specified tv child as unavailable
body:
application/json-patch+json:
type: !include types/Ombi.Models.TvUpdateModel.raml
application/json:
type: !include types/Ombi.Models.TvUpdateModel.raml
text/json:
type: !include types/Ombi.Models.TvUpdateModel.raml
application/*+json:
type: !include types/Ombi.Models.TvUpdateModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/Request/tv/approve:
post:
description: |
Updates the a specific child request
body:
application/json-patch+json:
type: !include types/Ombi.Models.TvUpdateModel.raml
application/json:
type: !include types/Ombi.Models.TvUpdateModel.raml
text/json:
type: !include types/Ombi.Models.TvUpdateModel.raml
application/*+json:
type: !include types/Ombi.Models.TvUpdateModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/Request/tv/child/{requestId}:
delete:
description: |
Deletes the a specific tv request
uriParameters:
requestId:
description: |
The model. type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v1/Request/tv/{requestId}/child:
get:
description: |
Retuns all children requests for the request id
uriParameters:
requestId:
description: |
The Request Id type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Requests.ChildRequests.raml
/api/v1/Request/count:
get:
description: |
Gets the count of total requests
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.Requests.RequestCountModel.raml
/api/v1/Request/userhasrequest:
get:
description: |
Checks if the passed in user has a request
queryParameters:
userId:
type: string
required: false
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Request/movie/subscribe/{requestId}:
post:
description: |
Subscribes for notifications to a movie request
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Request/tv/subscribe/{requestId}:
post:
description: |
Subscribes for notifications to a TV request
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Request/movie/unsubscribe/{requestId}:
post:
description: |
UnSubscribes for notifications to a movie request
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Request/tv/unsubscribe/{requestId}:
post:
description: |
UnSubscribes for notifications to a TV request
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Request/movie/remaining:
get:
description: |
Gets model containing remaining number of movie requests.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.RequestQuotaCountModel.raml
/api/v1/Request/tv/remaining:
get:
description: |
Gets model containing remaining number of tv requests.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.RequestQuotaCountModel.raml
/api/v1/RequestRetry:
get:
description: |
Get's all the failed requests that are currently in the queue
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Models.FailedRequestViewModel.raml
/api/v1/RequestRetry/{queueId}:
delete:
uriParameters:
queueId:
type: integer
required: true
responses:
200:
description: |
Success
/api/v2/Requests/movie/{count}/{position}/{sort}/{sortOrder}:
get:
description: |
Gets movie requests.
uriParameters:
count:
description: |
The count of items you want to return. e.g. 30 type: integer
required: true
position:
description: |
The position. e.g. position 60 for a 2nd page (since we have already got the first 30 items) type: integer
required: true
sort:
description: |
The item to sort on e.g. "requestDate" type: string
required: true
sortOrder:
description: |
asc or desc type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/movie/availble/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/movie/available/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/movie/processing/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/movie/pending/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/movie/denied/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/movie/unavailable/{count}/{position}/{sort}/{sortOrder}:
get:
description: |
Gets the unavailable movie requests.
uriParameters:
count:
description: |
The count of items you want to return. e.g. 30 type: integer
required: true
position:
description: |
The position. e.g. position 60 for a 2nd page (since we have already got the first 30 items) type: integer
required: true
sort:
description: |
The item to sort on e.g. "requestDate" type: string
required: true
sortOrder:
description: |
asc or desc type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.MovieRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/tv/{count}/{position}/{sort}/{sortOrder}:
get:
description: |
Gets Tv requests.
uriParameters:
count:
description: |
The count of items you want to return. e.g. 30 type: integer
required: true
position:
description: |
The position. e.g. position 60 for a 2nd page (since we have already got the first 30 items) type: integer
required: true
sort:
description: |
The item to sort on e.g. "requestDate" type: string
required: true
sortOrder:
description: |
asc or desc type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/tv/pending/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/tv/processing/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/tv/available/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/tv/denied/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/tv/unavailable/{count}/{position}/{sort}/{sortOrder}:
get:
description: |
Gets unavailable Tv requests.
uriParameters:
count:
description: |
The count of items you want to return. e.g. 30 type: integer
required: true
position:
description: |
The position. e.g. position 60 for a 2nd page (since we have already got the first 30 items) type: integer
required: true
sort:
description: |
The item to sort on e.g. "requestDate" type: string
required: true
sortOrder:
description: |
asc or desc type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.ChildRequests__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/movie/advancedoptions:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.MediaAdvancedOptions.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.MediaAdvancedOptions.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.MediaAdvancedOptions.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.MediaAdvancedOptions.raml
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
text/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v2/Requests/tv/advancedoptions:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.MediaAdvancedOptions.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.MediaAdvancedOptions.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.MediaAdvancedOptions.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.MediaAdvancedOptions.raml
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
text/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v2/Requests/album/available/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/album/processing/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/album/pending/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/album/denied/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/album/{count}/{position}/{sort}/{sortOrder}:
get:
uriParameters:
count:
type: integer
required: true
position:
type: integer
required: true
sort:
type: string
required: true
sortOrder:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
application/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
text/json:
type: !include types/Ombi.Core.Models.UI.RequestsViewModel_1__Ombi.Store.Entities.Requests.AlbumRequest__Ombi.Store__Version_3.0.0.0__Culture_neutral__PublicKeyToken_null__.raml
/api/v2/Requests/tv:
post:
description: |
Requests a tv show/episode/season.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Requests.TvRequestViewModelV2.raml
application/json:
type: !include types/Ombi.Core.Models.Requests.TvRequestViewModelV2.raml
text/json:
type: !include types/Ombi.Core.Models.Requests.TvRequestViewModelV2.raml
application/*+json:
type: !include types/Ombi.Core.Models.Requests.TvRequestViewModelV2.raml
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
text/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v2/Requests/reprocess/{type}/{requestId}/{is4K}:
post:
uriParameters:
type:
type: !include types/Ombi.Store.Entities.RequestType.raml
required: true
requestId:
type: integer
required: true
is4K:
type: boolean
required: true
responses:
200:
description: |
Success
/api/v2/Requests/movie/collection/{collectionId}:
post:
uriParameters:
collectionId:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
application/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
text/json:
type: !include types/Ombi.Core.Engine.RequestEngineResult.raml
/api/v2/Requests/recentlyRequested:
get:
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Requests.RecentlyRequestedModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Requests.RecentlyRequestedModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Requests.RecentlyRequestedModel.raml
/api/v2/Search/multi/{searchTerm}:
post:
description: |
The ID's returned by this are all TheMovieDbID's even for the TV Shows. You can call M:Ombi.Controllers.V2.SearchController.GetTvInfoByMovieId(System.String) to get TV
Show information using the MovieDbId.
uriParameters:
searchTerm:
description: |
The search you want, this can be for a movie or TV show e.g. Star Wars will return
all Star Wars movies and Star Wars Rebels the TV Sho type: string
required: true
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.Search.V2.MultiSearchFilter.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.MultiSearchFilter.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.MultiSearchFilter.raml
application/*+json:
type: !include types/Ombi.Core.Models.Search.V2.MultiSearchFilter.raml
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.V2.MultiSearchResult.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.V2.MultiSearchResult.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.V2.MultiSearchResult.raml
/api/v2/Search/Genres/{media}:
get:
description: |
Gets the genres for either Tv or Movies depending on media type
uriParameters:
media:
description: |
Either `tv` or `movie`. type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.TheMovieDbApi.Models.Genre.raml
application/json:
type: array
items: !include types/Ombi.TheMovieDbApi.Models.Genre.raml
text/json:
type: array
items: !include types/Ombi.TheMovieDbApi.Models.Genre.raml
/api/v2/Search/Languages:
get:
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.TheMovieDbApi.Models.Language.raml
application/json:
type: array
items: !include types/Ombi.TheMovieDbApi.Models.Language.raml
text/json:
type: array
items: !include types/Ombi.TheMovieDbApi.Models.Language.raml
/api/v2/Search/movie/{movieDbId}:
get:
description: |
Returns details for a single movie
uriParameters:
movieDbId:
description: |
The MovieDB Id type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.MovieFullInfoViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.MovieFullInfoViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.MovieFullInfoViewModel.raml
/api/v2/Search/movie/imdb/{imdbid}:
get:
uriParameters:
imdbId:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.MovieFullInfoViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.MovieFullInfoViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.MovieFullInfoViewModel.raml
/api/v2/Search/movie/request/{requestId}:
get:
description: |
Returns details for a single movie
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.MovieFullInfoViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.MovieFullInfoViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.MovieFullInfoViewModel.raml
/api/v2/Search/movie/collection/{collectionId}:
get:
description: |
Returns basic information about the provided collection
uriParameters:
collectionId:
description: |
The collection id from TheMovieDb type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.MovieCollectionsViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.MovieCollectionsViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.MovieCollectionsViewModel.raml
/api/v2/Search/tv/{tvdbId}:
get:
description: |
TVMaze is the TV Show Provider
uriParameters:
tvdbid:
description: |
The TVDB Id type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
/api/v2/Search/tv/request/{requestId}:
get:
description: |
TVMaze is the TV Show Provider
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
/api/v2/Search/tv/moviedb/{moviedbid}:
get:
description: |
Returns details for a single show
uriParameters:
moviedbid:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
/api/v2/Search/movie/similar:
post:
description: |
We use TheMovieDb as the Movie Provider
body:
application/json-patch+json:
type: !include types/Ombi.Models.SimilarMoviesRefineModel.raml
application/json:
type: !include types/Ombi.Models.SimilarMoviesRefineModel.raml
text/json:
type: !include types/Ombi.Models.SimilarMoviesRefineModel.raml
application/*+json:
type: !include types/Ombi.Models.SimilarMoviesRefineModel.raml
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/movie/popular:
get:
description: |
We use TheMovieDb as the Movie Provider
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/movie/popular/{currentPosition}/{amountToLoad}:
get:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/advancedSearch/movie/{currentPosition}/{amountToLoad}:
post:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
body:
application/json-patch+json:
type: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.DiscoverModel.raml
application/json:
type: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.DiscoverModel.raml
text/json:
type: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.DiscoverModel.raml
application/*+json:
type: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.DiscoverModel.raml
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/movie/seasonal/{currentPosition}/{amountToLoad}:
get:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/movie/requested/{currentPosition}/{amountToLoad}:
get:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/tv/requested/{currentPosition}/{amountToLoad}:
get:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.V2.SearchFullInfoTvShowViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/movie/nowplaying:
get:
description: |
We use TheMovieDb as the Movie Provider
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/movie/nowplaying/{currentPosition}/{amountToLoad}:
get:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/movie/toprated:
get:
description: |
We use TheMovieDb as the Movie Provider
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/movie/toprated/{currentPosition}/{amountToLoad}:
get:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/movie/upcoming:
get:
description: |
We use TheMovieDb as the Movie Provider
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/movie/upcoming/{currentPosition}/{amountToLoad}:
get:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/tv/popular/{currentPosition}/{amountToLoad}:
get:
description: |
We use Trakt.tv as the Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/tv/anticipated/{currentPosition}/{amountToLoad}:
get:
description: |
We use Trakt.tv as the Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/tv/mostwatched/{currentPosition}/{amountToLoad}:
get:
description: |
We use Trakt.tv as the Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/tv/trending/{currentPosition}/{amountToLoad}:
get:
description: |
We use TheMovieDb as the Provider
uriParameters:
currentPosition:
type: integer
required: true
amountToLoad:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/actor/{actorId}/movie:
get:
description: |
Returns all the movies that is by the actor id
uriParameters:
actorId:
description: |
TheMovieDb Actor ID type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.ActorCredits.raml
application/json:
type: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.ActorCredits.raml
text/json:
type: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.ActorCredits.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/actor/{actorId}/tv:
get:
description: |
Returns all the tv shows that is by the actor id
uriParameters:
actorId:
description: |
TheMovieDb Actor ID type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.ActorCredits.raml
application/json:
type: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.ActorCredits.raml
text/json:
type: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.ActorCredits.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/artist/{artistId}:
get:
uriParameters:
artistId:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.Music.ArtistInformation.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.Music.ArtistInformation.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.Music.ArtistInformation.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/artist/request/{requestId}:
get:
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.Music.ArtistInformation.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.Music.ArtistInformation.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.Music.ArtistInformation.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/artist/album/{albumId}:
get:
uriParameters:
albumId:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.Music.ReleaseGroup.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.Music.ReleaseGroup.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.Music.ReleaseGroup.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/releasegroupart/{musicBrainzId}:
get:
uriParameters:
musicBrainzId:
type: string
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Core.Models.Search.V2.Music.AlbumArt.raml
application/json:
type: !include types/Ombi.Core.Models.Search.V2.Music.AlbumArt.raml
text/json:
type: !include types/Ombi.Core.Models.Search.V2.Music.AlbumArt.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/ratings/movie/{name}/{year}:
get:
uriParameters:
name:
type: string
required: true
year:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Api.External.ExternalApis.RottenTomatoes.Models.MovieRatings.raml
application/json:
type: !include types/Ombi.Api.External.ExternalApis.RottenTomatoes.Models.MovieRatings.raml
text/json:
type: !include types/Ombi.Api.External.ExternalApis.RottenTomatoes.Models.MovieRatings.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/ratings/tv/{name}/{year}:
get:
uriParameters:
name:
type: string
required: true
year:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: !include types/Ombi.Api.External.ExternalApis.RottenTomatoes.Models.TvRatings.raml
application/json:
type: !include types/Ombi.Api.External.ExternalApis.RottenTomatoes.Models.TvRatings.raml
text/json:
type: !include types/Ombi.Api.External.ExternalApis.RottenTomatoes.Models.TvRatings.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/stream/movie/{movieDbId}:
get:
uriParameters:
movieDBId:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.V2.StreamingData.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.V2.StreamingData.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.V2.StreamingData.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v2/Search/stream/tv/{movieDbId}:
get:
uriParameters:
movieDbId:
type: integer
required: true
responses:
200:
description: |
Success
body:
text/plain:
type: array
items: !include types/Ombi.Core.Models.Search.V2.StreamingData.raml
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.V2.StreamingData.raml
text/json:
type: array
items: !include types/Ombi.Core.Models.Search.V2.StreamingData.raml
default:
description: |
Error
body:
text/plain:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
text/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie/{searchTerm}:
get:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
searchTerm:
description: |
The search term. type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie/actor:
post:
description: |
Searches for movies by a certain actor.
body:
application/json-patch+json:
type: !include types/Ombi.Models.SearchActorModel.raml
application/json:
type: !include types/Ombi.Models.SearchActorModel.raml
text/json:
type: !include types/Ombi.Models.SearchActorModel.raml
application/*+json:
type: !include types/Ombi.Models.SearchActorModel.raml
responses:
200:
description: |
Success
400:
description: |
Bad Request
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie:
post:
description: |
We use TheMovieDb as the Movie Provider
body:
application/json-patch+json:
type: !include types/Ombi.Models.SearchMovieRefineModel.raml
application/json:
type: !include types/Ombi.Models.SearchMovieRefineModel.raml
text/json:
type: !include types/Ombi.Models.SearchMovieRefineModel.raml
application/*+json:
type: !include types/Ombi.Models.SearchMovieRefineModel.raml
responses:
200:
description: |
Success
400:
description: |
Bad Request
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie/info/{theMovieDbId}:
get:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
theMovieDbId:
description: |
The movie database identifier. type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie/info:
post:
description: |
We use TheMovieDb as the Movie Provider
body:
application/json-patch+json:
type: !include types/Ombi.Models.SearchMovieExtraInfoRefineModel.raml
application/json:
type: !include types/Ombi.Models.SearchMovieExtraInfoRefineModel.raml
text/json:
type: !include types/Ombi.Models.SearchMovieExtraInfoRefineModel.raml
application/*+json:
type: !include types/Ombi.Models.SearchMovieExtraInfoRefineModel.raml
responses:
200:
description: |
Success
400:
description: |
Bad Request
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie/similar:
post:
description: |
We use TheMovieDb as the Movie Provider
body:
application/json-patch+json:
type: !include types/Ombi.Models.SimilarMoviesRefineModel.raml
application/json:
type: !include types/Ombi.Models.SimilarMoviesRefineModel.raml
text/json:
type: !include types/Ombi.Models.SimilarMoviesRefineModel.raml
application/*+json:
type: !include types/Ombi.Models.SimilarMoviesRefineModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie/{theMovieDbId}/similar:
get:
description: |
We use TheMovieDb as the Movie Provider
uriParameters:
theMovieDbId:
description: |
ID of the movie type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie/popular:
get:
description: |
We use TheMovieDb as the Movie Provider
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie/nowplaying:
get:
description: |
We use TheMovieDb as the Movie Provider
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie/toprated:
get:
description: |
We use TheMovieDb as the Movie Provider
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/movie/upcoming:
get:
description: |
We use TheMovieDb as the Movie Provider
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchMovieViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/tv/{searchTerm}:
get:
description: |
We use TvMaze as the Provider
uriParameters:
searchTerm:
description: |
The search term. type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/tv/info/{tvdbId}:
get:
description: |
We use TvMaze as the Provider
uriParameters:
tvdbId:
description: |
The TVDB identifier. type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/tv/popular:
get:
description: |
We use Trakt.tv as the Provider
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/tv/anticipated:
get:
description: |
We use Trakt.tv as the Provider
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/tv/mostwatched:
get:
description: |
We use Trakt.tv as the Provider
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/tv/trending:
get:
description: |
We use Trakt.tv as the Provider
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchTvShowViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/music/artist/{searchTerm}:
get:
description: |
We use Lidarr as the Provider
uriParameters:
searchTerm:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchArtistViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/music/album/{searchTerm}:
get:
description: |
We use Lidarr as the Provider
uriParameters:
searchTerm:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchAlbumViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/music/album/info/{foreignAlbumId}:
get:
description: |
We use Lidarr as the Provider
uriParameters:
foreignAlbumId:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.Search.SearchAlbumViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Search/music/artist/album/{foreignArtistId}:
get:
description: |
We use Lidarr as the Provider
uriParameters:
foreignArtistId:
type: string
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.Search.SearchAlbumViewModel.raml
default:
description: |
Error
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Settings/ombi:
get:
description: |
Gets the Ombi settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.OmbiSettings.raml
post:
description: |
Save the Ombi settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.OmbiSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.OmbiSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.OmbiSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.OmbiSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/baseurl:
get:
description: |
Gets the base url.
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Settings/about:
get:
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.AboutViewModel.raml
/api/v1/Settings/ombi/resetApi:
post:
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Settings/plex:
get:
description: |
Gets the Plex Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Settings.Models.External.PlexSettings.raml
post:
description: |
Save the Plex settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.PlexSettings.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.PlexSettings.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.PlexSettings.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.PlexSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/clientid:
get:
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Settings/emby:
get:
description: |
Gets the Emby Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbySettings.raml
post:
description: |
Save the Emby settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.EmbySettings.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbySettings.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbySettings.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.EmbySettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/jellyfin:
get:
description: |
Gets the Jellyfin Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinSettings.raml
post:
description: |
Save the Jellyfin settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinSettings.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinSettings.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinSettings.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/landingpage:
get:
description: |
Gets the Landing Page Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Settings.Models.LandingPageSettings.raml
post:
description: |
Save the Landing Page settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.LandingPageSettings.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.LandingPageSettings.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.LandingPageSettings.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.LandingPageSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/customization:
get:
description: |
Gets the Customization Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.CustomizationSettings.raml
post:
description: |
Save the Customization settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.CustomizationSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.CustomizationSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.CustomizationSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.CustomizationSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/defaultlanguage:
get:
description: |
Gets the default language set in Ombi
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Settings/themes:
get:
description: |
Get's the preset themes available
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Models.PresetThemeViewModel.raml
/api/v1/Settings/sonarr:
get:
description: |
Gets the Sonarr Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
post:
description: |
Save the Sonarr settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/radarr:
get:
description: |
Gets the Radarr Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrCombinedModel.raml
post:
description: |
Save the Radarr settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrCombinedModel.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrCombinedModel.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrCombinedModel.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrCombinedModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/lidarr:
get:
description: |
Gets the Lidarr Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
post:
description: |
Save the Lidarr settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/lidarrenabled:
get:
description: |
Gets the Lidarr Settings.
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/authentication:
post:
description: |
Save the Authentication settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.AuthenticationSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.AuthenticationSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.AuthenticationSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.AuthenticationSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the Authentication Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.AuthenticationSettings.raml
/api/v1/Settings/Update:
post:
description: |
Save the Update settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.UpdateSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.UpdateSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.UpdateSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.UpdateSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the Update Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.UpdateSettings.raml
/api/v1/Settings/UserManagement:
get:
description: |
Gets the UserManagement Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.UserManagementSettings.raml
post:
description: |
Save the UserManagement settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.UserManagementSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.UserManagementSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.UserManagementSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.UserManagementSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/CouchPotato:
get:
description: |
Gets the CouchPotatoSettings Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
post:
description: |
Save the CouchPotatoSettings settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/DogNzb:
get:
description: |
Gets the DogNzbSettings Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.DogNzbSettings.raml
post:
description: |
Save the DogNzbSettings settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.DogNzbSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.DogNzbSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.DogNzbSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.DogNzbSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/SickRage:
post:
description: |
Save the SickRage settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.SickRageSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SickRageSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.SickRageSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.SickRageSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the SickRage Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SickRageSettings.raml
/api/v1/Settings/jobs:
get:
description: |
Gets the JobSettings Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.JobSettings.raml
post:
description: |
Save the JobSettings settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.JobSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.JobSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.JobSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.JobSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.JobSettingsViewModel.raml
/api/v1/Settings/testcron:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Models.CronViewModelBody.raml
application/json:
type: !include types/Ombi.Models.CronViewModelBody.raml
text/json:
type: !include types/Ombi.Models.CronViewModelBody.raml
application/*+json:
type: !include types/Ombi.Models.CronViewModelBody.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Models.CronTestModel.raml
/api/v1/Settings/Issues:
post:
description: |
Save the Vote settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.IssueSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.IssueSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.IssueSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.IssueSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the Issues Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.IssueSettings.raml
/api/v1/Settings/issuesenabled:
get:
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/vote:
post:
description: |
Save the Vote settings.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.VoteSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.VoteSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.VoteSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.VoteSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the Vote Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Settings.Settings.Models.VoteSettings.raml
/api/v1/Settings/voteenabled:
get:
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/themoviedb:
post:
description: |
Save The Movie DB settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.TheMovieDbSettings.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.TheMovieDbSettings.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.TheMovieDbSettings.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.TheMovieDbSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Get The Movie DB settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Settings.Models.External.TheMovieDbSettings.raml
/api/v1/Settings/notifications/email:
post:
description: |
Saves the email notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.EmailNotificationsViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.EmailNotificationsViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.EmailNotificationsViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.EmailNotificationsViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the Email Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.EmailNotificationsViewModel.raml
/api/v1/Settings/notifications/email/enabled:
get:
description: |
Gets the Email Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/notifications/discord:
post:
description: |
Saves the discord notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.DiscordNotificationsViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.DiscordNotificationsViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.DiscordNotificationsViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.DiscordNotificationsViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the discord Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.DiscordNotificationsViewModel.raml
/api/v1/Settings/notifications/telegram:
post:
description: |
Saves the telegram notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.TelegramNotificationsViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.TelegramNotificationsViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.TelegramNotificationsViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.TelegramNotificationsViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the telegram Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.TelegramNotificationsViewModel.raml
/api/v1/Settings/notifications/pushbullet:
post:
description: |
Saves the pushbullet notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.PushbulletNotificationViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.PushbulletNotificationViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.PushbulletNotificationViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.PushbulletNotificationViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the pushbullet Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.PushbulletNotificationViewModel.raml
/api/v1/Settings/notifications/pushover:
post:
description: |
Saves the pushover notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.PushoverNotificationViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.PushoverNotificationViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.PushoverNotificationViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.PushoverNotificationViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the pushover Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.PushoverNotificationViewModel.raml
/api/v1/Settings/notifications/slack:
post:
description: |
Saves the slack notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.SlackNotificationsViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.SlackNotificationsViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.SlackNotificationsViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.SlackNotificationsViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the slack Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.SlackNotificationsViewModel.raml
/api/v1/Settings/notifications/mattermost:
post:
description: |
Saves the Mattermost notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.MattermostNotificationsViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.MattermostNotificationsViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.MattermostNotificationsViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.MattermostNotificationsViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the Mattermost Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.MattermostNotificationsViewModel.raml
/api/v1/Settings/notifications/twilio:
get:
description: |
Gets the Twilio Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.TwilioSettingsViewModel.raml
post:
description: |
Saves the Mattermost notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.TwilioSettingsViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.TwilioSettingsViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.TwilioSettingsViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.TwilioSettingsViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Settings/notifications/mobile:
post:
description: |
Saves the Mobile notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.MobileNotificationsViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.MobileNotificationsViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.MobileNotificationsViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.MobileNotificationsViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the Mobile Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.MobileNotificationsViewModel.raml
/api/v1/Settings/notifications/gotify:
post:
description: |
Saves the gotify notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.GotifyNotificationViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.GotifyNotificationViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.GotifyNotificationViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.GotifyNotificationViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the gotify Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.GotifyNotificationViewModel.raml
/api/v1/Settings/notifications/ntfy:
post:
description: |
Saves the ntfy notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.NtfyNotificationViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.NtfyNotificationViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.NtfyNotificationViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.NtfyNotificationViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the ntfy Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.NtfyNotificationViewModel.raml
/api/v1/Settings/notifications/webhook:
post:
description: |
Saves the webhook notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.WebhookNotificationViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.WebhookNotificationViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.WebhookNotificationViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.WebhookNotificationViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the webhook notification settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.WebhookNotificationViewModel.raml
/api/v1/Settings/notifications/newsletter:
post:
description: |
Saves the Newsletter notification settings.
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.NewsletterNotificationViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.NewsletterNotificationViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.NewsletterNotificationViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.NewsletterNotificationViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
get:
description: |
Gets the Newsletter Notification Settings.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.UI.NewsletterNotificationViewModel.raml
/api/v1/Sonarr/Profiles:
post:
description: |
Gets the Sonarr profiles.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Sonarr.Models.SonarrProfile.raml
get:
description: |
Gets the Sonarr profiles.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Sonarr.Models.SonarrProfile.raml
/api/v1/Sonarr/RootFolders:
post:
description: |
Gets the Sonarr root folders.
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Sonarr.Models.SonarrRootFolder.raml
get:
description: |
Gets the Sonarr root folders.
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Sonarr.Models.SonarrRootFolder.raml
/api/v1/Sonarr/v3/LanguageProfiles:
get:
description: |
Gets the Sonarr V3 language profiles
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Sonarr.Models.V3.LanguageProfiles.raml
post:
description: |
Gets the Sonarr V3 language profiles
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Sonarr.Models.V3.LanguageProfiles.raml
/api/v1/Sonarr/tags:
post:
description: |
Gets the Sonarr tags
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Sonarr.Models.Tag.raml
get:
description: |
Gets the Sonarr tags
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.Sonarr.Models.Tag.raml
/api/v1/Sonarr/enabled:
get:
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Sonarr/version:
get:
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v1/Stats:
get:
queryParameters:
from:
type: string
required: false
to:
type: string
required: false
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Engine.UserStatsSummary.raml
/api/v1/Status:
get:
description: |
Gets the status of Ombi.
responses:
200:
description: |
Success
body:
application/json:
type: !include types/System.Net.HttpStatusCode.raml
/api/v1/Status/info:
get:
description: |
Returns information about this ombi instance
responses:
200:
description: |
Success
body:
application/json:
type: string
/api/v2/System/news:
get:
responses:
200:
description: |
Success
/api/v2/System/logs:
get:
responses:
200:
description: |
Success
/api/v2/System/logs/{logFileName}:
get:
uriParameters:
logFileName:
type: string
required: true
responses:
200:
description: |
Success
/api/v2/System/logs/download/{logFileName}:
get:
uriParameters:
logFileName:
type: string
required: true
responses:
200:
description: |
Success
/api/v1/Tester/discord:
post:
description: |
Sends a test message to discord using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.DiscordNotificationSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.DiscordNotificationSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.DiscordNotificationSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.DiscordNotificationSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/pushbullet:
post:
description: |
Sends a test message to Pushbullet using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.PushbulletSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.PushbulletSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.PushbulletSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.PushbulletSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/pushover:
post:
description: |
Sends a test message to Pushover using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.PushoverSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.PushoverSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.PushoverSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.PushoverSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/gotify:
post:
description: |
Sends a test message to Gotify using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.GotifySettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.GotifySettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.GotifySettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.GotifySettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/ntfy:
post:
description: |
Sends a test message to Ntfy using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.NtfySettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.NtfySettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.NtfySettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.NtfySettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/webhook:
post:
description: |
Sends a test message to configured webhook using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.WebhookSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.WebhookSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.WebhookSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.WebhookSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/mattermost:
post:
description: |
Sends a test message to mattermost using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.MattermostNotificationSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.MattermostNotificationSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.MattermostNotificationSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.MattermostNotificationSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/slack:
post:
description: |
Sends a test message to Slack using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.SlackNotificationSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.SlackNotificationSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.SlackNotificationSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.SlackNotificationSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/email:
post:
description: |
Sends a test message via email to the admin email using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.EmailNotificationSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.EmailNotificationSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.EmailNotificationSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.EmailNotificationSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/plex:
post:
description: |
Checks if we can connect to Plex with the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.PlexServers.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.PlexServers.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.PlexServers.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.PlexServers.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/emby:
post:
description: |
Checks if we can connect to Emby with the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.EmbyServers.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/jellyfin:
post:
description: |
Checks if we can connect to Jellyfin with the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
application/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
text/json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
application/*+json:
type: !include types/Ombi.Core.Settings.Models.External.JellyfinServers.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/radarr:
post:
description: |
Checks if we can connect to Radarr with the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.RadarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.TesterResultModel.raml
/api/v1/Tester/sonarr:
post:
description: |
Checks if we can connect to Sonarr with the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.SonarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.TesterResultModel.raml
/api/v1/Tester/couchpotato:
post:
description: |
Checks if we can connect to CouchPotato with the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.CouchPotatoSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/telegram:
post:
description: |
Sends a test message to Telegram using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.TelegramSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.TelegramSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.TelegramSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.Notifications.TelegramSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/sickrage:
post:
description: |
Sends a test message to Slack using the provided settings
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.SickRageSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.SickRageSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.SickRageSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.SickRageSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/newsletter:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.NewsletterNotificationViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.NewsletterNotificationViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.NewsletterNotificationViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.NewsletterNotificationViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/mobile:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Models.MobileNotificationTestViewModel.raml
application/json:
type: !include types/Ombi.Models.MobileNotificationTestViewModel.raml
text/json:
type: !include types/Ombi.Models.MobileNotificationTestViewModel.raml
application/*+json:
type: !include types/Ombi.Models.MobileNotificationTestViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Tester/lidarr:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
application/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
text/json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
application/*+json:
type: !include types/Ombi.Settings.Settings.Models.External.LidarrSettings.raml
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.TesterResultModel.raml
/api/v1/Tester/whatsapp:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Core.Models.UI.WhatsAppSettingsViewModel.raml
application/json:
type: !include types/Ombi.Core.Models.UI.WhatsAppSettingsViewModel.raml
text/json:
type: !include types/Ombi.Core.Models.UI.WhatsAppSettingsViewModel.raml
application/*+json:
type: !include types/Ombi.Core.Models.UI.WhatsAppSettingsViewModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/TheMovieDb/Keywords:
get:
description: |
Searches for keywords matching the specified term.
queryParameters:
searchTerm:
description: |
The search term. type: string
required: false
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.TheMovidDbKeyValue.raml
/api/v1/TheMovieDb/Keywords/{keywordId}:
get:
description: |
Gets the keyword matching the specified ID.
uriParameters:
keywordId:
description: |
The keyword ID. type: integer
required: true
responses:
200:
description: |
Success
/api/v1/TheMovieDb/WatchProviders/movie:
get:
description: |
Searches for the watch providers matching the specified term.
queryParameters:
searchTerm:
description: |
The search term. type: string
required: false
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.WatchProvidersResults.raml
/api/v1/TheMovieDb/WatchProviders/tv:
get:
description: |
Searches for the watch providers matching the specified term.
queryParameters:
searchTerm:
description: |
The search term. type: string
required: false
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Api.External.ExternalApis.TheMovieDb.Models.WatchProvidersResults.raml
/api/v1/Token:
post:
description: |
Gets the token.
body:
application/json-patch+json:
type: !include types/Ombi.Models.UserAuthModel.raml
application/json:
type: !include types/Ombi.Models.UserAuthModel.raml
text/json:
type: !include types/Ombi.Models.UserAuthModel.raml
application/*+json:
type: !include types/Ombi.Models.UserAuthModel.raml
responses:
401:
description: |
Unauthorized
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Controllers.V1.Token.raml
/api/v1/Token/plextoken:
post:
description: |
Returns the Token for the Ombi User if we can match the Plex user with a valid Ombi User
body:
application/json-patch+json:
type: !include types/Ombi.Models.External.PlexTokenAuthentication.raml
application/json:
type: !include types/Ombi.Models.External.PlexTokenAuthentication.raml
text/json:
type: !include types/Ombi.Models.External.PlexTokenAuthentication.raml
application/*+json:
type: !include types/Ombi.Models.External.PlexTokenAuthentication.raml
responses:
401:
description: |
Unauthorized
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
400:
description: |
Bad Request
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Token/{pinId}:
get:
uriParameters:
pinId:
type: integer
required: true
responses:
401:
description: |
Unauthorized
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Token/refresh:
post:
description: |
Refreshes the token.
body:
application/json-patch+json:
type: !include types/Ombi.Controllers.V1.TokenController_TokenRefresh.raml
application/json:
type: !include types/Ombi.Controllers.V1.TokenController_TokenRefresh.raml
text/json:
type: !include types/Ombi.Controllers.V1.TokenController_TokenRefresh.raml
application/*+json:
type: !include types/Ombi.Controllers.V1.TokenController_TokenRefresh.raml
responses:
401:
description: |
Unauthorized
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
/api/v1/Token/requirePassword:
post:
body:
application/json-patch+json:
type: !include types/Ombi.Models.UserAuthModel.raml
application/json:
type: !include types/Ombi.Models.UserAuthModel.raml
text/json:
type: !include types/Ombi.Models.UserAuthModel.raml
application/*+json:
type: !include types/Ombi.Models.UserAuthModel.raml
responses:
200:
description: |
Success
body:
application/json:
type: boolean
/api/v1/Token/header_auth:
post:
responses:
401:
description: |
Unauthorized
body:
application/json:
type: !include types/Microsoft.AspNetCore.Mvc.ProblemDetails.raml
200:
description: |
Success
/api/v1/Update:
get:
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Processor.UpdateModel.raml
/api/v1/Vote:
get:
description: |
Returns the viewmodel to render on the UI
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Core.Models.UI.VoteViewModel.raml
/api/v1/Vote/up/movie/{requestId}:
post:
description: |
Upvotes a movie
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.VoteEngineResult.raml
/api/v1/Vote/up/tv/{requestId}:
post:
description: |
Upvotes a tv show
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.VoteEngineResult.raml
/api/v1/Vote/up/album/{requestId}:
post:
description: |
Upvotes a album
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.VoteEngineResult.raml
/api/v1/Vote/down/movie/{requestId}:
post:
description: |
Downvotes a movie
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.VoteEngineResult.raml
/api/v1/Vote/down/tv/{requestId}:
post:
description: |
Downvotes a tv show
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.VoteEngineResult.raml
/api/v1/Vote/down/album/{requestId}:
post:
description: |
Downvotes a album
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: !include types/Ombi.Core.Models.VoteEngineResult.raml
/api/v1/Vote/movie/{requestId}:
get:
description: |
Get's all the votes for the request id
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Votes.raml
/api/v1/Vote/music/{requestId}:
get:
description: |
Get's all the votes for the request id
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Votes.raml
/api/v1/Vote/tv/{requestId}:
get:
description: |
Get's all the votes for the request id
uriParameters:
requestId:
type: integer
required: true
responses:
200:
description: |
Success
body:
application/json:
type: array
items: !include types/Ombi.Store.Entities.Votes.raml
Reference in New Issue View Git Blame Copy Permalink