# Create pattern

| **Description** | Creates a simple pattern image to use for vector styling. |
| --------------- | --------------------------------------------------------- |
| **Endpoint**    | /image/pattern                                            |
| **Method**      | GET                                                       |

## Access Level Rules

| **Minimum Access Level** |   |
| ------------------------ | - |

## Processing Units

| **Minimum processing units** |   |
| ---------------------------- | - |

## Parameters

| Name              | Type                                                                                                                          | Required | Description   | Default |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------- | ------------- | ------- |
| `color`           | The main color of the pattern as a hex.                                                                                       | true     |               |         |
| `alpha`           | The transparency of the pattern on a 0 to 1 scale.                                                                            | true     |               |         |
| `type`            | The type of pattern image to create. Must be one of 'diagonal', 'horizontal', 'vertical', 'checkerboard', 'solid' or 'drive'. | true     |               |         |
| `width`           | The width of the repeated pattern in the image to create. May be left undefined for type 'solid'.                             | true     |               |         |
| `backgroundColor` | Optional background color of the pattern as a hex color.                                                                      | false    | Default null. |         |