Admin Application API

Endpoint	Method	Description
/jsonRpc/application.listDefaultApplications	jsonRpc	List default applications
/jsonRpc/application.setDefaultApplication	jsonRpc	Set default application
/jsonRpc/application.removeDefaultApplication	jsonRpc	Remove default application
/jsonRpc/application.searchPublishedApplicationsInNetwork	jsonRpc	Search published applications in network

List default applications

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/application.listDefaultApplications

Permissions:

application.release

Request:

{ empty }

Response:

{
    "data": {
        "applications": [{
            "networkId": string
            "category": string
            "application": {
                "applicationId": string
                "version": string
                "name": string
                "description": string
                "customParams": map[string]{ custom structure }  // client-defined data from the released version: icons, client/interface settings, permissions, etc
                "networks": [ string ]  // ['all'] or specific network ids the app is published in
                "excludedNetworks": [ string ]  // excluded network ids, only meaningful alongside 'all'
                "publishedAt": timestamp
            }
        }]
    }
    "error": { "status": bool, "code": int, "message": string }
}

Set default application

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/application.setDefaultApplication

Permissions:

application.release

Request:

{
    "networkId": string
    "category": string  // app/auth; defaults to 'app'
    "applicationId": string
}

Response:

{
    "data": {
        "networkId": string
        "category": string
        "applicationId": string
        "updated": timestamp
    }
    "error": { "status": bool, "code": int, "message": string }
}

Remove default application

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/application.removeDefaultApplication

Permissions:

application.release

Request:

{
    "networkId": string
    "category": string  // app/auth; defaults to 'app'
}

Response:

{ empty }

Search published applications in network

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/application.searchPublishedApplicationsInNetwork

Request:

{
    "networkId": string
    "query": string  // case-insensitive substring match against the application name; empty matches everything
    "cursor": string  // pagination cursor; omit for the first page, otherwise pass back the previous response's NextCursor
    "limit": int  // page size; omit for the default
}

Response:

{
    "data": {
        "applications": [{
            "applicationId": string
            "version": string
            "name": string
            "description": string
            "customParams": map[string]{ custom structure }  // client-defined data from the released version: icons, client/interface settings, permissions, etc
            "networks": [ string ]  // ['all'] or specific network ids the app is published in
            "excludedNetworks": [ string ]  // excluded network ids, only meaningful alongside 'all'
            "publishedAt": timestamp
        }]
        "nextCursor": string  // opaque; pass back as Cursor to fetch the next page. Empty means no more results
    }
    "error": { "status": bool, "code": int, "message": string }
}