ript>

Documentation

This page contains a list of all API functions.
All API functions accept and return only JSON unless otherwise specified in the documentation.

api_token

URL endpoint: /api/<token_id>

Manipulate a token.
GET:
    Gets the current token data.
    Return:
        Object of {id, active, identity}
POST:
    Change one or more of the token's data fields.
    The id cannot be set, but it can be forced to change, sending any value other than the current id, including null.
    Return:
        See GET.
    Error:
        If new identity would be a duplicate:
            409 "Conflict"
DELETE:
    Delete the token and all links owned by it.
    *Active session is required.*
    Returns:
        True
PUT:
    Make new links owned by this token.
    Input:
        Array of strings (URLs)
    Return:
        Array of URL ids
        If a URL is invalid, the returned id will be null.

api_link

URL endpoint: /api/<token_id>/<link_id>

Manipulate a link.
GET:
    Gets the current link data.
    Return:
        Object of {id, active, url, identity}
        identity = identity of the owner token
POST:
    Change one or more of the links's data fields.
    The id or identity cannot be changed. Sending them will be ignored.
    Return:
        See GET.
DELETE:
    Delete the link.
    Return:
        True