> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/backend-api/resources/commons/user/applications/user.md).

# User

API for user applications

## Lists all existing user applications

> Lists all existing user applications.

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"tags":[{"name":"user","description":"API for user applications"}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header","description":"Enter an API key with the \"NVX: \" prefix, e.g. \"NVX 123456abcdefg\""}},"schemas":{"ApplicationListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"},"list":{"type":"array","description":"List of applications","items":{"$ref":"#/components/schemas/Application"}}}},"Application":{"type":"object","required":["id","label","url_template"],"properties":{"id":{"type":"integer","description":"Application's ID"},"label":{"type":"string","description":"Application's name"},"url_template":{"type":"string","description":"URL template (including variables)"},"enabled":{"type":"boolean","description":"Determines visibility in the users' side menu","default":true},"authorization":{"$ref":"#/components/schemas/ApplicationAuthorization","description":"Authorization that will be used while accessing the URL"},"display_method":{"type":"string","description":"Determines how the application will be opened","enum":["new_tab","embedded"],"default":"new_tab"},"icon":{"type":"string","description":"Application's icon identifier","default":"extension"},"description":{"type":"string","description":"Longer plain text description is shown to users","default":""}}},"ApplicationAuthorization":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyAuthorization"},{"$ref":"#/components/schemas/UserSessionAuthorization"}]},"ApiKeyAuthorization":{"type":"object","required":["type","hash"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["api_key"]},"hash":{"type":"string","description":"An API key hash"}}},"UserSessionAuthorization":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["user_session"]}}}}},"paths":{"/user/application/list":{"get":{"tags":["user"],"summary":"Lists all existing user applications","description":"Lists all existing user applications.","operationId":"user_applications_list","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationListResponse"}}}}}}}}}
```

## Creates a new application

> Creates a new application.

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"tags":[{"name":"user","description":"API for user applications"}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header","description":"Enter an API key with the \"NVX: \" prefix, e.g. \"NVX 123456abcdefg\""}},"schemas":{"CreateApplicationRequest":{"type":"object","required":["label","url_template"],"properties":{"label":{"type":"string","description":"Application's name"},"url_template":{"type":"string","description":"URL template (including variables)"},"authorization":{"$ref":"#/components/schemas/ApplicationAuthorization","description":"Authorization that will be used while accessing the URL"},"display_method":{"type":"string","description":"Determines how the application will be opened","enum":["new_tab","embedded"],"default":"new_tab"},"icon":{"type":"string","description":"Application's icon identifier","default":"extension"},"description":{"type":"string","description":"Longer plain text description is shown to users","default":""}}},"ApplicationAuthorization":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyAuthorization"},{"$ref":"#/components/schemas/UserSessionAuthorization"}]},"ApiKeyAuthorization":{"type":"object","required":["type","hash"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["api_key"]},"hash":{"type":"string","description":"An API key hash"}}},"UserSessionAuthorization":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["user_session"]}}},"CreateApplicationResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"},"id":{"type":"integer","description":"Unique ID of the created application"}}}}},"paths":{"/user/application/create":{"post":{"tags":["user"],"summary":"Creates a new application","description":"Creates a new application.","operationId":"user_applications_create","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/CreateApplicationRequest"}},"required":["application"]}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApplicationResponse"}}}}}}}}}
```

## Updates an existing application

> Updates an existing application.

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"tags":[{"name":"user","description":"API for user applications"}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header","description":"Enter an API key with the \"NVX: \" prefix, e.g. \"NVX 123456abcdefg\""}},"schemas":{"Application":{"type":"object","required":["id","label","url_template"],"properties":{"id":{"type":"integer","description":"Application's ID"},"label":{"type":"string","description":"Application's name"},"url_template":{"type":"string","description":"URL template (including variables)"},"enabled":{"type":"boolean","description":"Determines visibility in the users' side menu","default":true},"authorization":{"$ref":"#/components/schemas/ApplicationAuthorization","description":"Authorization that will be used while accessing the URL"},"display_method":{"type":"string","description":"Determines how the application will be opened","enum":["new_tab","embedded"],"default":"new_tab"},"icon":{"type":"string","description":"Application's icon identifier","default":"extension"},"description":{"type":"string","description":"Longer plain text description is shown to users","default":""}}},"ApplicationAuthorization":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyAuthorization"},{"$ref":"#/components/schemas/UserSessionAuthorization"}]},"ApiKeyAuthorization":{"type":"object","required":["type","hash"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["api_key"]},"hash":{"type":"string","description":"An API key hash"}}},"UserSessionAuthorization":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["user_session"]}}},"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"}}},"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation failed status"},"error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"message":{"type":"string","description":"Error message"}}}}}}},"paths":{"/user/application/update":{"post":{"tags":["user"],"summary":"Updates an existing application","description":"Updates an existing application.","operationId":"user_applications_update","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/Application"}},"required":["application"]}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Application not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Deletes a specified application by its unique identifier

> Deletes a specified application by its unique identifier.

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"tags":[{"name":"user","description":"API for user applications"}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header","description":"Enter an API key with the \"NVX: \" prefix, e.g. \"NVX 123456abcdefg\""}},"schemas":{"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"}}},"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation failed status"},"error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"message":{"type":"string","description":"Error message"}}}}}}},"paths":{"/user/application/delete":{"post":{"tags":["user"],"summary":"Deletes a specified application by its unique identifier","description":"Deletes a specified application by its unique identifier.","operationId":"user_applications_delete","parameters":[{"name":"application_id","in":"query","description":"Application's id to delete.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Application not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Toggles application visibility in the side menu

> Toggles application visibility in the side menu.

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"tags":[{"name":"user","description":"API for user applications"}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header","description":"Enter an API key with the \"NVX: \" prefix, e.g. \"NVX 123456abcdefg\""}},"schemas":{"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"}}},"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation failed status"},"error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"message":{"type":"string","description":"Error message"}}}}}}},"paths":{"/user/application/enabled/set":{"post":{"tags":["user"],"summary":"Toggles application visibility in the side menu","description":"Toggles application visibility in the side menu.","operationId":"user_applications_enabled_set","parameters":[{"name":"application_id","in":"query","description":"Application's id to update.","required":true,"schema":{"type":"integer"}},{"name":"enabled","in":"query","description":"State to set.","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Application not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/backend-api/resources/commons/user/applications/user.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.