Plugin

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

List all plugin configs

Required API key scopes

plugin: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/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

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": 0,
      "plugin": 0,
      "enabled": true,
      "order": -2147483648,
      "config": "string",
      "error": "string",
      "team_id": 0,
      "plugin_info": "string",
      "delivery_rate_24h": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "description": "string",
      "deleted": true,
      "filters": null
    }
  ]
}

Create plugin configs

Required API key scopes

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

  • plugin
    integer
  • enabled
    boolean
  • order
    integer
  • name
    string
  • description
    string
  • deleted
    boolean
  • filters

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

Status 201
RESPONSE
{
  "id": 0,
  "plugin": 0,
  "enabled": true,
  "order": -2147483648,
  "config": "string",
  "error": "string",
  "team_id": 0,
  "plugin_info": "string",
  "delivery_rate_24h": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "deleted": true,
  "filters": null
}

Retrieve plugin configs

Required API key scopes

plugin:read

Path parameters

  • id
    integer

    A unique integer value identifying this plugin config.

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

Status 200
RESPONSE
{
  "id": 0,
  "plugin": 0,
  "enabled": true,
  "order": -2147483648,
  "config": "string",
  "error": "string",
  "team_id": 0,
  "plugin_info": "string",
  "delivery_rate_24h": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "deleted": true,
  "filters": null
}

Update plugin configs

Required API key scopes

plugin:write

Path parameters

  • id
    integer

    A unique integer value identifying this plugin config.

  • 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

  • plugin
    integer
  • enabled
    boolean
  • order
    integer
  • name
    string
  • description
    string
  • deleted
    boolean
  • filters

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

Status 200
RESPONSE
{
  "id": 0,
  "plugin": 0,
  "enabled": true,
  "order": -2147483648,
  "config": "string",
  "error": "string",
  "team_id": 0,
  "plugin_info": "string",
  "delivery_rate_24h": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "deleted": true,
  "filters": null
}

Delete plugin configs

Required API key scopes

plugin:write

Path parameters

  • id
    integer

    A unique integer value identifying this plugin config.

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

Status 204 No response body

Retrieve plugin configs frontend

Path parameters

  • id
    integer

    A unique integer value identifying this plugin config.

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

Status 200
RESPONSE
{
  "id": 0,
  "plugin": 0,
  "enabled": true,
  "order": -2147483648,
  "config": "string",
  "error": "string",
  "team_id": 0,
  "plugin_info": "string",
  "delivery_rate_24h": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "deleted": true,
  "filters": null
}

Create plugin configs job

Path parameters

  • id
    integer

    A unique integer value identifying this plugin config.

  • 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

  • plugin
    integer
  • enabled
    boolean
  • order
    integer
  • name
    string
  • description
    string
  • deleted
    boolean
  • filters

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

Status 200
RESPONSE
{
  "id": 0,
  "plugin": 0,
  "enabled": true,
  "order": -2147483648,
  "config": "string",
  "error": "string",
  "team_id": 0,
  "plugin_info": "string",
  "delivery_rate_24h": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "deleted": true,
  "filters": null
}

List all plugin configs logs

Required API key scopes

plugin:read

Path parameters

  • plugin_config_id
    string
  • 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/projects/:project_id/plugin_configs/: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/:plugin_config_id/logs/

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

Update plugin configs rearrange

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

  • plugin
    integer
  • enabled
    boolean
  • order
    integer
  • name
    string
  • description
    string
  • deleted
    boolean
  • filters

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

Status 200
RESPONSE
{
  "id": 0,
  "plugin": 0,
  "enabled": true,
  "order": -2147483648,
  "config": "string",
  "error": "string",
  "team_id": 0,
  "plugin_info": "string",
  "delivery_rate_24h": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "deleted": true,
  "filters": null
}

Questions?

Was this page useful?