Oxide API - fullphat/snarl_network_protocol GitHub Wiki
Services
Oxide provides a series of services that manage individual features of Snarl. Each service forms the root of a specific endpoint after the /v2/ version identifier. The following services are defined:
| Service | Description |
|---|---|
/registrations |
Manages application registrations |
/events |
Manages event creations and deletions |
/notifications |
Manages notifications |
/info |
Returns information about the running instance of Snarl |
Content Objects
Content objects are included in the body of requests.
| Name | Description |
|---|---|
EventContent |
Provides information about a single event to be added or updated |
NotificationContent |
Info Objects
Info objects are returned in the response body.
| Name | Description |
|---|---|
EventInfo |
Provides information about a particular event class |