---
title: Firecrawl connector
description: Use the Firecrawl connector to scrape web pages, search the web, map site URLs, and crawl websites using the Firecrawl REST API.
url: https://www.elastic.co/docs/reference/kibana/connectors-kibana/firecrawl-action-type
products:
  - Kibana
applies_to:
  - Elastic Cloud Serverless: Preview
  - Elastic Stack: Planned
---

# Firecrawl connector
The Firecrawl connector uses the [Firecrawl REST API v2](https://docs.firecrawl.dev/api-reference/v2-introduction) to scrape web pages, search the web, map site URLs, and crawl websites. It supports Bearer token (API key) authentication.

## Create connectors in Kibana

You can create connectors in **Stack Management > Connectors**.

### Connector configuration

Firecrawl connectors have the following configuration properties:
<definitions>
  <definition term="API Key (Bearer token)">
    Your Firecrawl API key for authentication. The connector sends it in the `Authorization: Bearer <key>` header to `https://api.firecrawl.dev`.
  </definition>
</definitions>


## Test connectors

You can test connectors when you create or edit the connector in Kibana.
The Firecrawl connector has the following actions:
<definitions>
  <definition term="scrape">
    Scrape a single URL and extract content (for example, Markdown or HTML).
    - `url` (required): The URL to scrape.
    - `formats` (optional): Output formats: `markdown`, `html`, `links`, `screenshot`, `extract`. Defaults to Markdown.
    - `onlyMainContent` (optional): Return only main content, excluding navigation and footer elements. Defaults to true.
    - `waitFor` (optional): Delay in milliseconds before fetching (useful for JavaScript-rendered pages).
  </definition>
  <definition term="search">
    Search the web and optionally get full content from results.
    - `query` (required): Search query string.
    - `limit` (optional): Maximum number of results (1 to 100). Defaults to 5.
  </definition>
  <definition term="map">
    Map a website to discover indexed URLs.
    - `url` (required): Base URL to map.
    - `search` (optional): Search term to filter or order URLs by relevance.
    - `limit` (optional): Maximum URLs to return. Defaults to 5000.
    - `includeSubdomains` (optional): Include subdomains. Defaults to true.
    - `ignoreQueryParameters` (optional): Deduplicate by path only. Defaults to true.
  </definition>
  <definition term="crawl">
    Start an asynchronous crawl of a website. Returns a job ID. Use `getCrawlStatus` to poll for results.
    - `url` (required): Base URL to start crawling from.
    - `limit` (optional): Maximum pages to crawl. Defaults to 100.
    - `maxDiscoveryDepth` (optional): Maximum discovery depth.
    - `allowExternalLinks` (optional): Follow external links. Defaults to false.
  </definition>
  <definition term="getCrawlStatus">
    Get the status and results of a crawl job.
    - `id` (required): The crawl job ID (UUID) returned from the `crawl` action.
  </definition>
</definitions>


## Connector networking configuration

Use the [Action configuration settings](/docs/reference/kibana/configuration-reference/alerting-settings#action-settings) to customize connector networking, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.

## Get API credentials

To use the Firecrawl connector:
1. Sign up at [Firecrawl](https://www.firecrawl.dev) or log in to your account.
2. Go to [API keys](https://www.firecrawl.dev/app/api-keys) in the Firecrawl dashboard.
3. Create an API key or copy an existing one (for example, `fc-...`).
4. Enter the API key in the **API Key** field when configuring the Firecrawl connector in Kibana.

Rate limits and billing depend on your Firecrawl plan. Refer to [Firecrawl billing](https://docs.firecrawl.dev/billing) for details.