---
title: Header links
summary: >-
  Header links allow you to create clickable links in the Next-Gen WAF interface
  based on request or response header values.
url: https://www.fastly.com/documentation/reference/api/ngwaf/header-links
---

> **IMPORTANT:** The Fastly Next-Gen WAF API is only available to customers with access to the Next-Gen WAF product in the [Fastly control panel](https://manage.fastly.com). If you have access to the [Next-Gen WAF control panel](https://dashboard.signalsciences.net), check out the [Next-Gen WAF API](https://docs.fastly.com/signalsciences/api/).

## Data model

| Field | Type | Description |
|-------|------|-------------|
| `created_at` | string | Timestamp when the header link was created. |
| `header_context` | string | Whether this is a request header or response header. |
| `header_name` | string | HTTP header name (e.g., X-Request-ID, X-User-ID). |
| `id` | string | Header link identifier. |
| `link_label` | string | Display label for the link shown in UI (e.g., "Kibana"). |
| `link_url_template` | string | Link template URL with {{value}} placeholder for the header value. |
| `updated_at` | string | Timestamp when the header link was last updated. |

## API endpoints

### List header links

**GET** `/ngwaf/v1/workspaces/{workspace_id}/header-links`

Returns all header links in a workspace.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `workspace_id` | string | path | Yes | The ID of the workspace. |

### Create header link

**POST** `/ngwaf/v1/workspaces/{workspace_id}/header-links`

Creates a header link in a workspace.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `workspace_id` | string | path | Yes | The ID of the workspace. |

### Get header link

**GET** `/ngwaf/v1/workspaces/{workspace_id}/header-links/{header_link_id}`

Retrieves a header link by ID.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `header_link_id` | string | path | Yes | Header link identifier. |
| `workspace_id` | string | path | Yes | The ID of the workspace. |

### Update header link

**PUT** `/ngwaf/v1/workspaces/{workspace_id}/header-links/{header_link_id}`

Updates a header link.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `header_link_id` | string | path | Yes | Header link identifier. |
| `workspace_id` | string | path | Yes | The ID of the workspace. |

### Delete header link

**DELETE** `/ngwaf/v1/workspaces/{workspace_id}/header-links/{header_link_id}`

Removes a header link by ID.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `header_link_id` | string | path | Yes | Header link identifier. |
| `workspace_id` | string | path | Yes | The ID of the workspace. |