Desktop File System API Reference

Desktop File System

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

Endpoints

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

List all desktop file system shortcut

Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from the default "web" surface.

Required API key scopes

file_system_shortcut:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/desktop_file_system_shortcut
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_shortcut/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system_shortcut/".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",
      "type": "string",
      "ref": "string",
      "href": "string",
      "order": -2147483648,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create desktop file system shortcut

Required API key scopes

file_system_shortcut:write

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
order
integer

Response

Example request

POST /api/projects/:project_id/desktop_file_system_shortcut
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_shortcut/\
	-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_shortcut/".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",
  "type": "string",
  "ref": "string",
  "href": "string",
  "order": -2147483648,
  "created_at": "2019-08-24T14:15:22Z"
}

Retrieve desktop file system shortcut

Required API key scopes

file_system_shortcut:read

Path parameters

id
string

Response

Example request

GET /api/projects/:project_id/desktop_file_system_shortcut/: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_shortcut/: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_shortcut/{desktop_file_system_shortcut_id}/".format(
        project_id=project_id,
		desktop_file_system_shortcut_id="<the desktop file system shortcut id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "type": "string",
  "ref": "string",
  "href": "string",
  "order": -2147483648,
  "created_at": "2019-08-24T14:15:22Z"
}

Update desktop file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

id
string

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
order
integer

Response

Example request

PATCH /api/projects/:project_id/desktop_file_system_shortcut/: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_shortcut/: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_shortcut/{desktop_file_system_shortcut_id}/".format(
        project_id=project_id,
		desktop_file_system_shortcut_id="<the desktop file system shortcut id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "type": "string",
  "ref": "string",
  "href": "string",
  "order": -2147483648,
  "created_at": "2019-08-24T14:15:22Z"
}

Delete desktop file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/desktop_file_system_shortcut/: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_shortcut/: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_shortcut/{desktop_file_system_shortcut_id}/".format(
        project_id=project_id,
		desktop_file_system_shortcut_id="<the desktop file system shortcut id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Create desktop file system shortcut reorder

Set the display order of the current user's shortcuts. ordered_ids becomes the new top-to-bottom order; any unknown IDs are rejected.

Request parameters

ordered_ids
array

Response

Example request

POST /api/projects/:project_id/desktop_file_system_shortcut/reorder
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_shortcut/reorder/\
	-d ordered_ids="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/desktop_file_system_shortcut/reorder/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"ordered_ids": "array"
	}
).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",
      "type": "string",
      "ref": "string",
      "href": "string",
      "order": -2147483648,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Desktop File System

Endpoints

List all desktop file system shortcut

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create desktop file system shortcut

Required API key scopes

Request parameters

Response

Example request

Example response

Status 201

Retrieve desktop file system shortcut

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update desktop file system shortcut

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete desktop file system shortcut

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Create desktop file system shortcut reorder

Request parameters

Response

Example request

Example response

Status 200

Community questions