GOgotify
application

Update an application.

Changed on
put/application/{id}

Request

  • Base URL
    http://localhost
  • Auth
    • API key in header Authorization
    • or API key in header X-Gotify-Key
    • or API key in query parameter token
    • or HTTP basic

Path parameters

idinteger required

the application id

Request body

defaultPriorityinteger

The default priority of messages sent by this application. Defaults to 0.

descriptionstring

The description of the application.

namestring required

The application name. This is how the application should be displayed to the user.

sortKeystring

The sortKey for the application. Uses fractional indexing.

Example request

{
  "defaultPriority": 5,
  "description": "Backup server for the interwebs",
  "name": "Backup Server",
  "sortKey": "a1"
}

Response

Ok

createdAtstring date-time required

The date the application was created.

defaultPriorityinteger

The default priority of messages sent by this application. Defaults to 0.

descriptionstring required

The description of the application.

idinteger required

The application id.

imagestring required

The image of the application.

internalboolean required

Whether the application is an internal application. Internal applications should not be deleted.

lastUsedstring date-time

The last time the application token was used.

namestring required

The application name. This is how the application should be displayed to the user.

sortKeystring required

The sort key of this application. Uses fractional indexing.

tokenstring

The application token. Can be used as appToken. See Authentication.

Example response

{
  "createdAt": "2019-01-01T00:00:00Z",
  "defaultPriority": 4,
  "description": "Backup server for the interwebs",
  "id": 5,
  "image": "image/image.jpeg",
  "lastUsed": "2019-01-01T00:00:00Z",
  "name": "Backup Server",
  "sortKey": "a1",
  "token": "AWH0wZ5r0Mbac.r"
}

Changes