App: Upload app

Note: LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method

POST

Path

/qrs/app/upload?name={name}&keepdata={keepdata}&excludeConnections={excludeConnections}

Description

Upload the app (QVF file) included in the request body and store it as {name}.

Note: This can only be done on the central node in a Qlik Sense site.

Header

Content-Type setting for the body: application/vnd.qlik.sense.app or multipart/form-data; boundary=<boundary-string>

Body

QVF file

Return value

App:

{ "customProperties": null, "owner": { "userId": "", "userDirectory": "", "name": "", "id": "00000000-0000-0000-0000-000000000000" }, "name": "", "appId": "", "publishTime": "0001-01-01T00:00:00.000Z", "published": boolean, "tags": [ { "name": "", "id": "00000000-0000-0000-0000-000000000000" }], "stream": { "name": "", "id": "00000000-0000-0000-0000-000000000000" }], "fileSize": "", "privileges": null, "id": "00000000-0000-0000-0000-000000000000" }

Optional parameters

  • {keepdata}: If set to false and the uploaded .qvf file contains app data, the data will be silently discarded. The default value is true.
  • {excludeConnections}: If set to true and the uploaded .qvf file contains any data connections, they will not be imported to the system. The default value is false.

Did this information help you?

Can you tell us why it did not help you and how we can improve it?