Plugins API Reference

Plugins

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

Endpoints

`GET`	`/api/organizations/:parent_lookup_organization_id/plugins/`
`POST`	`/api/organizations/:parent_lookup_organization_id/plugins/`
`GET`	`/api/organizations/:parent_lookup_organization_id/plugins/:id/`
`PATCH`	`/api/organizations/:parent_lookup_organization_id/plugins/:id/`
`DELETE`	`/api/organizations/:parent_lookup_organization_id/plugins/:id/`
`GET`	`/api/organizations/:parent_lookup_organization_id/plugins/:id/check_for_updates/`
`GET`	`/api/organizations/:parent_lookup_organization_id/plugins/:id/source/`
`PATCH`	`/api/organizations/:parent_lookup_organization_id/plugins/:id/update_source/`
`POST`	`/api/organizations/:parent_lookup_organization_id/plugins/:id/upgrade/`
`GET`	`/api/organizations/:parent_lookup_organization_id/plugins/activity/`
`GET`	`/api/organizations/:parent_lookup_organization_id/plugins/repository/`
`GET`	`/api/organizations/:parent_lookup_organization_id/plugins/unused/`

List all plugins

Path Parameters

parent_lookup_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/:parent_lookup_organization_id/plugins

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:parent_lookup_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": {
        "property1": null,
        "property2": null
      },
      "tag": "string",
      "latest_tag": "string",
      "is_global": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "organization_name": "string",
      "capabilities": {
        "property1": null,
        "property2": null
      },
      "metrics": {
        "property1": null,
        "property2": null
      },
      "public_jobs": {
        "property1": null,
        "property2": null
      }
    }
  ]
}

Create plugins

Path Parameters

parent_lookup_organization_id
string

Request Parameters

plugin_type
string
One of: "local""custom""repository""source"
name
string
description
string
icon
string
config_schema
object
tag
string
is_global
boolean
capabilities
object
metrics
object
public_jobs
object

Response

Request

POST /api/organizations/:parent_lookup_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" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/plugins/\
	-d plugin_type="string"

Response

Status 201

RESPONSE

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

Retrieve plugins

Path Parameters

id
integer
A unique integer value identifying this plugin.
parent_lookup_organization_id
string

Response

Request

GET /api/organizations/:parent_lookup_organization_id/plugins/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/plugins/:id/

Response

Status 200

RESPONSE

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

Update plugins

Path Parameters

id
integer
A unique integer value identifying this plugin.
parent_lookup_organization_id
string

Request Parameters

plugin_type
string
One of: "local""custom""repository""source"
name
string
description
string
icon
string
config_schema
object
tag
string
is_global
boolean
capabilities
object
metrics
object
public_jobs
object

Response

Request

PATCH /api/organizations/:parent_lookup_organization_id/plugins/: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/organizations/:parent_lookup_organization_id/plugins/:id/\
	-d plugin_type="string"

Response

Status 200

RESPONSE

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

Delete plugins

Path Parameters

id
integer
A unique integer value identifying this plugin.
parent_lookup_organization_id
string

Request

DELETE /api/organizations/:parent_lookup_organization_id/plugins/: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/organizations/:parent_lookup_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.
parent_lookup_organization_id
string

Response

Request

GET /api/organizations/:parent_lookup_organization_id/plugins/:id/check_for_updates

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/plugins/:id/check_for_updates/

Response

Status 200

RESPONSE

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

Retrieve plugins source

Path Parameters

id
integer
A unique integer value identifying this plugin.
parent_lookup_organization_id
string

Response

Request

GET /api/organizations/:parent_lookup_organization_id/plugins/:id/source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/plugins/:id/source/

Response

Status 200

RESPONSE

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

Update plugins update source

Path Parameters

id
integer
A unique integer value identifying this plugin.
parent_lookup_organization_id
string

Request Parameters

plugin_type
string
One of: "local""custom""repository""source"
name
string
description
string
icon
string
config_schema
object
tag
string
is_global
boolean
capabilities
object
metrics
object
public_jobs
object

Response

Request

PATCH /api/organizations/:parent_lookup_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" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/plugins/:id/update_source/\
	-d plugin_type="string"

Response

Status 200

RESPONSE

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

Create plugins upgrade

Path Parameters

id
integer
A unique integer value identifying this plugin.
parent_lookup_organization_id
string

Request Parameters

plugin_type
string
One of: "local""custom""repository""source"
name
string
description
string
icon
string
config_schema
object
tag
string
is_global
boolean
capabilities
object
metrics
object
public_jobs
object

Response

Request

POST /api/organizations/:parent_lookup_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" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/plugins/:id/upgrade/\
	-d plugin_type="string"

Response

Status 200

RESPONSE

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

Retrieve plugins activity

Path Parameters

parent_lookup_organization_id
string

Response

Request

GET /api/organizations/:parent_lookup_organization_id/plugins/activity

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/plugins/activity/

Response

Status 200

RESPONSE

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

Retrieve plugins repository

Path Parameters

parent_lookup_organization_id
string

Response

Request

GET /api/organizations/:parent_lookup_organization_id/plugins/repository

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/plugins/repository/

Response

Status 200

RESPONSE

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

Retrieve plugins unused

Path Parameters

parent_lookup_organization_id
string

Response

Request

GET /api/organizations/:parent_lookup_organization_id/plugins/unused

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:parent_lookup_organization_id/plugins/unused/

Response

Status 200

RESPONSE

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

Plugins

Endpoints

List all plugins

Path Parameters

Query Parameters

Response

Request

Response

Status 200

Create plugins

Path Parameters

Request Parameters

Response

Request

Response

Status 201

Retrieve plugins

Path Parameters

Response

Request

Response

Status 200

Update plugins

Path Parameters

Request Parameters

Response

Request

Response

Status 200

Delete plugins

Path Parameters

Request

Response

Status 204 No response body

Retrieve plugins check for updates

Path Parameters

Response

Request

Response

Status 200

Retrieve plugins source

Path Parameters

Response

Request

Response

Status 200

Update plugins update source

Path Parameters

Request Parameters

Response

Request

Response

Status 200

Create plugins upgrade

Path Parameters

Request Parameters

Response

Request

Response

Status 200

Retrieve plugins activity

Path Parameters

Response

Request

Response

Status 200

Retrieve plugins repository

Path Parameters

Response

Request

Response

Status 200

Retrieve plugins unused

Path Parameters

Response

Request

Response

Status 200

Questions?

Was this page useful?