---
title: Lists
summary: Lists allow you to manage lists at the account level and workspace level for use with Next-Gen WAF rules.
url: https://www.fastly.com/documentation/reference/api/ngwaf/lists
---

Lists allow you to manage lists at the account level and workspace level for use with Next-Gen WAF rules.

## Data model

| Field | Type | Description |
|-------|------|-------------|
| `created_at` | string | Date the list was created. (Read-only) |
| `description` | string | The description of the list. |
| `entries` | array | Array of strings. |
| `id` | string | The ID of the list. (Read-only) |
| `name` | string | The name of the list. |
| `reference_id` | string | The reference ID (slug) of the list. (Read-only) |
| `scope` | object | The scope of the list. |
| `type` | string | The type of list. - string - wildcard - ip - country - signal. |
| `updated_at` | string | Date the list was last updated. (Read-only) |

## API endpoints

### List all account-level lists

**GET** `/ngwaf/v1/lists`

List all account-level lists.

### Create a new account-level list

**POST** `/ngwaf/v1/lists`

Add a new list.

### Get account-level list by ID

**GET** `/ngwaf/v1/lists/{listId}`

Get account-level list by ID.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `listId` | string | path | Yes | The ID of the list to update. |

### Remove an account-level list

**DELETE** `/ngwaf/v1/lists/{listId}`

Delete an account-level list.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `listId` | string | path | Yes | The ID of the list to update. |

### Update account-level list

**PATCH** `/ngwaf/v1/lists/{listId}`

Update account-level list.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `listId` | string | path | Yes | The ID of the list to update. |

### List all workspace-level lists

**GET** `/ngwaf/v1/workspaces/{workspaceId}/lists`

List all workspace-level lists.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `workspaceId` | string | path | Yes | The ID of the workspace the list belongs to. |

### Create a new workspace-level list

**POST** `/ngwaf/v1/workspaces/{workspaceId}/lists`

Add a new list for the given workspace.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `workspaceId` | string | path | Yes | The ID of the workspace the list belongs to. |

### Get workspace-level list by ID

**GET** `/ngwaf/v1/workspaces/{workspaceId}/lists/{listId}`

Get workspace-level list by ID for the given workspace.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `listId` | string | path | Yes | The ID of the list to update. |
| `workspaceId` | string | path | Yes | The ID of the workspace the list belongs to. |

### Remove a workspace-level list

**DELETE** `/ngwaf/v1/workspaces/{workspaceId}/lists/{listId}`

Delete a workspace-level list for the given workspace.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `listId` | string | path | Yes | The ID of the list to update. |
| `workspaceId` | string | path | Yes | The ID of the workspace the list belongs to. |

### Update workspace-level list

**PATCH** `/ngwaf/v1/workspaces/{workspaceId}/lists/{listId}`

Update workspace-level list for the given workspace.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `listId` | string | path | Yes | The ID of the list to update. |
| `workspaceId` | string | path | Yes | The ID of the workspace the list belongs to. |