Desktop File API Reference

Desktop File

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`GET`
`POST`
`GET`
`PATCH`
`DELETE`
`POST`
`POST`
`POST`
`POST`
`GET`
`POST`
`POST`
`GET`

List all desktop file system

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Required API key scopes

file_system:read

Query parameters

limit
integer
offset
integer
search
string

Response

Example request

GET /api/projects/:project_id/desktop_file_system
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "path": "string",
      "depth": 0,
      "type": "string",
      "ref": "string",
      "href": "string",
      "meta": null,
      "shortcut": true,
      "created_at": "2019-08-24T14:15:22Z",
      "last_viewed_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create desktop file system

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Required API key scopes

file_system:write

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Response

Example request

POST /api/projects/:project_id/desktop_file_system
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "depth": 0,
  "type": "string",
  "ref": "string",
  "href": "string",
  "meta": null,
  "shortcut": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z"
}

Retrieve desktop file system

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Required API key scopes

file_system:read

Path parameters

id
string

Response

Example request

GET /api/projects/:project_id/desktop_file_system/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/{desktop_file_system_id}/".format(
        project_id=project_id,
		desktop_file_system_id="<the desktop file system id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "depth": 0,
  "type": "string",
  "ref": "string",
  "href": "string",
  "meta": null,
  "shortcut": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z"
}

Update desktop file system

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Required API key scopes

file_system:write

Path parameters

id
string

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Response

Example request

PATCH /api/projects/:project_id/desktop_file_system/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/:id/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/{desktop_file_system_id}/".format(
        project_id=project_id,
		desktop_file_system_id="<the desktop file system id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "depth": 0,
  "type": "string",
  "ref": "string",
  "href": "string",
  "meta": null,
  "shortcut": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z"
}

Delete desktop file system

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Required API key scopes

file_system:write

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/desktop_file_system/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/{desktop_file_system_id}/".format(
        project_id=project_id,
		desktop_file_system_id="<the desktop file system id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Create desktop file system count

Get count of all files in a folder.

Path parameters

id
string

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/desktop_file_system/:id/count
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/:id/count/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/{desktop_file_system_id}/count/".format(
        project_id=project_id,
		desktop_file_system_id="<the desktop file system id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Create desktop file system link

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Path parameters

id
string

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/desktop_file_system/:id/link
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/:id/link/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/{desktop_file_system_id}/link/".format(
        project_id=project_id,
		desktop_file_system_id="<the desktop file system id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Create desktop file system move

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Path parameters

id
string

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/desktop_file_system/:id/move
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/:id/move/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/{desktop_file_system_id}/move/".format(
        project_id=project_id,
		desktop_file_system_id="<the desktop file system id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Create desktop file system count by path

Get count of all files in a folder.

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/desktop_file_system/count_by_path
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/count_by_path/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/count_by_path/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve desktop file system log view

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Example request

GET /api/projects/:project_id/desktop_file_system/log_view
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/log_view/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/log_view/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create desktop file system log view

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/desktop_file_system/log_view
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/log_view/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/log_view/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Create desktop file system undo delete

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/desktop_file_system/undo_delete
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/undo_delete/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/undo_delete/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve desktop file system unfiled

The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.

Example request

GET /api/projects/:project_id/desktop_file_system/unfiled
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_file_system/unfiled/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system/unfiled/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Desktop File

Endpoints

List all desktop file system

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create desktop file system

Required API key scopes

Request parameters

Response

Example request

Example response

Status 201

Retrieve desktop file system

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update desktop file system

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete desktop file system

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Create desktop file system count

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create desktop file system link

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create desktop file system move

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create desktop file system count by path

Request parameters

Example request

Example response

Status 200 No response body

Retrieve desktop file system log view

Example request

Example response

Status 200 No response body

Create desktop file system log view

Request parameters

Example request

Example response

Status 200 No response body

Create desktop file system undo delete

Request parameters

Example request

Example response

Status 200 No response body

Retrieve desktop file system unfiled

Example request

Example response

Status 200 No response body

Community questions