Plugin
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all plugin configs
Path Parameters
- project_idstring
Query Parameters
- limitinteger
- offsetinteger
Response
Request
GET
/api /projects /:project_id /plugin_configs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/plugin_configs/
Response
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,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": {"property1": null,"property2": null},"team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z"}]}
Create plugin configs
Path Parameters
- project_idstring
Request Parameters
- plugininteger
- enabledboolean
- orderinteger
- errorobject
Response
Request
POST
/api /projects /:project_id /plugin_configs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl-H 'Content-Type: application/json'\-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/plugin_configs/\-d plugin="integer",\-d order="integer"
Response
RESPONSE
{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": {"property1": null,"property2": null},"team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z"}
List all plugin configs logs
Path Parameters
- parent_lookup_plugin_config_idstring
- project_idstring
Query Parameters
- limitinteger
- offsetinteger
Response
Request
GET
/api /projects /:project_id /plugin_configs /:parent_lookup_plugin_config_id /logs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/plugin_configs/:parent_lookup_plugin_config_id/logs/
Response
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","team_id": 0,"plugin_id": 0,"plugin_config_id": 0,"timestamp": "2019-08-24T14:15:22Z","source": "SYSTEM","type": "DEBUG","message": "string","instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366"}]}
Retrieve plugin configs
Path Parameters
- idinteger
- project_idstring
Response
Request
GET
/api /projects /:project_id /plugin_configs /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/plugin_configs/:id/
Response
RESPONSE
{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": {"property1": null,"property2": null},"team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z"}
Update plugin configs
Path Parameters
- idinteger
- project_idstring
Request Parameters
- plugininteger
- enabledboolean
- orderinteger
- errorobject
Response
Request
PATCH
/api /projects /:project_id /plugin_configs /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/plugin_configs/:id/\-d plugin="integer"
Response
RESPONSE
{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": {"property1": null,"property2": null},"team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z"}
Delete plugin configs
Path Parameters
- idinteger
- project_idstring
Request
DELETE
/api /projects /:project_id /plugin_configs /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X DELETE \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/plugin_configs/:id/
Response
No responseRetrieve plugin configs frontend
Path Parameters
- idinteger
- project_idstring
Response
Request
GET
/api /projects /:project_id /plugin_configs /:id /frontend
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/plugin_configs/:id/frontend/
Response
RESPONSE
{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": {"property1": null,"property2": null},"team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z"}
Create plugin configs job
Path Parameters
- idinteger
- project_idstring
Request Parameters
- plugininteger
- enabledboolean
- orderinteger
- errorobject
Response
Request
POST
/api /projects /:project_id /plugin_configs /:id /job
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl-H 'Content-Type: application/json'\-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/plugin_configs/:id/job/\-d plugin="integer",\-d order="integer"
Response
RESPONSE
{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": {"property1": null,"property2": null},"team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z"}
Update plugin configs rearrange
Path Parameters
- project_idstring
Request Parameters
- plugininteger
- enabledboolean
- orderinteger
- errorobject
Response
Request
PATCH
/api /projects /:project_id /plugin_configs /rearrange
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/plugin_configs/rearrange/\-d plugin="integer"
Response
RESPONSE
{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": {"property1": null,"property2": null},"team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z"}