1. Home
  2. Interfaces
  3. IURLConfig

IURLConfig

config

Description

Defines the configuration needed for URL-related options when creating Cloudinary URL Learn more: URL Parameters

Properties
Name Type Attributes Description
cname string <optional>
secureDistribution string <optional>
privateCdn boolean <optional>
signUrl boolean <optional>
longUrlSignature boolean <optional>
shorten boolean <optional>
useRootPath boolean <optional>
secure boolean <optional>
forceVersion boolean <optional>
analytics boolean <optional>
queryParams object | string <optional>
Examples

			import Cloudinary from '@cloudinary/url-gen';
			// The Cloudinary Instance accepts a URLConfig under the `url` key
			const cld = new Cloudinary({
			 // the cloudConfig
			 cloud: {
			      cloudName: 'demo'
			  },
			  // the urlConfig
			  url: {
			      cname: 'www.example.com',
			      forceVersion: true
			  }
			});
Details

config/interfaces/Config/IURLConfig.ts, line 3

Members

cname :string

Description

Replace the asset domain when secure is false http://{cname}/{cloudName}/image/upload

Details
string

config/interfaces/Config/IURLConfig.ts, line 35

secureDistribution :string

Description

Replace the asset domain when secure is true https://{cname}/{cloudName}/image/upload

Details
string

config/interfaces/Config/IURLConfig.ts, line 42

privateCdn :boolean

Description

When Cname or secureDistribution are provided (with secure accordingly), privateCdn removes the cloudName from the URL:

https://{cname|secureDistribution}/image/upload instead of https://{cname|secureDistribution}/{cloudName}image/upload

When privateCdn is provided without cname or secure distribution, it moves the cloudName from the URL to the domain:

https://{cloudName}-res.cloudinary.com/image/upload instead of https://res.cloudinary.com/{cloudName}/image/upload

Details
boolean

config/interfaces/Config/IURLConfig.ts, line 49

secure :boolean

Description

use HTTPS or HTTP

Details
boolean

config/interfaces/Config/IURLConfig.ts, line 67

analytics :boolean

Description

Whether or not to include the SDK version signature in the URL

Details
boolean

config/interfaces/Config/IURLConfig.ts, line 73

signUrl :boolean

Description

Whether or not to sign the URL

Details
boolean

config/interfaces/Config/IURLConfig.ts, line 79

longUrlSignature :boolean

Description

Whether or not to use a long signature

Details
boolean

config/interfaces/Config/IURLConfig.ts, line 85

shorten :boolean

Description

Whether or not to shorten the URL

Details
boolean

config/interfaces/Config/IURLConfig.ts, line 91

useRootPath :boolean

Description

Whether or not to use the root path

Details
boolean

config/interfaces/Config/IURLConfig.ts, line 97

forceVersion :boolean

Description

Whether or not to force a version

Details
boolean

config/interfaces/Config/IURLConfig.ts, line 103

queryParams :Record.<string, (string|number|boolean)>|string

Description

Additional params to be added to the URL

Details
Record.<string, (string|number|boolean)> | string

config/interfaces/Config/IURLConfig.ts, line 109