file_system_shortcut

put/api/projects/{project_id}/file_system_shortcut/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/file_system_shortcut/{id}/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this file system shortcut.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

idstring uuid required
pathstring required

Display path of the shortcut in the sidebar.

typestring

Type of the linked item (e.g. 'folder', 'insight'), or blank.

refstring nullable

Reference to the linked item, scoped to its type. Null for href-only shortcuts.

hrefstring nullable

Destination URL the shortcut opens. Null when the shortcut points at an item by ref.

orderinteger

Display order within the user's shortcut list, ascending.

created_atstring date-time required
user_access_levelstring nullable required

Resolved access level the user has for the object this entry references ('none' means the user can't open it). Null when access controls don't apply to the entry type.

Response

idstring uuid required
pathstring required

Display path of the shortcut in the sidebar.

typestring

Type of the linked item (e.g. 'folder', 'insight'), or blank.

refstring nullable

Reference to the linked item, scoped to its type. Null for href-only shortcuts.

hrefstring nullable

Destination URL the shortcut opens. Null when the shortcut points at an item by ref.

orderinteger

Display order within the user's shortcut list, ascending.

created_atstring date-time required
user_access_levelstring nullable required

Resolved access level the user has for the object this entry references ('none' means the user can't open it). Null when access controls don't apply to the entry type.

Changes

No recorded changes to this operation across all 1 revision of this API.