---
canonical_url: "https://docs.composio.dev/toolkits/redirect_pizza"
markdown_url: "https://docs.composio.dev/toolkits/redirect_pizza.md"
product: "platform"
version: null
last_updated: null
---

# redirect.pizza

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

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

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_id` | integer | Yes | Domain ID whose DNS state should be refreshed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags used to organize the redirect and restrict API-token access. |
| `notes` | string | No | Optional internal notes about the redirect. |
| `sources` | array | Yes | Incoming source hostnames or URLs owned or controlled by the account. |
| `tracking` | boolean | No | Whether to enable redirect hit tracking. |
| `destination` | string | Yes | Fixed HTTP or HTTPS destination URL. |
| `redirect_type` | string ("permanent" | "temporary" | "permanent:308" | "temporary:307") | Yes | Free-safe redirect behavior: permanent (301), temporary (302), permanent:308 (308), or temporary:307 (307). |
| `uri_forwarding` | boolean | No | Whether to append the source request path to the destination path. |
| `keep_query_string` | boolean | No | Whether to forward the source request query string to the destination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Redirect

**Slug:** `REDIRECT_PIZZA_DELETE_REDIRECT`

Permanently delete a redirect and its generated domain association by redirect ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `redirect_id` | integer | Yes | Redirect ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | HTTP or HTTPS URL to encode in the QR code. |
| `format` | string ("json" | "png" | "svg" | "eps") | No | Output format. json returns provider metadata and a base64 PNG data URI; png, svg, and eps return a downloadable file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Domain

**Slug:** `REDIRECT_PIZZA_GET_DOMAIN`

Retrieve one domain's required DNS records, verification status, security settings, and SSL state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_id` | integer | Yes | Domain ID returned by a redirect or domain list response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `redirect_id` | integer | Yes | Redirect ID returned by create or list operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Team

**Slug:** `REDIRECT_PIZZA_GET_TEAM`

Return the connected token's team identity and hostname, hit, and user quota usage.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Domains

**Slug:** `REDIRECT_PIZZA_LIST_DOMAINS`

List domains created by redirects, including DNS requirements, verification, automatic-DNS availability, and SSL state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `per_page` | integer | No | Maximum domains to return in this page (1-100). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Redirects

**Slug:** `REDIRECT_PIZZA_LIST_REDIRECTS`

List redirects visible to the connected API token, including source, destination, state, and domain details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `per_page` | integer | No | Maximum redirects to return in this page (1-100). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Redirect Paused

**Slug:** `REDIRECT_PIZZA_SET_REDIRECT_PAUSED`

Pause or resume all source URLs belonging to one redirect.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `paused` | boolean | Yes | Set true to pause all sources or false to resume them. |
| `redirect_id` | integer | Yes | Redirect ID whose sources should be paused or resumed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `paused` | boolean | Yes | Set true to pause this source or false to resume it. |
| `source_id` | integer | Yes | Source ID returned in a redirect response. |
| `redirect_id` | integer | Yes | Parent redirect ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Redirect

**Slug:** `REDIRECT_PIZZA_UPDATE_REDIRECT`

Replace a redirect's configurable sources, fixed destination, redirect type, and options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Replacement tags for organizing the redirect and restricting token access. |
| `notes` | string | No | Replacement internal notes for the redirect. |
| `sources` | array | Yes | Complete replacement list of incoming source hostnames or URLs. |
| `tracking` | boolean | No | Whether redirect hit tracking is enabled. |
| `destination` | string | Yes | Fixed HTTP or HTTPS destination URL; conditional paid-plan destinations are excluded. |
| `redirect_id` | integer | Yes | Redirect ID to update. |
| `redirect_type` | string ("permanent" | "temporary" | "permanent:308" | "temporary:307") | Yes | Free-safe HTTP redirect behavior: permanent (301), temporary (302), permanent:308, or temporary:307. |
| `uri_forwarding` | boolean | No | Whether to append the source request path to the destination path. |
| `keep_query_string` | boolean | No | Whether to forward the source request query string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags used to organize the redirect and restrict API-token access. |
| `notes` | string | No | Optional internal notes about the redirect. |
| `sources` | array | Yes | Incoming source hostnames or URLs owned or controlled by the account. |
| `tracking` | boolean | No | Whether to enable redirect hit tracking. |
| `destination` | string | Yes | Fixed HTTP or HTTPS destination URL. |
| `redirect_type` | string ("permanent" | "temporary" | "permanent:308" | "temporary:307") | Yes | Free-safe redirect behavior: permanent (301), temporary (302), permanent:308 (308), or temporary:307 (307). |
| `uri_forwarding` | boolean | No | Whether to append the source request path to the destination path. |
| `keep_query_string` | boolean | No | Whether to forward the source request query string to the destination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |