Data files represent the flat file storage associated with spaces in your Qlik Cloud tenant. Each space will have a corresponding data files connection, which you can list with data-connections.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/data-files-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"info": {
"title": "data-files",
"version": ""
},
"paths": {
"/api/v1/data-files": {
"get": {
"tags": [
"datafiles"
],
"summary": "Get descriptive info for the specified data files.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDataFileInfosResponse"
}
}
},
"description": "The file list was retrieved."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad Request"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Forbidden"
}
},
"parameters": [
{
"in": "query",
"name": "allowInternalFiles",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false,
"description": "If set to false, do not return data files with internal extensions else return all the data files."
},
{
"in": "query",
"name": "appId",
"schema": {
"type": "string",
"example": "f34b91a1-0dc3-44ac-a847-51cb84122c84",
"nullable": true
},
"example": "f34b91a1-0dc3-44ac-a847-51cb84122c84",
"description": "Only return files scoped to the specified app. If this parameter is not specified, only files that are not\nscoped to any app are returned. \"*\" implies all app-scoped files are returned."
},
{
"in": "query",
"name": "baseNameWildcard",
"schema": {
"type": "string",
"example": "*SomeFileName*",
"nullable": true
},
"example": "*SomeFileName*",
"description": "If present, return only items whose base name matches the given wildcard. Wildcards include '*' and '?'\ncharacters to allow for multiple matches. The base name is the actual file or folder name without any\nfolder pathing included."
},
{
"in": "query",
"name": "connectionId",
"schema": {
"type": "string",
"format": "uuid",
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"nullable": true
},
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"description": "Return files and folders that reside in the space referenced by the specified DataFiles connection. If this\nparameter is not specified, the user's personal space is implied."
},
{
"in": "query",
"name": "excludeFiles",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false,
"description": "If set to true, exclude files in the returned list (IE, only return folders). If false, include files."
},
{
"in": "query",
"name": "excludeSubFolders",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false,
"description": "If set to true, exclude folders and files that reside in sub-folders of the root being searched. If false,\ninclude all items in full folder hierarchy that recursively reside under the root. That is, setting to\ntrue results in only the direct children of the root being returned."
},
{
"in": "query",
"name": "folderId",
"schema": {
"type": "string",
"format": "uuid",
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"nullable": true
},
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"description": "If present, return only items which reside under the folder specified by the given ID. If not present,\nitems that live at the root of the space are returned. This property is mutually exclusive with 'folderPath'."
},
{
"in": "query",
"name": "folderPath",
"schema": {
"type": "string",
"example": "some/folder",
"nullable": true
},
"example": "some/folder",
"description": "If present, return only items which reside under the specified folder path. If not present, items that\nlive at the root of the space are returned. This property is mutually exclusive with 'folderId'."
},
{
"in": "query",
"name": "includeAllSpaces",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false,
"description": "If set to true, and connectionId is not specified, return files and folders from all spaces the given user\nhas access to (including the personal space). If connectionId is specified, this parameter is ignored."
},
{
"in": "query",
"name": "includeFolders",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false,
"description": "If set to true, include folders in the returned list. If false, only return data files."
},
{
"in": "query",
"name": "includeFolderStats",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false,
"description": "If set to true, include computed folder statistics for folders in the returned list. If false, this information\nis not returned."
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32",
"default": 20,
"example": 5,
"maximum": 1000,
"minimum": 1
},
"example": 5,
"description": "If present, the maximum number of data files to return."
},
{
"in": "query",
"name": "name",
"schema": {
"type": "string",
"example": "MyFile.csv",
"nullable": true
},
"example": "MyFile.csv",
"description": "Filter the list of files returned to the given file name."
},
{
"in": "query",
"name": "notOwnerId",
"schema": {
"type": "string",
"example": "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
"nullable": true
},
"example": "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
"description": "If present, fetch the data files whose owner is not the specified owner. If a connectionId is specified in\nthis case, the returned list is constrained to the specified space. If connectionId is not specified, then\nthe returned list is constrained to the calling user's personal space. If includeAllSpaces is set to true,\nand connectionId is not specified, the returned list is from all spaces the given user\nhas access to (including the personal space)."
},
{
"in": "query",
"name": "ownerId",
"schema": {
"type": "string",
"example": "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
"nullable": true
},
"example": "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
"description": "If present, fetch the data files for the specified owner. If a connectionId is specified in this case, the\nreturned list is constrained to the specified space. If connectionId is not specified, then all files owned\nby the specified user are returned regardless of the personal space that a given file resides in."
},
{
"in": "query",
"name": "page",
"schema": {
"type": "string",
"example": "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1",
"nullable": true
},
"example": "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1",
"description": "If present, the cursor that starts the page of data that is returned."
},
{
"in": "query",
"name": "sort",
"schema": {
"$ref": "#/components/schemas/GetDataFileInfosSortField"
},
"description": "The name of the field used to sort the result. By default, the sort order is ascending. Putting a '+' prefix on\nthe sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order."
}
],
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"datafiles"
],
"summary": "Upload a new data file or create a new folder.",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataFileUploadResponse"
}
}
},
"description": "New file or folder was created."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad Request"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Forbidden"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "A file or folder with the same name already exists in the specified user or app scope."
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The file exceeds the user's quota for maximum file size to upload."
},
"423": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The file is already locked for read or write by another client."
},
"501": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Not Implemented"
}
},
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"Json.Name"
],
"properties": {
"File": {
"type": "string",
"format": "binary",
"nullable": true,
"description": "IFormFile form multipart/form-data"
},
"Json": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "some/folder/MyFile.csv",
"pattern": "^[^<>\":\\u0000|?*]+$",
"description": "Name that will be given to the file or folder. It should be noted that the '/' character\nin the name indicates a 'path' separator in a logical folder hierarchy for the name. Names that\ncontain '/'s should be used with the assumption that a logical 'folder hierarchy' is being defined for the\nfull pathname of that file or folder. IE, a '/' is a significant character in the name."
},
"appId": {
"type": "string",
"example": "f34b91a1-0dc3-44ac-a847-51cb84122c84",
"nullable": true,
"description": "If this file should be bound to the lifecycle of a specific app, this is the ID of this app. If this\nrequest is creating a folder, the specification of an app ID is not allowed."
},
"folder": {
"type": "boolean",
"default": false,
"description": "If true, a folder will be created. If false, a file is created."
},
"folderId": {
"type": "string",
"format": "uuid",
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"nullable": true,
"description": "If the specified file or folder should be moved to become a a sub-item of an existing folder, this is the ID\nof this parent folder. Any additional folder path that is present on the Name property will be created\nas a subfolder hierarchy of this folder. If the FolderID is null, the file or folder specified in the\nName property (including any folder prefix on that name), will be created in the root of the space."
},
"sourceId": {
"type": "string",
"format": "uuid",
"example": "f34b91a1-0dc3-44ac-a847-51cb84122c84",
"nullable": true,
"description": "If a SourceId is specified, this is the ID of the existing data file or folder whose content should be copied\ninto the specified data file or folder. That is, for a file instead of the file content being specified in\nthe Data element, it is effectively copied from an existing, previously uploaded file. For a folder, rather\nthan the new folder being empty, it's contents are copied from an existing, previously created folder."
},
"connectionId": {
"type": "string",
"format": "uuid",
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"nullable": true,
"description": "If present, this is the DataFiles connection that the upload should occur in the context of. If absent,\nthe default is that the upload will occur in the context of the Personal Space DataFiles connection. If the\nDataFiles connection is different from the one specified when the file or folder was last POSTed or PUT, this\nwill result in a logical move of this file or folder into the new space."
},
"tempContentFileId": {
"type": "string",
"example": "624b0f54459f1c00018dade4",
"nullable": true,
"description": "If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose\ncontent should be copied into the specified data file. That is, instead of the file content being specified\nin the Data element, it is effectively copied from an existing, previously uploaded file. The expectation\nis that this file was previously uploaded to the temporary content service, and the ID specified here is\nthe one returned from the temp content upload request. This option does not apply when POSTing a folder."
}
},
"description": "See PostDataFileRequest schema which defines request structure.\n See PostDataFileRequest model.",
"additionalProperties": false
}
}
},
"encoding": {
"File": {
"style": "form"
},
"Json": {
"explode": false,
"contentType": "application/json"
}
}
}
}
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-files/{id}": {
"get": {
"tags": [
"datafiles"
],
"summary": "Get descriptive info for the specified data file.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataFileUploadResponse"
}
}
},
"description": "The file was located."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad Request"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "A data file with the specified ID was not found."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"required": true,
"description": "The ID of the data file."
}
],
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"put": {
"tags": [
"datafiles"
],
"summary": "Re-upload an existing data file or update an existing folder.",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataFileUploadResponse"
}
}
},
"description": "The file or folder was updated."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad Request"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "A data file or folder with the specified ID was not found."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If the file or folder was renamed during the update, a file or folder with the new name\n already exists. Also, if the space that the file or folder resides in was changed as part of the update,\n a file or folder with the same name already resides in the new space."
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The file exceeds the user's quota for maximum file size to upload."
},
"423": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The file is already locked for read or write by another client. If a folder is being\n updated, then if any file or folder in the subfolder hierarchy of this folder is already locked for write."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"required": true,
"description": "The ID of the data file to update."
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary",
"nullable": true,
"description": "IFormFile form multipart/form-data"
},
"Json": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "some/folder/MyFile.csv",
"pattern": "^[^<>\":\\u0000|?*]+$",
"nullable": true,
"description": "Name that will be given to the file or folder. If this name is different than the name used when the file\nor folder was last POSTed or PUT, this will result in a rename of the file or folder. It should be noted\nthat the '/' character in a data file name indicates a 'path' separator in a logical folder hierarchy for\nthe name. Names that contain '/'s should be used with the assumption that a logical 'folder hierarchy' is\nbeing defined for the full pathname of that file or folder.. '/' is a significant character in the data file\nor folder name."
},
"appId": {
"type": "string",
"example": "f34b91a1-0dc3-44ac-a847-51cb84122c84",
"nullable": true,
"description": "If this file should be bound to the lifecycle of a specific app, this is the ID of this app. If this\nrequest is creating a folder, the specification of an app ID is not allowed."
},
"folderId": {
"type": "string",
"format": "uuid",
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"nullable": true,
"description": "If the specified file or folder should be created as a sub-item of an existing folder, this is the ID\nof this parent folder. Any additional folder path that is present on the Name property will be created\nas a subfolder hierarchy of this folder. If the FolderID is null, the file or folder specified in the\nName property (including any folder prefix on that name), will be created in the root of the space."
},
"sourceId": {
"type": "string",
"format": "uuid",
"example": "f34b91a1-0dc3-44ac-a847-51cb84122c84",
"nullable": true,
"description": "If a SourceId is specified, this is the ID of the existing data file or folder whose content should be copied\ninto the specified data file or folder. That is, for a file instead of the file content being specified in\nthe Data element, it is effectively copied from an existing, previously uploaded file. For a folder, it's\ncontents are copied from an existing, previously created folder. If there it existing content in the target\nfolder, then how the source and target folder contents are merged together is specified in the\nFolderMergeBehavior option."
},
"connectionId": {
"type": "string",
"format": "uuid",
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"nullable": true,
"description": "If present, this is the DataFiles connection points to the space that the file or folder should reside in.\nIf absent, the default is that the file or folder will reside in the Personal SPce. If the DataFiles\nconnection is different from the one specified when the file or folder was last POSTed or PUT, this will\nresult in a logical move of this file or folder into the new space."
},
"tempContentFileId": {
"type": "string",
"example": "624b0f54459f1c00018dade4",
"nullable": true,
"description": "If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose\ncontent should be copied into the specified data file. That is, instead of the file content being specified\nin the Data element, it is effectively copied from an existing, previously uploaded file. The expectation\nis that this file was previously uploaded to the temporary content service, and the ID specified here is\nthe one returned from the temp content upload request."
},
"folderMergeBehavior": {
"$ref": "#/components/schemas/PutDataFileFolderMergeBehavior"
}
},
"description": "See PutDataFileRequest schema which defines request structure.\n See PutDataFileRequest model.",
"additionalProperties": false
}
}
},
"encoding": {
"File": {
"style": "form"
},
"Json": {
"explode": false,
"contentType": "application/json"
}
}
}
}
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "special",
"limit": 800
}
},
"delete": {
"tags": [
"datafiles"
],
"summary": "Delete the specified data file or folder. Deleting a folder will also recursively delete all files and\nsubfolders that reside within the specified folder.",
"responses": {
"204": {
"description": "The file or folder was deleted."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad Request"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "A data file or folder with the specified ID was not found."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"example": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"required": true,
"description": "The ID of the data file or folder to delete."
}
],
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-files/{id}/actions/change-owner": {
"post": {
"tags": [
"datafiles"
],
"summary": "Change the owner of an existing data file or folder.",
"responses": {
"204": {
"description": "The file or folder's owner was changed."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "An owner with the specified ID does not exist."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The user does not have permission to modify the specified data file or folder, or if the\n item does not reside in the root of the space."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "A data file or folder with the specified ID was not found."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If the file or folder is in a personal space, and the personal space of the new owner\n already has an item in the space with the same name as the item being moved."
},
"423": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The file or folder is already locked for write by another client. For folders, any\n write lock on a subfolder or file underneath this folder implies a lock on the folder."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema
# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-data-files.json