User

API for user applications

Lists all existing user applications

get

https://api.eu.navixy.com/v2https://api.us.navixy.com/v2

/user/application/list

Lists all existing user applications.

Authorizations

Authorization

AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Responses

200

Successful operation

application/json

get

/user/application/list

HTTPcURLJavaScriptPython

GET /v2/user/application/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful operation

{
  "success": true,
  "list": [
    {
      "id": 221,
      "label": "An application",
      "url_template": "https://domain.example/{language}",
      "enabled": true,
      "authorization": {
        "type": "user_session"
      },
      "display_method": "new_tab",
      "icon": "extension",
      "description": "A description"
    }
  ]
}

Creates a new application

post

https://api.eu.navixy.com/v2https://api.us.navixy.com/v2

/user/application/create

Creates a new application.

Authorizations

Authorization

AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Body

application/json

Responses

200

Successful operation

application/json

post

/user/application/create

HTTPcURLJavaScriptPython

POST /v2/user/application/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "application": {
    "label": "text",
    "url_template": "text",
    "authorization": {
      "type": "api_key",
      "hash": "text"
    },
    "display_method": "new_tab",
    "icon": "extension",
    "description": ""
  }
}

200

Successful operation

{
  "success": true,
  "id": 779
}

Updates an existing application

post

https://api.eu.navixy.com/v2https://api.us.navixy.com/v2

/user/application/update

Updates an existing application.

Authorizations

Authorization

AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Body

application/json

Responses

200

Successful operation

application/json

400

Application not found

application/json

post

/user/application/update

HTTPcURLJavaScriptPython

POST /v2/user/application/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "application": {
    "id": 1,
    "label": "text",
    "url_template": "text",
    "enabled": true,
    "authorization": {
      "type": "api_key",
      "hash": "text"
    },
    "display_method": "new_tab",
    "icon": "extension",
    "description": ""
  }
}

{
  "success": true
}

Deletes a specified application by its unique identifier

post

https://api.eu.navixy.com/v2https://api.us.navixy.com/v2

/user/application/delete

Deletes a specified application by its unique identifier.

Authorizations

Authorization

AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Query parameters

application_idintegerRequired

Application's id to delete.

Responses

200

Successful operation

application/json

400

Application not found

application/json

post

/user/application/delete

HTTPcURLJavaScriptPython

POST /v2/user/application/delete?application_id=1 HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Toggles application visibility in the side menu

post

https://api.eu.navixy.com/v2https://api.us.navixy.com/v2

/user/application/enabled/set

Toggles application visibility in the side menu.

Authorizations

Authorization

AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Query parameters

application_idintegerRequired

Application's id to update.

enabledbooleanRequired

State to set.

Responses

200

Successful operation

application/json

400

Application not found

application/json

post

/user/application/enabled/set

HTTPcURLJavaScriptPython

POST /v2/user/application/enabled/set?application_id=1&enabled=true HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true
}