# DockerHub

## Overview

| Property | Value |
|----------|-------|
| **Status** | private |
| **Method** | `GET` |
| **Endpoint** | `/v2/dockerhub` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/dockerhub |

## Access

This endpoint is **private**. Requests return HTTP 403 until access is granted. There is no self-serve request-access button. Open a support ticket from the dashboard Help desk (https://app.piloterr.com/app?returnTo=help-desk/tickets/new) and include the endpoint path, your use case, target fields, and expected volume.

## Description

Access and leverage comprehensive DockerHub data with Piloterr's API for improved development and automation.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/dockerhub' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Example

```json
{
  "data": [
    {
      "name": "Official Images",
      "description": "Explore high-quality images provided by Docker."
    },
    {
      "name": "Verified Publisher Images",
      "description": "Launch with confidence using publisher-submitted images."
    },
    {
      "name": "Community Images",
      "description": "Find community-contributed images for a variety of use cases."
    },
    {
      "name": "Play with Docker",
      "description": "A simple, interactive tutorial for getting started with Docker."
    },
    {
      "repositories_count": 695863
    }
  ],
  "status": "success"
}
```

## Documentation

## Overview
Access and leverage comprehensive DockerHub data with Piloterr's API for improved development and automation.

## Quickstart
```
GET https://api.piloterr.com/v2/dockerhub?query=example
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Search query or target identifier |

## Main use cases
- Integrate DockerHub data into enrichment, analytics, and monitoring pipelines
- Automate large-scale extraction from Dockerhub without maintaining scrapers
- Power internal dashboards and workflow automations with live Dockerhub data