Plugins

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

List all plugins

Required API key scopes

plugin:read

Path parameters

  • organization_id
    string

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/organizations/:organization_id/plugins
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/

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_type": "local",
      "name": "string",
      "description": "string",
      "url": "string",
      "icon": "string",
      "config_schema": null,
      "tag": "string",
      "latest_tag": "string",
      "is_global": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "organization_name": "string",
      "capabilities": null,
      "metrics": null,
      "public_jobs": null,
      "hog_function_migration_available": "string"
    }
  ]
}

Create plugins

Required API key scopes

plugin:write

Path parameters

  • organization_id
    string

Request parameters

  • plugin_type
  • name
    string
  • description
    string
  • icon
    string
  • config_schema
  • tag
    string
  • is_global
    boolean
  • capabilities
  • metrics
  • public_jobs

Response


Request

POST /api/organizations/:organization_id/plugins
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/organizations/:organization_id/plugins/\
	-d plugin_type=undefined

Response

Status 201
RESPONSE
{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null,
  "hog_function_migration_available": "string"
}

Retrieve plugins

Required API key scopes

plugin:read

Path parameters

  • id
    integer

    A unique integer value identifying this plugin.

  • organization_id
    string

Response


Request

GET /api/organizations/:organization_id/plugins/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/:id/

Response

Status 200
RESPONSE
{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null,
  "hog_function_migration_available": "string"
}

Update plugins

Required API key scopes

plugin:write

Path parameters

  • id
    integer

    A unique integer value identifying this plugin.

  • organization_id
    string

Request parameters

  • plugin_type
  • name
    string
  • description
    string
  • icon
    string
  • config_schema
  • tag
    string
  • is_global
    boolean
  • capabilities
  • metrics
  • public_jobs

Response


Request

PATCH /api/organizations/:organization_id/plugins/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/:id/\
	-d plugin_type=undefined

Response

Status 200
RESPONSE
{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null,
  "hog_function_migration_available": "string"
}

Delete plugins

Required API key scopes

plugin:write

Path parameters

  • id
    integer

    A unique integer value identifying this plugin.

  • organization_id
    string

Request

DELETE /api/organizations/:organization_id/plugins/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/:id/

Response

Status 204 No response body

Retrieve plugins check for updates

Path parameters

  • id
    integer

    A unique integer value identifying this plugin.

  • organization_id
    string

Request

GET /api/organizations/:organization_id/plugins/:id/check_for_updates
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/:id/check_for_updates/

Response

Status 200 No response body

Retrieve plugins source

Path parameters

  • id
    integer

    A unique integer value identifying this plugin.

  • organization_id
    string

Request

GET /api/organizations/:organization_id/plugins/:id/source
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/:id/source/

Response

Status 200 No response body

Update plugins update source

Path parameters

  • id
    integer

    A unique integer value identifying this plugin.

  • organization_id
    string

Request parameters

  • plugin_type
  • name
    string
  • description
    string
  • icon
    string
  • config_schema
  • tag
    string
  • is_global
    boolean
  • capabilities
  • metrics
  • public_jobs

Request

PATCH /api/organizations/:organization_id/plugins/:id/update_source
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/:id/update_source/\
	-d plugin_type=undefined

Response

Status 200 No response body

Create plugins upgrade

Path parameters

  • id
    integer

    A unique integer value identifying this plugin.

  • organization_id
    string

Request parameters

  • plugin_type
  • name
    string
  • description
    string
  • icon
    string
  • config_schema
  • tag
    string
  • is_global
    boolean
  • capabilities
  • metrics
  • public_jobs

Request

POST /api/organizations/:organization_id/plugins/:id/upgrade
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/organizations/:organization_id/plugins/:id/upgrade/\
	-d plugin_type=undefined

Response

Status 200 No response body

Retrieve plugins activity

Path parameters

  • organization_id
    string

Request

GET /api/organizations/:organization_id/plugins/activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/activity/

Response

Status 200 No response body

Retrieve plugins exports unsubscribe configs

Path parameters

  • organization_id
    string

Request

GET /api/organizations/:organization_id/plugins/exports_unsubscribe_configs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/exports_unsubscribe_configs/

Response

Status 200 No response body

Retrieve plugins repository

Path parameters

  • organization_id
    string

Request

GET /api/organizations/:organization_id/plugins/repository
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/repository/

Response

Status 200 No response body

Retrieve plugins unused

Path parameters

  • organization_id
    string

Request

GET /api/organizations/:organization_id/plugins/unused
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/plugins/unused/

Response

Status 200 No response body

Questions?

Was this page useful?