Environments-9
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
Create environments exports
Required API key scopes
export: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
- dashboardinteger
- insightinteger
- export_format
- export_context
- expires_afterstring
Response
Request
POST
/api /environments /:project_id /exports
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/exports/\-d export_format=undefined
Response
Status 201
{"id": 0,"dashboard": 0,"insight": 0,"export_format": "image/png","created_at": "2019-08-24T14:15:22Z","has_content": "string","export_context": null,"filename": "string","expires_after": "2019-08-24T14:15:22Z","exception": "string"}
Create environments exports
Required API key scopes
export: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
- dashboardinteger
- insightinteger
- export_format
- export_context
- expires_afterstring
Response
Request
POST
/api /environments /:project_id /exports
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/exports/\-d export_format=undefined
Response
Status 201
{"id": 0,"dashboard": 0,"insight": 0,"export_format": "image/png","created_at": "2019-08-24T14:15:22Z","has_content": "string","export_context": null,"filename": "string","expires_after": "2019-08-24T14:15:22Z","exception": "string"}
Retrieve environments exports
Required API key scopes
export:read
Path parameters
- idinteger
A unique integer value identifying this exported asset.
- 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 /exports /: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/exports/:id/
Response
Status 200
{"id": 0,"dashboard": 0,"insight": 0,"export_format": "image/png","created_at": "2019-08-24T14:15:22Z","has_content": "string","export_context": null,"filename": "string","expires_after": "2019-08-24T14:15:22Z","exception": "string"}
Retrieve environments exports
Required API key scopes
export:read
Path parameters
- idinteger
A unique integer value identifying this exported asset.
- 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 /exports /: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/exports/:id/
Response
Status 200
{"id": 0,"dashboard": 0,"insight": 0,"export_format": "image/png","created_at": "2019-08-24T14:15:22Z","has_content": "string","export_context": null,"filename": "string","expires_after": "2019-08-24T14:15:22Z","exception": "string"}
Retrieve environments exports content
Required API key scopes
export:read
Path parameters
- idinteger
A unique integer value identifying this exported asset.
- 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 /exports /:id /content
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/exports/:id/content/
Response
Status 200 No response body
Retrieve environments exports content
Required API key scopes
export:read
Path parameters
- idinteger
A unique integer value identifying this exported asset.
- 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 /exports /:id /content
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/exports/:id/content/
Response
Status 200 No response body
List all environments file system
Required API key scopes
file_system: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.
- searchstring
A search term.
Response
Request
GET
/api /environments /:project_id /file_system
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/
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","depth": 0,"type": "string","ref": "string","href": "string","meta": null,"shortcut": true,"created_at": "2019-08-24T14:15:22Z"}]}
List all environments file system
Required API key scopes
file_system: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.
- searchstring
A search term.
Response
Request
GET
/api /environments /:project_id /file_system
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/
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","depth": 0,"type": "string","ref": "string","href": "string","meta": null,"shortcut": true,"created_at": "2019-08-24T14:15:22Z"}]}
Create environments file system
Required API key scopes
file_system: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
- meta
- shortcutboolean
Response
Request
POST
/api /environments /:project_id /file_system
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/\-d path="string"
Response
Status 201
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","path": "string","depth": 0,"type": "string","ref": "string","href": "string","meta": null,"shortcut": true,"created_at": "2019-08-24T14:15:22Z"}
Create environments file system
Required API key scopes
file_system: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
- meta
- shortcutboolean
Response
Request
POST
/api /environments /:project_id /file_system
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/\-d path="string"
Response
Status 201
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","path": "string","depth": 0,"type": "string","ref": "string","href": "string","meta": null,"shortcut": true,"created_at": "2019-08-24T14:15:22Z"}
Retrieve environments file system
Required API key scopes
file_system:read
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/.
Response
Request
GET
/api /environments /:project_id /file_system /: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/:id/
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","path": "string","depth": 0,"type": "string","ref": "string","href": "string","meta": null,"shortcut": true,"created_at": "2019-08-24T14:15:22Z"}
Retrieve environments file system
Required API key scopes
file_system:read
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/.
Response
Request
GET
/api /environments /:project_id /file_system /: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/:id/
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","path": "string","depth": 0,"type": "string","ref": "string","href": "string","meta": null,"shortcut": true,"created_at": "2019-08-24T14:15:22Z"}
Update environments file system
Required API key scopes
file_system:write
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
Response
Request
PATCH
/api /environments /:project_id /file_system /: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/:id/\-d path="string"
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","path": "string","depth": 0,"type": "string","ref": "string","href": "string","meta": null,"shortcut": true,"created_at": "2019-08-24T14:15:22Z"}
Update environments file system
Required API key scopes
file_system:write
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
Response
Request
PATCH
/api /environments /:project_id /file_system /: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/:id/\-d path="string"
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","path": "string","depth": 0,"type": "string","ref": "string","href": "string","meta": null,"shortcut": true,"created_at": "2019-08-24T14:15:22Z"}
Delete environments file system
Required API key scopes
file_system:write
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
DELETE
/api /environments /:project_id /file_system /: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/:id/
Response
Status 204 No response body
Delete environments file system
Required API key scopes
file_system:write
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
DELETE
/api /environments /:project_id /file_system /: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/:id/
Response
Status 204 No response body
Create environments file system count
Get count of all files in a folder.
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 /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/environments/:project_id/file_system/:id/count/\-d path="string"
Response
Status 200 No response body
Create environments file system count
Get count of all files in a folder.
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 /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/environments/:project_id/file_system/:id/count/\-d path="string"