Organizations 50 endpoints

PATCH /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
operationId: Organizations_updatePipelineFrontendAppsById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
PUT /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
operationId: Organizations_updatePipelineFrontendAppById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

200 —
PUT /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
GET /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/check_for_updates
operationId: Organizations_pipelineFrontendAppsCheckForUpdatesRetrieve

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/check_for_updates
GET /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/source
operationId: Organizations_getPipelineFrontendAppsSource

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/source
PATCH /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/update_source
operationId: Organizations_pipelineFrontendAppsUpdateSourcePatch

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/update_source
POST /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/upgrade
operationId: Organizations_upgradePipelineFrontendApp

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

200 —
POST /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/upgrade
GET /api/organizations/{organization_id}/pipeline_import_apps
operationId: Organizations_getPipelineImportApps

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_import_apps
POST /api/organizations/{organization_id}/pipeline_import_apps
operationId: Organizations_importPipelineApps

Parameters

Name In Required Type Description
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

201 —
POST /api/organizations/{organization_id}/pipeline_import_apps
GET /api/organizations/{organization_id}/pipeline_import_apps/activity
operationId: Organizations_getPipelineImportAppsActivity

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_import_apps/activity
GET /api/organizations/{organization_id}/pipeline_import_apps/exports_unsubscribe_configs
operationId: Organizations_pipelineImportAppsExportsUnsubscribeConfigsRetrieve

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_import_apps/exports_unsubscribe_configs
GET /api/organizations/{organization_id}/pipeline_import_apps/repository
operationId: Organizations_getPipelineImportAppsRepository

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_import_apps/repository
GET /api/organizations/{organization_id}/pipeline_import_apps/unused
operationId: Organizations_getUnusedPipelineImportApps

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_import_apps/unused
DELETE /api/organizations/{organization_id}/pipeline_import_apps/{id}
operationId: Organizations_deletePipelineImportApp

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

204

No response body
DELETE /api/organizations/{organization_id}/pipeline_import_apps/{id}
GET /api/organizations/{organization_id}/pipeline_import_apps/{id}
operationId: Organizations_getPipelineImportApp

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_import_apps/{id}
PATCH /api/organizations/{organization_id}/pipeline_import_apps/{id}
operationId: Organizations_updatePipelineImportAppsConfigs

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_import_apps/{id}
PUT /api/organizations/{organization_id}/pipeline_import_apps/{id}
operationId: Organizations_pipelineImportAppsUpdate

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

200 —
PUT /api/organizations/{organization_id}/pipeline_import_apps/{id}
GET /api/organizations/{organization_id}/pipeline_import_apps/{id}/check_for_updates
operationId: Organizations_pipelineImportAppsCheckForUpdatesRetrieve

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_import_apps/{id}/check_for_updates
GET /api/organizations/{organization_id}/pipeline_import_apps/{id}/source
operationId: Organizations_getPipelineImportAppsSource

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_import_apps/{id}/source
PATCH /api/organizations/{organization_id}/pipeline_import_apps/{id}/update_source
operationId: Organizations_updatePipelineImportAppSource

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_import_apps/{id}/update_source
POST /api/organizations/{organization_id}/pipeline_import_apps/{id}/upgrade
operationId: Organizations_upgradePipelineImportApp

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

200 —
POST /api/organizations/{organization_id}/pipeline_import_apps/{id}/upgrade
GET /api/organizations/{organization_id}/pipeline_transformations
operationId: Organizations_getPipelineTransformations

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_transformations
POST /api/organizations/{organization_id}/pipeline_transformations
operationId: Organizations_createPipelineTransformation

Parameters

Name In Required Type Description
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

201 —
POST /api/organizations/{organization_id}/pipeline_transformations
GET /api/organizations/{organization_id}/pipeline_transformations/activity
operationId: Organizations_getPipelineTransformationsActivity

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_transformations/activity
GET /api/organizations/{organization_id}/pipeline_transformations/exports_unsubscribe_configs
operationId: Organizations_getPipelineTransformationExportsUnsubscribeConfigs

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_transformations/exports_unsubscribe_configs
GET /api/organizations/{organization_id}/pipeline_transformations/repository
operationId: Organizations_getPipelineTransformationsRepository

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_transformations/repository
GET /api/organizations/{organization_id}/pipeline_transformations/unused
operationId: Organizations_getUnusedPipelineTransformations

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_transformations/unused
DELETE /api/organizations/{organization_id}/pipeline_transformations/{id}
operationId: Organizations_deletePipelineTransformation

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

204

No response body
DELETE /api/organizations/{organization_id}/pipeline_transformations/{id}
GET /api/organizations/{organization_id}/pipeline_transformations/{id}
operationId: Organizations_getPipelineTransformation

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_transformations/{id}
PATCH /api/organizations/{organization_id}/pipeline_transformations/{id}
operationId: Organizations_updatePipelineTransformationById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_transformations/{id}
PUT /api/organizations/{organization_id}/pipeline_transformations/{id}
operationId: Organizations_updatePipelineTransformationById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

200 —
PUT /api/organizations/{organization_id}/pipeline_transformations/{id}
GET /api/organizations/{organization_id}/pipeline_transformations/{id}/check_for_updates
operationId: Organizations_getPipelineTransformationCheckForUpdates

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_transformations/{id}/check_for_updates
GET /api/organizations/{organization_id}/pipeline_transformations/{id}/source
operationId: Organizations_pipelineTransformationsSourceRetrieve

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_transformations/{id}/source
PATCH /api/organizations/{organization_id}/pipeline_transformations/{id}/update_source
operationId: Organizations_updatePipelineTransformationSourcePartialUpdate

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_transformations/{id}/update_source
POST /api/organizations/{organization_id}/pipeline_transformations/{id}/upgrade
operationId: Organizations_upgradePipelineTransformation

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

200 —
POST /api/organizations/{organization_id}/pipeline_transformations/{id}/upgrade
GET /api/organizations/{organization_id}/plugins
operationId: plugins_list

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/plugins
POST /api/organizations/{organization_id}/plugins
operationId: plugins_create

Parameters

Name In Required Type Description
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

201 —
POST /api/organizations/{organization_id}/plugins
GET /api/organizations/{organization_id}/plugins/activity
operationId: Organizations_getPluginsActivity

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/plugins/activity
GET /api/organizations/{organization_id}/plugins/exports_unsubscribe_configs
operationId: Organizations_getPluginsExportsUnsubscribeConfigs

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/plugins/exports_unsubscribe_configs
GET /api/organizations/{organization_id}/plugins/repository
operationId: Organizations_getPluginsRepository

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/plugins/repository
GET /api/organizations/{organization_id}/plugins/unused
operationId: Organizations_getPluginsUnused

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/plugins/unused
DELETE /api/organizations/{organization_id}/plugins/{id}
operationId: plugins_destroy

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

204

No response body
DELETE /api/organizations/{organization_id}/plugins/{id}
GET /api/organizations/{organization_id}/plugins/{id}
operationId: plugins_retrieve

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/plugins/{id}
PATCH /api/organizations/{organization_id}/plugins/{id}
operationId: Organizations_updatePluginById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/plugins/{id}
PUT /api/organizations/{organization_id}/plugins/{id}
operationId: plugins_update

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

200 —
PUT /api/organizations/{organization_id}/plugins/{id}
GET /api/organizations/{organization_id}/plugins/{id}/check_for_updates
operationId: Organizations_pluginsCheckForUpdates

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/plugins/{id}/check_for_updates
GET /api/organizations/{organization_id}/plugins/{id}/source
operationId: Organizations_pluginsSourceRetrieve

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/plugins/{id}/source
PATCH /api/organizations/{organization_id}/plugins/{id}/update_source
operationId: Organizations_updatePluginSource

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/plugins/{id}/update_source
POST /api/organizations/{organization_id}/plugins/{id}/upgrade
operationId: Organizations_upgradePlugin

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

200 —
POST /api/organizations/{organization_id}/plugins/{id}/upgrade
GET /api/organizations/{organization_id}/projects

Projects for the current organization.

operationId: Organizations_getProjects

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/projects
POST /api/organizations/{organization_id}/projects

Projects for the current organization.

operationId: Organizations_createProject

Parameters

Name In Required Type Description
organization_id path required string —

Request Body

application/json
schema Team
Property Type Required
id integer required
name string optional
uuid string required
is_demo boolean optional
app_urls array optional
timezone string optional
api_token string required
created_at string required
updated_at string required
organization string required
anonymize_ips boolean optional
access_control boolean optional
extra_settings object optional
ingested_event boolean required
surveys_opt_in boolean optional
week_start_day object optional
data_attributes object optional
has_group_types boolean required
inject_web_apps boolean optional
primary_dashboard integer optional
…24 more object optional
multipart/form-data
schema Team
Property Type Required
id integer required
name string optional
uuid string required
is_demo boolean optional
app_urls array optional
timezone string optional
api_token string required
created_at string required
updated_at string required
organization string required
anonymize_ips boolean optional
access_control boolean optional
extra_settings object optional
ingested_event boolean required
surveys_opt_in boolean optional
week_start_day object optional
data_attributes object optional
has_group_types boolean required
inject_web_apps boolean optional
primary_dashboard integer optional
…24 more object optional
application/x-www-form-urlencoded
schema Team
Property Type Required
id integer required
name string optional
uuid string required
is_demo boolean optional
app_urls array optional
timezone string optional
api_token string required
created_at string required
updated_at string required
organization string required
anonymize_ips boolean optional
access_control boolean optional
extra_settings object optional
ingested_event boolean required
surveys_opt_in boolean optional
week_start_day object optional
data_attributes object optional
has_group_types boolean required
inject_web_apps boolean optional
primary_dashboard integer optional
…24 more object optional

Responses

201 —
POST /api/organizations/{organization_id}/projects
Load more endpoints