GOgotify
client

Update a client.

Changed on
put/client/{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 client id

Request body

expiresAfterInactivitySecondsinteger

The number of seconds of inactivity after which the client is removed. 0 (or omitted) means the client never expires.

namestring required

The client name

Example request

{
  "expiresAfterInactivitySeconds": 2592000,
  "name": "My Client"
}

Response

Ok

createdAtstring date-time required

The date the client was created.

elevatedUntilstring date-time

The time until which this client's session is elevated.

expiresAfterInactivitySecondsinteger

The number of seconds of inactivity after which the client is removed. 0 means the client never expires.

expiresAtstring date-time

The time at which this client will expire due to inactivity, or null if it never expires.

idinteger required

The client id.

lastUsedstring date-time

The last time the client token was used.

namestring required

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

tokenstring

The client token. Can be used as clientToken. See Authentication.

Example response

{
  "createdAt": "2019-01-01T00:00:00Z",
  "expiresAfterInactivitySeconds": 2592000,
  "expiresAt": "2019-01-01T00:00:00Z",
  "id": 5,
  "lastUsed": "2019-01-01T00:00:00Z",
  "name": "Android Phone",
  "token": "CWH0wZ5r0Mbac.r"
}

Changes