Skip to content

API

Jump to bottom
Matthew Faltys edited this page Jul 25, 2016 · 2 revisions

Beacon exposes an api for provisioning id's, updating ip entries, viewing entries, and deleting id's. The following is the specification for endpoints and their protocols.

  • /<beacon id> : GET : endpoint for getting a registered ip
    • example: curl https://beacon.unixvoid.com/unixvoid
  • /provision : POST : endpoint for requesting a new beacon id
    • id : the intended ip
    • example: curl -d id=unixvoid https://beacon.unixvoid.com/provision
    • returns: 200 : client sec, a alphanumeric string for authorizing/removing entries
    • returns: 400 : the client id is already in use
  • /update : POST : endpoint for updating client ip
    • id : registered beacon client id
    • sec : alphanumeric secret associated with registered beacon id
    • address : ip address to be updated to
    • example: curl -d ip=unixvoid -d sec=yQHfXWrUMVDNaHoSkDhRhqG26 -d address=127.0.0.1 https://beacon.unixvoid.com/update
    • returns: 200 : ip updated successfully
    • returns: 403 : client auth invalid
    • returns: 400 : client id does not exist
  • /rotate : POST : endpoint for rotating security token for specified id
    • id : registered beacon client id
    • sec : alphanumeric secret associated with registered beacon id
    • example: curl -d ip=unixvoid -d sec=yQHfXWrUMVDNaHoSkDhRhqG26 https://beacon.unixvoid.com/rotate
    • returns: 200 : new client sec, a alphanumeric string for authorizing/removing entries
    • returns: 403 : client auth invalid
    • returns: 400 : client id does not exist
  • /remove : POST : endpoint for remove a registered beacon id and associating metadata
    • id : registered beacon client id
    • sec : alphanumeric secret associated with registered beacon id
    • example: curl -d ip=unixvoid -d sec=yQHfXWrUMVDNaHoSkDhRhqG26 https://beacon.unixvoid.com/remove
    • returns: 200 : id and metadata removed successfully
    • returns: 403 : client auth invalid
    • returns: 400 : client id does not exist
Clone this wiki locally