File System

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

Endpoints

GET
POST
GET
PATCH
DELETE
GET
POST
GET
PATCH
DELETE

List all environments file system shortcut

Required API key scopes

file_system_shortcut:read

Path parameters

  • environment_id
    string

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/environments/:environment_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/environments/:environment_id/file_system_shortcut/

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 environments file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

  • environment_id
    string

Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string

Response


Example request

POST /api/environments/:environment_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/environments/:environment_id/file_system_shortcut/\
-d path="string"

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 environments file system shortcut

Required API key scopes

file_system_shortcut:read

Path parameters

  • environment_id
    string
  • id
    string

Response


Example request

GET /api/environments/:environment_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/environments/:environment_id/file_system_shortcut/:id/

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 environments file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

  • environment_id
    string
  • id
    string

Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string

Response


Example request

PATCH /api/environments/:environment_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/environments/:environment_id/file_system_shortcut/:id/\
-d path="string"

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 environments file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

  • environment_id
    string
  • id
    string

Example request

DELETE /api/environments/:environment_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/environments/:environment_id/file_system_shortcut/:id/

Example response

Status 204 No response body

List all file system shortcut

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/

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

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"

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

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/

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

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"

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

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/

Example response

Status 204 No response body

Community questions

Questions about this page? or post a community question.