Environments-10
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
Create environments file system link
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Request
POST
/api /environments /: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/environments/:project_id/file_system/:id/link/\-d path="string"
Response
Status 200 No response body
Create environments file system link
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Request
POST
/api /environments /: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/environments/:project_id/file_system/:id/link/\-d path="string"
Response
Status 200 No response body
Create environments file system move
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Request
POST
/api /environments /: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/environments/:project_id/file_system/:id/move/\-d path="string"
Response
Status 200 No response body
Create environments file system move
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Request
POST
/api /environments /: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/environments/:project_id/file_system/:id/move/\-d path="string"
Response
Status 200 No response body
Create environments file system count by path
Get count of all files in a folder.
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Request
POST
/api /environments /: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/environments/:project_id/file_system/count_by_path/\-d path="string"
Response
Status 200 No response body
Create environments file system count by path
Get count of all files in a folder.
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Request
POST
/api /environments /: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/environments/:project_id/file_system/count_by_path/\-d path="string"
Response
Status 200 No response body
Retrieve environments file system unfiled
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request
GET
/api /environments /: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/environments/:project_id/file_system/unfiled/
Response
Status 200 No response body
Retrieve environments file system unfiled
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request
GET
/api /environments /: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/environments/:project_id/file_system/unfiled/
Response
Status 200 No response body
List all environments file system shortcut
Required API key scopes
file_system_shortcut:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Request
GET
/api /environments /: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/environments/:project_id/file_system_shortcut/
Response
Status 200
{"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"}]}
List all environments file system shortcut
Required API key scopes
file_system_shortcut:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Request
GET
/api /environments /: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/environments/:project_id/file_system_shortcut/
Response
Status 200
{"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
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
Response
Request
POST
/api /environments /: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/environments/:project_id/file_system_shortcut/\-d path="string"
Response
Status 201
{"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
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
Response
Request
POST
/api /environments /: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/environments/:project_id/file_system_shortcut/\-d path="string"
Response
Status 201
{"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
- idstring
A UUID string identifying this file system shortcut.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Request
GET
/api /environments /: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/environments/:project_id/file_system_shortcut/:id/
Response
Status 200
{"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
- idstring
A UUID string identifying this file system shortcut.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Request
GET
/api /environments /: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/environments/:project_id/file_system_shortcut/:id/
Response
Status 200
{"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
- idstring
A UUID string identifying this file system shortcut.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
Response
Request
PATCH
/api /environments /: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/environments/:project_id/file_system_shortcut/:id/\-d path="string"
Response
Status 200
{"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
- idstring
A UUID string identifying this file system shortcut.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
Response
Request
PATCH
/api /environments /: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/environments/:project_id/file_system_shortcut/:id/\-d path="string"
Response
Status 200
{"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
- idstring
A UUID string identifying this file system shortcut.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request
DELETE
/api /environments /: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/environments/:project_id/file_system_shortcut/:id/
Response
Status 204 No response body
Delete environments file system shortcut
Required API key scopes
file_system_shortcut:write
Path parameters
- idstring
A UUID string identifying this file system shortcut.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request
DELETE
/api /environments /: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/environments/:project_id/file_system_shortcut/:id/