# Gotify

## API Docs

- [Gotify REST-API.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/index.md): This is the documentation of the Gotify REST-API.
- [Return all applications.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-application-get.md): GET /application: returns a list of Application.
- [Create an application.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-application-post.md): POST /application: takes ApplicationParams, returns Application.
- [Update an application.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-application-id-put.md): PUT /application/{id}: takes ApplicationParams, returns Application.
- [Delete an application.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-application-id-delete.md): Requires elevated authentication.
- [Upload an image for an application.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-application-id-image-post.md): POST /application/{id}/image: returns Application.
- [Deletes an image of an application.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-application-id-image-delete.md): DELETE /application/{id}/image.
- [Return all messages from a specific application.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-application-id-message-get.md): GET /application/{id}/message: returns PagedMessages.
- [Delete all messages from a specific application.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-application-id-message-delete.md): DELETE /application/{id}/message.
- [Perform security updates on an application.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-application-id-security-put.md): Requires elevated authentication.
- [Authenticate via basic auth and create a session.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-auth-local-login-post.md): POST /auth/local/login: returns CurrentUser.
- [End the current session.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-auth-logout-post.md): Clears the session cookie and deletes the associated client.
- [Handle the OIDC provider callback (browser).](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-auth-oidc-callback-get.md): Exchanges the authorization code for tokens, resolves the user, creates a gotify client, sets a session cookie, and redirects to the UI.
- [Start the OIDC flow to elevate an existing client session (browser).](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-auth-oidc-elevate-get.md): Redirects the user to the OIDC provider's authorization endpoint. After successful authentication, the referenced client session is elevated for the requested duration.
- [Initiate the OIDC authorization flow for a native app.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-auth-oidc-external-authorize-post.md): The app generates a PKCE code_verifier and code_challenge, then calls this endpoint. The server forwards the code_challenge to the OIDC provider and returns the authorization URL for the app to open in a browser.
- [Exchange an authorization code for a gotify client token.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-auth-oidc-external-token-post.md): After the user authenticates with the OIDC provider and the app receives the authorization code via redirect, the app calls this endpoint with the code and PKCE code_verifier. The server exchanges the code with the OIDC provider and returns a gotify client token.
- [Start the OIDC login flow (browser).](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-auth-oidc-login-get.md): Redirects the user to the OIDC provider's authorization endpoint. After authentication, the provider redirects back to the callback endpoint.
- [Return all clients.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-client-get.md): GET /client: returns a list of Client.
- [Create a client.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-client-post.md): POST /client: takes ClientParams, returns Client.
- [Update a client.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-client-id-put.md): PUT /client/{id}: takes ClientParams, returns Client.
- [Delete a client.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-client-id-delete.md): Requires elevated authentication.
- [Elevate a client session.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-client-id-elevate-post.md): Requires elevated authentication.
- [Return the current user.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-current-user-get.md): Requires elevated authentication.
- [Update the password of the current user.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-current-user-password-post.md): Requires elevated authentication.
- [Get gotify information.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-gotifyinfo-get.md): GET /gotifyinfo: returns GotifyInfo.
- [Get health information.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-health-get.md): GET /health: returns Health.
- [Return all messages.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-message-get.md): GET /message: returns PagedMessages.
- [Create a message.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-message-post.md): NOTE: When authenticating with a client token or basic auth, the request body must include "appid" referencing an application owned by the authenticated user. When authenticating with an application token, the application is derived from the token and any "appid" in the body is ignored.
- [Delete all messages.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-message-delete.md): DELETE /message.
- [Deletes a message with an id.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-message-id-delete.md): DELETE /message/{id}.
- [Return all plugins.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-plugin-get.md): GET /plugin: returns a list of PluginConf.
- [Get YAML configuration for Configurer plugin.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-plugin-id-config-get.md): GET /plugin/{id}/config.
- [Update YAML configuration for Configurer plugin.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-plugin-id-config-post.md): POST /plugin/{id}/config.
- [Disable a plugin.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-plugin-id-disable-post.md): POST /plugin/{id}/disable.
- [Get display info for a Displayer plugin.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-plugin-id-display-get.md): GET /plugin/{id}/display.
- [Enable a plugin.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-plugin-id-enable-post.md): POST /plugin/{id}/enable.
- [Websocket, return newly created messages.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-stream-get.md): GET /stream: returns Message.
- [Return all users.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-user-get.md): Requires elevated authentication.
- [Create a user.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-user-post.md): With enabled registration: non admin users can be created without authentication. With disabled registrations: users can only be created by admin users.
- [Get a user.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-user-id-get.md): Requires elevated authentication.
- [Update a user.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-user-id-post.md): Requires elevated authentication.
- [Deletes a user.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-user-id-delete.md): Requires elevated authentication.
- [Get version information.](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/operations/operation-version-get.md): GET /version: returns VersionInfo.
- [Application](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/application-e7ad522ea3.md): The Application holds information about an app which can send notifications.
- [ApplicationParams](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/applicationparams-2c0d3c9325.md): Params allowed to create or update Applications.
- [Client](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/client-0c77fe09ab.md): The Client holds information about a device which can receive notifications (and other stuff).
- [ClientParams](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/clientparams-c648cc5c72.md): Params allowed to create or update Clients.
- [CreateMessage](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/createmessage-a2e15bf534.md): The CreateMessage holds information about a message that will be sent.
- [CreateUserExternal](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/createuserexternal-8b170a1f76.md): Used for user creation.
- [CurrentUser](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/currentuser-785d418b2d.md): CurrentUserExternal Model
- [ElevateRequest](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/elevaterequest-1bf9eaf4d4.md): Field: durationSeconds.
- [Error](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/error-54a0e8c17e.md): The Error contains error relevant information.
- [GotifyInfo](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/gotifyinfo-f84dc581fe.md): GotifyInfo Model
- [Health](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/health-55898449eb.md): Health represents how healthy the application is.
- [Message](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/message-2f77668a9d.md): The MessageExternal holds information about a message which was sent by an Application.
- [OIDCExternalAuthorizeRequest](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/oidcexternalauthorizerequest-4b92299fe4.md): Used to initiate the OIDC authorization flow for an external client.
- [OIDCExternalAuthorizeResponse](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/oidcexternalauthorizeresponse-332c3aad7d.md): Returned after initiating the OIDC authorization flow.
- [OIDCExternalTokenRequest](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/oidcexternaltokenrequest-1288c069e8.md): Used to exchange an authorization code for a gotify client token.
- [OIDCExternalTokenResponse](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/oidcexternaltokenresponse-569315d693.md): Returned after a successful token exchange.
- [PagedMessages](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/pagedmessages-21c696acff.md): Wrapper for the paging and the messages.
- [Paging](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/paging-a325388710.md): The Paging holds information about the limit and making requests to the next page.
- [PluginConf](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/pluginconf-f74213b140.md): Holds information about a plugin instance for one user.
- [RegenerateTokenResponse](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/regeneratetokenresponse-9c3be93e5e.md): The RegenerateTokenResponse holds information about the response to the regenerate token action.
- [SecurityUpdateAction](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/securityupdateaction-375b486776.md): The SecurityUpdateAction describes the details of a requested security update.
- [SecurityUpdateActionResponse](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/securityupdateactionresponse-2441fcf8c2.md): The SecurityUpdateActionResponse holds information about the response to a security update request.
- [UpdateUserExternal](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/updateuserexternal-2d72e290fe.md): Used for updating a user.
- [User](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/user-b512d97e7c.md): The User holds information about permission and other stuff.
- [UserPass](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/userpass-d0d4f76c2b.md): The Password for updating the user.
- [VersionInfo](https://sourcey-gotify.pages.dev/api-docs/v3.0.0/schemas/versioninfo-641558380f.md): VersionInfo Model