Environments-14

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

Endpoints

POST
GET
PATCH
DELETE
GET
POST
GET
POST
GET
GET

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


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

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

  • 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


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

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

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


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

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

  • 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


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

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

  • 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


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

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

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


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

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


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

Example 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


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

Example 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


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

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

Create environments groups

Required API key scopes

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

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Response


Example request

POST /api/environments/:project_id/groups
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/groups/\
-d group_type_index="integer",\
-d group_key="string"

Example response

Status 201
RESPONSE
{
"group_type_index": -2147483648,
"group_key": "string",
"group_properties": null,
"created_at": "2019-08-24T14:15:22Z"
}

Create environments groups

Required API key scopes

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

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Response


Example request

POST /api/environments/:project_id/groups
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/groups/\
-d group_type_index="integer",\
-d group_key="string"

Example response

Status 201
RESPONSE
{
"group_type_index": -2147483648,
"group_key": "string",
"group_properties": null,
"created_at": "2019-08-24T14:15:22Z"
}

Retrieve environments groups activity

Required API key scopes

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

  • group_type_index
    integer

    Specify the group type to find

  • id
    string

    Specify the id of the user to find groups for


Example request

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

Example response

Status 200 No response body

Retrieve environments groups activity

Required API key scopes

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

  • group_type_index
    integer

    Specify the group type to find

  • id
    string

    Specify the id of the user to find groups for


Example request

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

Example response

Status 200 No response body

Create environments groups delete property

Required API key scopes

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


Query parameters

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find


Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Example request

POST /api/environments/:project_id/groups/delete_property
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/groups/delete_property/\
-d group_type_index="integer",\
-d group_key="string"

Example response

Status 200 No response body

Create environments groups delete property

Required API key scopes

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


Query parameters

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find


Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Example request

POST /api/environments/:project_id/groups/delete_property
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/groups/delete_property/\
-d group_type_index="integer",\
-d group_key="string"

Example response

Status 200 No response body

Retrieve environments groups find

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

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find


Example request

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

Example response

Status 200 No response body

Retrieve environments groups find

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

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find


Example request

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

Example response

Status 200 No response body

Retrieve environments groups property definitions

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


Example request

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

Example response

Status 200 No response body
Next page →

Community questions

Questions about this page? or post a community question.