SecureURL API

Build links
with control.

SecureURL's API lets you create controlled, branded and trackable links programmatically. Authenticate your requests with an API key and create links directly from your application or from this documentation.

Base URL
Replace the URL below with your SecureURL API host. The endpoint shown in this documentation is /link/create.

Authentication

SecureURL accepts an API key through the X-API-Key HTTP header when creating links through the API.

API Key
X-API-Key
Your API key is used only by the browser to make the request when you click Send Request. It is not stored by this page.

Try it

Enter your API key, modify the JSON payload and execute the request directly from your browser.

POST /link/create
Ready
Request Body
Response 
{
  "status": "Ready",
  "message": "Execute the request to see the API response."
}

Request parameters

Parameters available for creating a SecureURL.

Name Type Description
url required string Original destination URL.
customPath string Optional custom path such as invoice/diwali-sale.
usagePolicies object Controls lifetime and usage behavior.
accessPolicies object Controls who can access the link.
notes string Optional internal note.
tags string[] Tags for organization and filtering.
linkMode enum REDIRECT, IFRAME, PROXY or MIRROR.
addShortCode boolean Whether SecureURL should generate a short code.
expireAt ISO-8601 Legacy expiration timestamp.
usageLimit object Legacy usage limit. Supports once, unlimited or a positive integer.
domain string Optional custom domain.

Link modes

The linkMode determines how SecureURL delivers the destination.

Mode Behavior
REDIRECT Navigates the visitor to the destination.
IFRAME Embeds the destination inside SecureURL.
PROXY Serves the destination through SecureURL.
MIRROR Serves a rewritten copy of the destination.

Response

A successful request returns the created or resolved SecureURL together with its configuration.

200 URL created successfully 
{
  "data": {
    "newUrl": "https://secure.indexrender.io/invoice/diwali-sale",
    "originalUrl": "https://example.com/products/item1",
    "customPath": "invoice/diwali-sale",
    "existing": false,
    "expireAt": null,
    "usageLimit": null,
    "notes": "Diwali campaign landing page",
    "tags": [
      "marketing",
      "diwali",
      "campaign"
    ],
    "linkMode": "REDIRECT",
    "isActive": true,
    "publicId": "f8K2mP9xQ7La3VnR6Tc1Zw",
    "usagePolicies": {},
    "accessPolicies": {},
    "createdBy": "API"
  },
  "message": "New URL created successfully"
}

cURL

The same request can be executed from your backend, terminal or CI/CD pipeline. 

curl -X POST "https://secure.indexrender.io/link/create" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "url": "https://example.com/products/item1",
    "customPath": "invoice/diwali-sale",
    "linkMode": "REDIRECT",
    "addShortCode": true,
    "notes": "Diwali campaign landing page",
    "tags": [
      "marketing",
      "diwali"
    ]
  }'
Copied