> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# redirect.pizza

> Manage redirect.pizza redirects, domains, and team usage, and test redirects or generate QR codes.

![redirect.pizza logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/redirect_pizza.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=4bb9d59a476ffb5af54caa0668c87d09)

* **Category:** url shortener
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 14
* **Triggers:** 0
* **Slug:** `REDIRECT_PIZZA`
* **Version:** 20261030\_00

## Tools

> [accordion] Check Domain DNS
>
> **Slug:** `REDIRECT_PIZZA_CHECK_DOMAIN_DNS`
>
> Ask redirect.pizza to re-check DNS propagation for a domain and return its refreshed DNS and SSL state.
>
> #### Input Parameters
>
> **domain\_id** `integer` *required*
>
> Domain ID whose DNS state should be refreshed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Redirect
>
> **Slug:** `REDIRECT_PIZZA_CREATE_REDIRECT`
>
> Create a new redirect from one or more source hostnames or URLs to a fixed destination URL using Free-safe redirect types.
>
> #### Input Parameters
>
> **tags** `array`
>
> Tags used to organize the redirect and restrict API-token access.
>
> **notes** `string`
>
> Optional internal notes about the redirect.
>
> **sources** `array` *required*
>
> Incoming source hostnames or URLs owned or controlled by the account.
>
> **tracking** `boolean`
>
> Whether to enable redirect hit tracking.
>
> **destination** `string` *required*
>
> Fixed HTTP or HTTPS destination URL.
>
> **redirect\_type** `string ("permanent" | "temporary" | "permanent:308" | "temporary:307")` *required*
>
> Free-safe redirect behavior: permanent (301), temporary (302), permanent:308 (308), or temporary:307 (307).
>
> **uri\_forwarding** `boolean`
>
> Whether to append the source request path to the destination path.
>
> **keep\_query\_string** `boolean`
>
> Whether to forward the source request query string to the destination.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Redirect
>
> **Slug:** `REDIRECT_PIZZA_DELETE_REDIRECT`
>
> Permanently delete a redirect and its generated domain association by redirect ID.
>
> #### Input Parameters
>
> **redirect\_id** `integer` *required*
>
> Redirect ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate QR Code
>
> **Slug:** `REDIRECT_PIZZA_GENERATE_QR_CODE`
>
> Generate a QR code for an HTTP or HTTPS URL as JSON-embedded PNG data or a downloadable PNG, SVG, or EPS file.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> HTTP or HTTPS URL to encode in the QR code.
>
> **format** `string ("json" | "png" | "svg" | "eps")`
>
> Output format. json returns provider metadata and a base64 PNG data URI; png, svg, and eps return a downloadable file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Domain
>
> **Slug:** `REDIRECT_PIZZA_GET_DOMAIN`
>
> Retrieve one domain's required DNS records, verification status, security settings, and SSL state.
>
> #### Input Parameters
>
> **domain\_id** `integer` *required*
>
> Domain ID returned by a redirect or domain list response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Redirect
>
> **Slug:** `REDIRECT_PIZZA_GET_REDIRECT`
>
> Retrieve one redirect and its sources, destination, domains, options, and current pause state by redirect ID.
>
> #### Input Parameters
>
> **redirect\_id** `integer` *required*
>
> Redirect ID returned by create or list operations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Team
>
> **Slug:** `REDIRECT_PIZZA_GET_TEAM`
>
> Return the connected token's team identity and hostname, hit, and user quota usage.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Domains
>
> **Slug:** `REDIRECT_PIZZA_LIST_DOMAINS`
>
> List domains created by redirects, including DNS requirements, verification, automatic-DNS availability, and SSL state.
>
> #### Input Parameters
>
> **per\_page** `integer`
>
> Maximum domains to return in this page (1-100).
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Redirects
>
> **Slug:** `REDIRECT_PIZZA_LIST_REDIRECTS`
>
> List redirects visible to the connected API token, including source, destination, state, and domain details.
>
> #### Input Parameters
>
> **per\_page** `integer`
>
> Maximum redirects to return in this page (1-100).
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Redirect Paused
>
> **Slug:** `REDIRECT_PIZZA_SET_REDIRECT_PAUSED`
>
> Pause or resume all source URLs belonging to one redirect.
>
> #### Input Parameters
>
> **paused** `boolean` *required*
>
> Set true to pause all sources or false to resume them.
>
> **redirect\_id** `integer` *required*
>
> Redirect ID whose sources should be paused or resumed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Redirect Source Paused
>
> **Slug:** `REDIRECT_PIZZA_SET_REDIRECT_SOURCE_PAUSED`
>
> Pause or resume one source URL within a redirect without changing its other sources.
>
> #### Input Parameters
>
> **paused** `boolean` *required*
>
> Set true to pause this source or false to resume it.
>
> **source\_id** `integer` *required*
>
> Source ID returned in a redirect response.
>
> **redirect\_id** `integer` *required*
>
> Parent redirect ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Test Redirect URL
>
> **Slug:** `REDIRECT_PIZZA_TEST_REDIRECT_URL`
>
> Test one HTTP redirect hop for a public URL and return status, redirect details, timing, errors, and the next URL to test if present.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Public HTTP or HTTPS URL to test for one redirect hop. Literal IP addresses must be globally routable; hostnames are resolved by redirect.pizza.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Redirect
>
> **Slug:** `REDIRECT_PIZZA_UPDATE_REDIRECT`
>
> Replace a redirect's configurable sources, fixed destination, redirect type, and options.
>
> #### Input Parameters
>
> **tags** `array`
>
> Replacement tags for organizing the redirect and restricting token access.
>
> **notes** `string`
>
> Replacement internal notes for the redirect.
>
> **sources** `array` *required*
>
> Complete replacement list of incoming source hostnames or URLs.
>
> **tracking** `boolean`
>
> Whether redirect hit tracking is enabled.
>
> **destination** `string` *required*
>
> Fixed HTTP or HTTPS destination URL; conditional paid-plan destinations are excluded.
>
> **redirect\_id** `integer` *required*
>
> Redirect ID to update.
>
> **redirect\_type** `string ("permanent" | "temporary" | "permanent:308" | "temporary:307")` *required*
>
> Free-safe HTTP redirect behavior: permanent (301), temporary (302), permanent:308, or temporary:307.
>
> **uri\_forwarding** `boolean`
>
> Whether to append the source request path to the destination path.
>
> **keep\_query\_string** `boolean`
>
> Whether to forward the source request query string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert Redirect
>
> **Slug:** `REDIRECT_PIZZA_UPSERT_REDIRECT`
>
> Create a redirect or update the uniquely matching redirect while retaining that redirect's existing sources.
>
> #### Input Parameters
>
> **tags** `array`
>
> Tags used to organize the redirect and restrict API-token access.
>
> **notes** `string`
>
> Optional internal notes about the redirect.
>
> **sources** `array` *required*
>
> Incoming source hostnames or URLs owned or controlled by the account.
>
> **tracking** `boolean`
>
> Whether to enable redirect hit tracking.
>
> **destination** `string` *required*
>
> Fixed HTTP or HTTPS destination URL.
>
> **redirect\_type** `string ("permanent" | "temporary" | "permanent:308" | "temporary:307")` *required*
>
> Free-safe redirect behavior: permanent (301), temporary (302), permanent:308 (308), or temporary:307 (307).
>
> **uri\_forwarding** `boolean`
>
> Whether to append the source request path to the destination path.
>
> **keep\_query\_string** `boolean`
>
> Whether to forward the source request query string to the destination.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
