Persisted API Reference

Persisted

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

Endpoints

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

List all environments persisted folder

Required API key scopes

persisted_folder:read

Path parameters

environment_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:environment_id/persisted_folder
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/persisted_folder/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/persisted_folder/".format(
        project_id=project_id,
		environment_id="<the environment 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",
      "type": "home",
      "protocol": "string",
      "path": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create environments persisted folder

Required API key scopes

persisted_folder:write

Path parameters

environment_id
string

Request parameters

type
protocol
string
path
string

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "home",
  "protocol": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve environments persisted folder

Required API key scopes

persisted_folder:read

Path parameters

environment_id
string
id
string

Response

Example request

GET /api/environments/:environment_id/persisted_folder/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/persisted_folder/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/persisted_folder/{persisted_folder_id}/".format(
        project_id=project_id,
		persisted_folder_id="<the persisted folder id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "home",
  "protocol": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update environments persisted folder

Required API key scopes

persisted_folder:write

Path parameters

environment_id
string
id
string

Request parameters

type
protocol
string
path
string

Response

Example request

PATCH /api/environments/:environment_id/persisted_folder/: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/:environment_id/persisted_folder/:id/\
	-d type=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/persisted_folder/{persisted_folder_id}/".format(
        project_id=project_id,
		persisted_folder_id="<the persisted folder id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "home",
  "protocol": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete environments persisted folder

Required API key scopes

persisted_folder:write

Path parameters

environment_id
string
id
string

Example request

DELETE /api/environments/:environment_id/persisted_folder/: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/:environment_id/persisted_folder/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{environment_id}/persisted_folder/{persisted_folder_id}/".format(
        project_id=project_id,
		persisted_folder_id="<the persisted folder id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

List all persisted folder

Required API key scopes

persisted_folder:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/persisted_folder
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/persisted_folder/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/persisted_folder/".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",
      "type": "home",
      "protocol": "string",
      "path": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create persisted folder

Required API key scopes

persisted_folder:write

Path parameters

project_id
string

Request parameters

type
protocol
string
path
string

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "home",
  "protocol": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve persisted folder

Required API key scopes

persisted_folder:read

Path parameters

id
string
project_id
string

Response

Example request

GET /api/projects/:project_id/persisted_folder/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/persisted_folder/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/persisted_folder/{persisted_folder_id}/".format(
        project_id=project_id,
		persisted_folder_id="<the persisted folder id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "home",
  "protocol": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update persisted folder

Required API key scopes

persisted_folder:write

Path parameters

id
string
project_id
string

Request parameters

type
protocol
string
path
string

Response

Example request

PATCH /api/projects/:project_id/persisted_folder/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/persisted_folder/:id/\
	-d type=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/persisted_folder/{persisted_folder_id}/".format(
        project_id=project_id,
		persisted_folder_id="<the persisted folder id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "home",
  "protocol": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete persisted folder

Required API key scopes

persisted_folder:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/projects/:project_id/persisted_folder/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/persisted_folder/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/persisted_folder/{persisted_folder_id}/".format(
        project_id=project_id,
		persisted_folder_id="<the persisted folder id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Persisted

Endpoints

List all environments persisted folder

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create environments persisted folder

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve environments persisted folder

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update environments persisted folder

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete environments persisted folder

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

List all persisted folder

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create persisted folder

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve persisted folder

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update persisted folder

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete persisted folder

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Community questions