Environments-13

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

Endpoints

GET
POST
GET
GET
GET
POST
GET
PATCH
DELETE

List all environments exports

Required API key scopes

export:read

Path parameters

  • project_id
    string

    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

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.


Response


Example request

GET /api/environments/:project_id/exports
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/

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": 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"
}
]
}

List all environments exports

Required API key scopes

export:read

Path parameters

  • project_id
    string

    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

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.


Response


Example request

GET /api/environments/:project_id/exports
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/

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": 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_id
    string

    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

  • dashboard
    integer
  • insight
    integer
  • export_format
  • export_context
  • expires_after
    string

Response


Example 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

Example response

Status 201
RESPONSE
{
"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_id
    string

    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

  • dashboard
    integer
  • insight
    integer
  • export_format
  • export_context
  • expires_after
    string

Response


Example 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

Example response

Status 201
RESPONSE
{
"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

  • id
    integer

    A unique integer value identifying this exported asset.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.


Response


Example 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/

Example response

Status 200
RESPONSE
{
"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

  • id
    integer

    A unique integer value identifying this exported asset.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.


Response


Example 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/

Example response

Status 200
RESPONSE
{
"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

  • id
    integer

    A unique integer value identifying this exported asset.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.


Example 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/

Example response

Status 200 No response body

Retrieve environments exports content

Required API key scopes

export:read

Path parameters

  • id
    integer

    A unique integer value identifying this exported asset.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.


Example 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/

Example response

Status 200 No response body

List all environments file system

Required API key scopes

file_system:read

Path parameters

  • project_id
    string

    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

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

  • search
    string

    A search term.


Response


Example 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/

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",
"depth": 0,
"type": "string",
"ref": "string",
"href": "string",
"meta": null,
"shortcut": true,
"created_at": "2019-08-24T14:15:22Z",
"last_viewed_at": "2019-08-24T14:15:22Z"
}
]
}

List all environments file system

Required API key scopes

file_system:read

Path parameters

  • project_id
    string

    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

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

  • search
    string

    A search term.


Response


Example 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/

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",
"depth": 0,
"type": "string",
"ref": "string",
"href": "string",
"meta": null,
"shortcut": true,
"created_at": "2019-08-24T14:15:22Z",
"last_viewed_at": "2019-08-24T14:15:22Z"
}
]
}

Create environments file system

Required API key scopes

file_system:write

Path parameters

  • project_id
    string

    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

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Response


Example 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"

Example response

Status 201
RESPONSE
{
"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",
"last_viewed_at": "2019-08-24T14:15:22Z"
}

Create environments file system

Required API key scopes

file_system:write

Path parameters

  • project_id
    string

    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

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Response


Example 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"

Example response

Status 201
RESPONSE
{
"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",
"last_viewed_at": "2019-08-24T14:15:22Z"
}

Retrieve environments file system

Required API key scopes

file_system:read

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.


Response


Example 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/

Example response

Status 200
RESPONSE
{
"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",
"last_viewed_at": "2019-08-24T14:15:22Z"
}

Retrieve environments file system

Required API key scopes

file_system:read

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.


Response


Example 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/

Example response

Status 200
RESPONSE
{
"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",
"last_viewed_at": "2019-08-24T14:15:22Z"
}

Update environments file system

Required API key scopes

file_system:write

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    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

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Response


Example 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"

Example response

Status 200
RESPONSE
{
"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",
"last_viewed_at": "2019-08-24T14:15:22Z"
}

Update environments file system

Required API key scopes

file_system:write

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    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

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Response


Example 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"

Example response

Status 200
RESPONSE
{
"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",
"last_viewed_at": "2019-08-24T14:15:22Z"
}

Delete environments file system

Required API key scopes

file_system:write

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.


Example 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/

Example response

Status 204 No response body

Delete environments file system

Required API key scopes

file_system:write

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.


Example 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/

Example response

Status 204 No response body
Next page →

Community questions

Questions about this page? or post a community question.