Skip to main content

Properties

NameTypeFormatDescriptionExample
idstringGUIDThe unique identifier of the redirect as a 128 bit GUID
sourceDomainstringURIThis specifies the domain from which the redirect should apply. If you want the redirect applied to all available domains then specify *
destinationstring-The URL or path you want to redirect to, either relative or a fully qualified URL e.g. https://www.my-new-site.com or /new-address/news
statusCodeinteger-This is the HTTP status code to be used for the redirect. Current supported status codes are 301: Moved Permanently and 302: Found301
appendSourcePathToDestinationboolean-This boolean property indicates whether the path of the source URL should be appended to the destination URL. If false, only the base destination URL is used.
matchobject-Container for match details
match.typestring-Specifies the type of match to be performed. Possible values are beginsWith, exactMatch and regex.
match.valuestring-The specific string or pattern that the source URL must match. If a regex is being used then it must be in PCRE format
versionobjectversionThe version information for the redirect

Example

JSON
{
	"id": "aab967ef-d2cf-43bb-96a4-c943b118c6f7",
	"sourceDomain": "example.com",
	"destination": "/new-path",
	"statusCode": 301,
	"appendSourcePathToDestination": false,
	"match": {
		"type": "beginsWith",
		"value": "/old-path"
	},
	"version": {
		"created": "2023-05-04T12:05:42.376971",
		"createdBy": "3376a167-3e97-407f-981b-600aecec0401",
		"modified": "2023-05-04T12:05:42.376975",
		"modifiedBy": "3376a167-3e97-407f-981b-600aecec0401"
	}
}

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request