File System API Reference

File System

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

Endpoints

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

List all file system shortcut list

Required API key scopes

file_system_shortcut:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

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

Create file system shortcut create

Required API key scopes

file_system_shortcut:write

Path parameters

project_id
string

Request parameters

path
string
type
string
ref
string
href
string

Response

Example request

POST /api/projects/:project_id/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/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}/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",
  "created_at": "2019-08-24T14:15:22Z"
}

Retrieve file system shortcut retrieve

Required API key scopes

file_system_shortcut:read

Path parameters

id
string
project_id
string

Response

Example request

GET /api/projects/:project_id/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/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}/file_system_shortcut/{file_system_shortcut_id}/".format(
        project_id=project_id,
		file_system_shortcut_id="<the 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",
  "created_at": "2019-08-24T14:15:22Z"
}

Update file system shortcut update

Required API key scopes

file_system_shortcut:write

Path parameters

id
string
project_id
string

Request parameters

path
string
type
string
ref
string
href
string

Response

Example request

PATCH /api/projects/:project_id/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/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}/file_system_shortcut/{file_system_shortcut_id}/".format(
        project_id=project_id,
		file_system_shortcut_id="<the 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",
  "created_at": "2019-08-24T14:15:22Z"
}

Delete file system shortcut destroy

Required API key scopes

file_system_shortcut:write

Path parameters

id
string
project_id
string

Example request

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

File System

Endpoints

List all file system shortcut list

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create file system shortcut create

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve file system shortcut retrieve

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update file system shortcut update

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete file system shortcut destroy

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Community questions