Environments-12 API Reference

Environments-12

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

Endpoints

`POST`
`GET`
`POST`
`POST`
`GET`
`GET`
`POST`
`GET`
`PATCH`
`DELETE`
`GET`
`POST`
`GET`

Create environments file system count by path

Path parameters

project_id
string

Request parameters

path
string
type
string
ref
string
href
string
meta
shortcut
boolean

Example 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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/file_system/count_by_path/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve environments file system log view

Path parameters

project_id
string

Example request

GET /api/environments/:project_id/file_system/log_view
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/log_view/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/file_system/log_view/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create environments file system log view

Path parameters

project_id
string

Request parameters

path
string
type
string
ref
string
href
string
meta
shortcut
boolean

Example request

POST /api/environments/:project_id/file_system/log_view
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/log_view/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/file_system/log_view/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Create environments file system undo delete

Path parameters

project_id
string

Request parameters

path
string
type
string
ref
string
href
string
meta
shortcut
boolean

Example request

POST /api/environments/:project_id/file_system/undo_delete
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/undo_delete/\
	-d path="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/file_system/undo_delete/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve environments file system unfiled

Path parameters

project_id
string

Example 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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/file_system/unfiled/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example 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

Query parameters

limit
integer
offset
integer

Response

Example 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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/file_system_shortcut/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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

Query parameters

limit
integer
offset
integer

Response

Example 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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/file_system_shortcut/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/file_system_shortcut/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

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

Create environments file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

project_id
string

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/file_system_shortcut/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

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

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/file_system_shortcut/{environments-12_id}/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/file_system_shortcut/{environments-12_id}/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/file_system_shortcut/{environments-12_id}/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

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

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/file_system_shortcut/{environments-12_id}/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"path": "string"
	}
).json()

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

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/file_system_shortcut/{environments-12_id}/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Delete environments file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

id
string
project_id
string

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/file_system_shortcut/{environments-12_id}/".format(
        project_id=project_id,
		environments-12_id="<the environments-12 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

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

Query parameters

cursor
string
group_type_index
integer
search
string

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/groups/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/groups/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"group_type_index": "integer",
		"group_key": "string"
	}
).json()

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

Query parameters

group_type_index
integer
id
string

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/groups/activity/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()