GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

No menu could be recovered. Follow the blue links in the page.

This view

  • Original page
  • New address

GeezerVison is showing pushbits.github.io — PushBits Server API Documentation

  • Alertmanager
    • postCreate an Alert
  • Application
    • getGet Applications
    • postCreate Application
    • delDelete Application
    • getGet Application
    • putUpdate Application
    • postCreate a Notification
    • delDelete a Notification
  • Health
    • getHealth of the application
  • User
    • getGet Users
    • postCreate a User
    • delDelete User
    • getGet User
    • putUpdate User
API docs by Redocly

PushBits Server API Documentation (0.10.5)

Download OpenAPI specification:Download

URL: https://www.pushbits.io License: ISC

Documentation for the PushBits server API.

Alertmanager

Create an Alert

Creates an alert that is send to the channel as a notification. This endpoint is compatible with alertmanager webhooks.

query Parameters
token
required
string

Channels token, can also be provieded in the header

Request Body schema: application/json

alertmanager webhook call

Array of objects (github_com_pushbits_server_internal_model.AlertmanagerAlert)
object
object
externalURL
string
groupKey
string
object
receiver
string
version
string

Responses

/alert

Request samples

  • Payload
Content type
application/json
{
  • "alerts": [
    • {
      • "annotations": {
        • "property1": "string",
        • "property2": "string"
        },
      • "endsAt": "string",
      • "labels": {
        • "property1": "string",
        • "property2": "string"
        },
      • "startsAt": "string",
      • "status": "string"
      }
    ],
  • "commonAnnotations": {
    • "property1": "string",
    • "property2": "string"
    },
  • "commonLabels": {
    • "property1": "string",
    • "property2": "string"
    },
  • "externalURL": "string",
  • "groupKey": "string",
  • "groupLabels": {
    • "property1": "string",
    • "property2": "string"
    },
  • "receiver": "string",
  • "version": "string"
}

Response samples

  • 200
Content type
application/json
[
  • {
    • "appid": 0,
    • "date": "string",
    • "extras": { },
    • "id": "string",
    • "id_url_encoded": "string",
    • "message": "string",
    • "priority": 0,
    • "title": "string"
    }
]

Application

Get Applications

Get all applications from current user

Authorizations:
BasicAuth

Responses

/application

Response samples

  • 200
Content type
application/json
[
  • {
    • "id": 0,
    • "name": "string",
    • "token": "string"
    }
]

Create Application

Create a new application

Authorizations:
BasicAuth
query Parameters
name
required
string

Name of the application

strict_compatibility
boolean

Use strict compatibility mode

Responses

/application

Response samples

  • 200
Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "token": "string"
}

Delete Application

Delete an application

Authorizations:
BasicAuth
path Parameters
id
required
integer

ID of the application

Responses

/application/{id}

Get Application

Get single application by ID

Authorizations:
BasicAuth
path Parameters
id
required
integer

ID of the application

Responses

/application/{id}

Response samples

  • 200
Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "token": "string"
}

Update Application

Update an application

Authorizations:
BasicAuth
path Parameters
id
required
integer

ID of the application

query Parameters
name
string

New name for the application

refresh_token
boolean

Generate new refresh token for the application

strict_compatibility
boolean

Whether to use strict compataibility mode

Responses

/application/{id}

Create a Notification

Creates a new notification for the given channel

query Parameters
message
required
string

The message to send

title
string

The title to send

priority
integer

The notifications priority

token
required
string

Channels token, can also be provieded in the header

Responses

/message

Response samples

  • 200
Content type
application/json
{
  • "appid": 0,
  • "date": "string",
  • "extras": { },
  • "id": "string",
  • "id_url_encoded": "string",
  • "message": "string",
  • "priority": 0,
  • "title": "string"
}

Delete a Notification

Informs the channel that the notification is deleted

path Parameters
message_id
required
string

ID of the message to delete

query Parameters
token
required
string

Channels token, can also be provieded in the header

Responses

/message/{message_id}

Health

Health of the application

Responses

/health

User

Get Users

Gets a list of all users

Authorizations:
BasicAuth

Responses

/user

Response samples

  • 200
Content type
application/json
[
  • {
    • "id": 0,
    • "is_admin": true,
    • "matrix_id": "string",
    • "name": "string"
    }
]

Create a User

Creates a new user

Authorizations:
BasicAuth
query Parameters
name
required
string

Name of the user

is_admin
boolean

Whether to set the user as admin or not

matrix_id
required
string

Matrix ID of the user in the format @user:domain.tld

password
required
string

The users password

Responses

/user

Response samples

  • 200
Content type
application/json
{
  • "id": 0,
  • "is_admin": true,
  • "matrix_id": "string",
  • "name": "string"
}

Delete User

Delete user

Authorizations:
BasicAuth
path Parameters
id
required
integer

The users id

Responses

/user/{id}

Get User

Gets single user

Authorizations:
BasicAuth
path Parameters
id
required
integer

The users id

Responses

/user/{id}

Response samples

  • 200
Content type
application/json
{
  • "id": 0,
  • "is_admin": true,
  • "matrix_id": "string",
  • "name": "string"
}

Update User

Update user information

Authorizations:
BasicAuth
path Parameters
id
required
integer

The users id

query Parameters
name
required
string

Name of the user

is_admin
boolean

Whether to set the user as admin or not

matrix_id
required
string

Matrix ID of the user in the format @user:domain.tld

password
required
string

The users password

Responses

/user/{id}
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.