{ "opencollection": "1.0.0", "info": { "name": "Kibana APIs Actions connectors API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "connectors", "type": "folder" }, "items": [ { "info": { "name": "Get connector types", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/actions/connector_types", "params": [ { "name": "feature_id", "value": "", "type": "query", "description": "A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases)." } ] }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/actions/connector_types
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nYou do not need any Kibana feature privileges to run this API." }, { "info": { "name": "Handle OAuth callback", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/actions/connector/_oauth_callback", "params": [ { "name": "code", "value": "", "type": "query", "description": "The authorization code returned by the OAuth provider." }, { "name": "state", "value": "", "type": "query", "description": "The state parameter for CSRF protection." }, { "name": "error", "value": "", "type": "query", "description": "Error code if the authorization failed." }, { "name": "error_description", "value": "", "type": "query", "description": "Human-readable error description." }, { "name": "session_state", "value": "", "type": "query", "description": "Session state from the OAuth provider (e.g., Microsoft)." } ] }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/actions/connector/_oauth_callback
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nHandles the OAuth 2.0 authorization code callback from external providers. Exchanges the authorization code for access and refresh tokens.

[Required authorization] Route required privileges: actio" }, { "info": { "name": "Get connector information", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/actions/connector/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "An identifier for the connector." } ] }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/actions/connector/{id}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information." }, { "info": { "name": "Create a connector", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/actions/connector/:id", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "An identifier for the connector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/actions/connector/{id}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information." }, { "info": { "name": "Update a connector", "type": "http" }, "http": { "method": "PUT", "url": "https://{kibana_url}/api/actions/connector/:id", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "An identifier for the connector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
put /s/{space_id}/api/actions/connector/{id}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information." }, { "info": { "name": "Delete a connector", "type": "http" }, "http": { "method": "DELETE", "url": "https://{kibana_url}/api/actions/connector/:id", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "An identifier for the connector." } ] }, "docs": "**Spaces method and path for this operation:**\n\n
delete /s/{space_id}/api/actions/connector/{id}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nWARNING: When you delete a connector, it cannot be recovered." }, { "info": { "name": "Run a connector", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/actions/connector/:id/_execute", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "An identifier for the connector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/actions/connector/{id}/_execute
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nYou can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems." }, { "info": { "name": "Get all connectors", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/actions/connectors" }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/actions/connectors
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information." } ] } ], "bundled": true }