---
title: "Generate Protected URL"
method: POST
path: "/urlgenerator/generateprotectedurl"
tags: ["URL Generator API"]
---

# Generate Protected URL

`POST /urlgenerator/generateprotectedurl`

Creates a unique URL (UURL), which you can use to protect a destination URL. Protection is necessary when the destination URL contains dynamic products, confidential products, and customer profile data. It also allows you to place various restrictions on the unique URL.<br /> For XML examples and schemas, see the [Additional Examples - Generate Protected URL](https://dev.cleverbridge.com/page/additional-examples-generate-protected-url).<br /><b>Warning</b> - Do not use protected URLs (UURLs) if you plan on creating a large quantity of URLs (10,000 or more). This can hurt the Cleverbridge platform and slow down your customers' checkout experience. If you plan on creating a large quantity of URLs, you should use session URLs (SURLs) or dynamic protected URLs (dynamic UURLs). For more information, contact Client Experience.

## Headers

- `Accept` 'application/json' | 'application/xml'
- `Content-Type` 'application/json' | 'application/xml'

## Request body

- CleverbridgeBackEndRestApiUrlGeneratorClassesGenerateProtectedUrlRequest
  - `AllowPurchaseOrder` boolean — Whether the customer can use purchase order as a payment method.
  - `AllowToChangeCart` boolean — Whether the customer can edit the quantity of the product in the cart.
  - `EnableFraudProtection` boolean — Fraud protection ensures that suspicious orders are inspected by the Cleverbridge anti-fraud team.
  - `MaxQuantity` integer, required — Maximum number of orders for which the link is valid. Only submitted orders are counted. When the maximum is reached, the link automatically expires, and no more orders are accepted. The number must be between 0 and 99999.
  - `ResultItemQuantity` integer — Number of protected URLs that are generated. The number must be between 1 and 1000.
  - `TargetUrl` string, required — The destination URL that you want to protect. The <code>TargetURL</code> string must be [url-encoded](https://www.w3schools.com/tags/ref_urlencode.asp) only for XML requests. For an overview of all supported parameters, see [List of Checkout Process Parameters](https://docs.cleverbridge.com/public/all/using-the-platform/list-of-checkout-process-parameters.htm?utm_source=developer-docs&amp;utm_medium=api-reference).
  - `ValidFrom` string, date-time — Start date and time according to [RFC3339](https://www.rfc-editor.org/info/rfc3339).
  - `ValidUntil` string, date-time — End date and time according to [RFC3339](https://www.rfc-editor.org/info/rfc3339).

## Response `200`

OK

- CleverbridgeBackEndRestApiUrlGeneratorClassesGenerateProtectedUrlResponse
  - `Items` CleverbridgeBackEndRestApiUrlGeneratorClassesUrlItem[] — List of generated URL items.
    - `Identifier` string — Identifier used in the URL.
    - `Url` string — The generated URL.
  - `ResultMessage` string — Optional result or error message.

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

[API](https://skmtc.net/cleverbridge/apis/backend-rest-apis.md) · [All operations](https://skmtc.net/cleverbridge/apis/backend-rest-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cleverbridge/backend-rest-apis/revisions/b7007b62f4c0/schema)