File API Reference

File

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

Endpoints

`POST`
`POST`
`POST`
`POST`
`GET`
`POST`
`POST`
`GET`

← Previous page

Create file system count

Get count of all files in a folder.

Required API key scopes

file_system:read

Path parameters

id
string

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/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/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}/file_system/{file_system-2_id}/count/".format(
        project_id=project_id,
		file_system-2_id="<the file system-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Create file system link

Required API key scopes

file_system:write

Path parameters

id
string

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/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/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}/file_system/{file_system-2_id}/link/".format(
        project_id=project_id,
		file_system-2_id="<the file system-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Create file system move

Required API key scopes

file_system:write

Path parameters

id
string

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/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/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}/file_system/{file_system-2_id}/move/".format(
        project_id=project_id,
		file_system-2_id="<the file system-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Create file system count by path

Get count of all files in a folder.

Required API key scopes

file_system:read

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/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/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}/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 file system log view

Required API key scopes

file_system:write

Example request

GET /api/projects/:project_id/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/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}/file_system/log_view/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create file system log view

Required API key scopes

file_system:write

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/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/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}/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 file system undo delete

Required API key scopes

file_system:write

Request parameters

path
string
type
string
ref
stringnull
href
stringnull
meta
shortcut
booleannull

Example request

POST /api/projects/:project_id/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/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}/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 file system unfiled

Required API key scopes

file_system:read

Example request

GET /api/projects/:project_id/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/file_system/unfiled/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/file_system/unfiled/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

← Previous page

File

Endpoints

Create file system count

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create file system link

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create file system move

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create file system count by path

Required API key scopes

Request parameters

Example request

Example response

Status 200 No response body

Retrieve file system log view

Required API key scopes

Example request

Example response

Status 200 No response body

Create file system log view

Required API key scopes

Request parameters

Example request

Example response

Status 200 No response body

Create file system undo delete

Required API key scopes

Request parameters

Example request

Example response

Status 200 No response body

Retrieve file system unfiled

Required API key scopes

Example request

Example response

Status 200 No response body

Community questions