Navigation: Catalog: UrlRedirects3 > Schemas

UrlRedirects: HubSpot URL Redirects

Get current redirectsReturns all existing URL redirects. Results can be limited and filtered by creation or updated date.

Catalog: UrlRedirects3

Schema: Redirects

Label: URL Redirects

Retrieve: true

Insert: true

Update: false

Delete: false

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function UrlRedirects. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Documentation
after	string	☐	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
archived	boolean	☐	Whether to return only results that have been archived.
createdAfter	datetime	☐	Only return redirects created after this date.
createdAt	datetime	☐	Only return redirects created on exactly this date.
createdBefore	datetime	☐	Only return redirects created before this date.
updatedAfter	datetime	☐	Only return redirects last updated after this date.
updatedAt	datetime	☐	Only return redirects last updated on exactly this date.
updatedBefore	datetime	☐	Only return redirects last updated before this date.

Columns of Table Function

The columns of the table function UrlRedirects are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.

Name	Data Type	Label	Required	Documentation
created	datetime	Created at	☐
destination	string	Destination	☐	The destination URL, where the target URL should be redirected if it matches the `routePrefix`.
id	string	ID	☐	The unique ID of this URL redirect.
isMatchFullUrl	boolean	Is Match Full URL	☐	Whether the `routePrefix` should match on the entire URL, including the domain.
isMatchQueryString	boolean	Is Match Query String	☐	Whether the `routePrefix` should match on the entire URL path, including the query string.
isOnlyAfterNotFound	boolean	Is Only after not Found	☐	Whether the URL redirect mapping should apply only if a live page on the URL isn't found. If False, the URL redirect mapping will take precedence over any existing page.
isPattern	boolean	Is Pattern	☐	Whether the `routePrefix` should match based on pattern.
isProtocolAgnostic	boolean	Is Protocol Agnostic	☐	Whether the `routePrefix` should match both HTTP and HTTPS protocols.
isTrailingSlashOptional	boolean	is Trailing Slash Optional	☐	Whether a trailing slash will be ignored.
precedence	int32	Precedence	☐	Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the lower precedence will be used.
redirectStyle	int32	Redirect Style	☐	The type of redirect to create. Options include: 301 (permanent), 302 (temporary), or 305 (proxy). Find more details [here](https://knowledge.hubspot.com/cos-general/how-to-redirect-a-hubspot-page).
routePrefix	string	Route Prefix	☐	The target incoming URL, path, or pattern to match for redirection.
updated	datetime	Updated at	☐

18-12-2024 20:09 Version 24.1.33-BETA+5180

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

HubSpot API Data Model

UrlRedirects: HubSpot URL Redirects

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information