Environments-7

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

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


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

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


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

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


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

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


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

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

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

  • 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/.

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 shortcut

Required API key scopes

file_system_shortcut: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


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

List all environments file system shortcut

Required API key scopes

file_system_shortcut: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


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

  • 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

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
RESPONSE
{
  "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_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

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

  • id
    string

    A UUID string identifying this file system shortcut.

  • 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


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

  • id
    string

    A UUID string identifying this file system shortcut.

  • 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


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

  • id
    string

    A UUID string identifying this file system shortcut.

  • 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

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

  • id
    string

    A UUID string identifying this file system shortcut.

  • 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

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

  • id
    string

    A UUID string identifying this file system shortcut.

  • 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

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

  • id
    string

    A UUID string identifying this file system shortcut.

  • 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

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

List all environments groups

List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/

Required API key scopes

group: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

  • cursor
    string

    The pagination cursor value.

  • group_type_index
    integer

    Specify the group type to list

  • search
    string

    Search the group name

Response


Request

GET /api/environments/:project_id/groups
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/groups/

Response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "group_type_index": -2147483648,
      "group_key": "string",
      "group_properties": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

List all environments groups

List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/

Required API key scopes

group: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

  • cursor
    string

    The pagination cursor value.

  • group_type_index
    integer

    Specify the group type to list

  • search
    string

    Search the group name

Response


Request

GET /api/environments/:project_id/groups
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/groups/

Response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "group_type_index": -2147483648,
      "group_key": "string",
      "group_properties": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}
Next page →

Community questions

Was this page useful?