endpoints.md

Endpoint Classes

Jump to:

• Application
• ApplicationMessage
• Message
• Client
• User
• Health
• Plugin
• Version

Application

Gotify\Endpoint\Application(Server $server, Auth\User|Auth\Token $auth)

Class: Application

API docs: https://gotify.net/api-docs#/application

Examples

• Get all applications
• Create an application

Methods

Get all applications

getAll(): stdClass

Create an application

create(string $name, string $description): stdClass

Update an application

update(int $id, string $name, string $description): stdClass

Delete an application

delete(int $id): boolean

Upload image for an application

uploadImage(int $id, string $image): stdClass

Delete the image for an application

deleteImage(int $id): stdClass

ApplicationMessage

Gotify\Endpoint\ApplicationMessage(Server $server, Auth\User|Auth\Token $auth)

Class: ApplicationMessage

API docs: https://gotify.net/api-docs#/message

Methods

Get all messages for an application

getAll(int $id, int $limit = 100, int $since = 0): stdClass

Delete all messages for an application

deleteAll(int $id): boolean

Message

Gotify\Endpoint\Message(Server $server, Auth\User|Auth\Token $auth)

Class: Message

API docs: https://gotify.net/api-docs#/message

Examples

• Get all messages
• Create a message
• Create a message with extras

Constants

High message priority

Gotify\Endpoint\Message::PRIORITY_HIGH

Default message priority

Gotify\Endpoint\Message::PRIORITY_DEFAULT

Low message priority

Gotify\Endpoint\Message::PRIORITY_LOW

Minimum message priority

Gotify\Endpoint\Message::PRIORITY_MIN

Methods

Get all messages

getAll(int $limit = 100, int $since = 0): stdClass

Create a message

create(string $title, string $message, int $priority = 0, array $extras = array(): stdClass

Delete a message

delete(int $id): boolean

Delete all messages

deleteAll(): boolean

Client

Gotify\Endpoint\Client(Server $server, Auth\User|Auth\Token $auth)

Class: Client

API docs: https://gotify.net/api-docs#/client

Examples

• Create a client
• Get all Clients

Methods

Get all clients

getAll(): stdClass

Create a client

create(string $name): stdClass

Update a client

update(int $id, string $name): stdClass

Delete a client

delete(int $id): boolean

User

Gotify\Endpoint\User(Server $server, Auth\User|Auth\Token $auth)

Class: User

API docs: https://gotify.net/api-docs#/user

Examples

• Create a user

Methods

Get current user

getCurrent(): stdClass

Update password for the current user

updatePassword(string $password): boolean

Get a user

getUser(int $id): stdClass

Get all users

getAll(): stdClass

Create a user

create(string $name, string $password, bool $admin = false): stdClass

Update a user

update(int $id, string $name, string $password = '', bool $admin = false): stdClass

Delete a user

delete(int $id): boolean

Health

Gotify\Endpoint\Health(Server $server)

Class: Health

API docs: https://gotify.net/api-docs#/health

Methods

Get health information

get(): stdClass

Plugin

Gotify\Endpoint\Plugin(Server $server, Auth\User|Auth\Token $auth)

Class: Plugin

API docs: https://gotify.net/api-docs#/plugin

Methods

Get all plugins

getAll(): stdClass

Get configuration for a plugin.

getConfig(int $id): string

Update configuration for a plugin.

updateConfig(int $id, string $config): bool

Get display info for a plugin

getDisplayInfo(int $id): string

Enable a plugin

enable(int $id): stdClass

Disable a plugin

disable(int $id): stdClass

Version

Gotify\Endpoint\Version(Server $server)

Class: Version

API docs: https://gotify.net/api-docs#/version

Examples

• Get version information

Methods

Get version information

get(): stdClass