---
title: "How to use renderRequest"
canonical: "https://support.appfire.com/space/SUPPORT/89147224/How%20to%20use%20renderRequest"
format: markdown
---
# Summary

The **renderRequest** action is similar to **curl** in the sense that it allows you to send requests to a URL - in this case, an Atlassian server URL. The advantage to using **renderRequest** is that it does a number of things automatically under the covers including handling authentication, **findReplace** support, special handling variables, and can be used within CLI scripts and **run** actions. Some clients implement customization specific to the client.

# Parameters

> Macro (table-plus)
> 
> | **Parameter** | **Default** | **Description** |
> | --- | --- | --- |
> | **request** |  | Partial URL that will be added to the server URL. Required if there are no client specific parameters that will set the URL. |
> | **requestParameters** |  | - For non-post request, request parameter added to the URL. Example: **<span style="color: #000000">field1=value1&field2=value2&field3=value3</span>**<span style="color: #000000">.</span>
> - <span style="color: #000000">For post request, it is the post data which could be JSON data for example.</span> |
> | **requestType** | GET | HTTP request type like GET, POST, PUT, DELETE |
> | **type** | HTML | HTTP content type. Any value can be used. The following shortcut values are also available:<br>- HTML, XML, JSON, URL_ENCODED, FORM_URL_ENCODED, MULTIPART_RELATED |
> | **acceptType** | type | HTTP accept type if different than **type** parameter. |
> | **findReplace** |  | Response data is processed using the standard CLI find and replace support.<br>- Find and replace text. Value is a comma separated list of colon separated pairs. Single quote values containing a delimiter. |
> | **findReplaceRegex** |  | Response data is processed using the standard CLI find and replace support.<br>- Find and replace with regular expressions. Value is a comma separated list of colon separated pairs. Single quote values containing a delimiter. |
> | **file** |  | Allow output to a file. |
> | **encoding** |  | File encoding. |


# Client Specific Parameters

> Macro (table-plus)
> 
> | **Client** | **Parameter** | **Description** |
> | --- | --- | --- |
> | Jira | **project** | - Validates project - standard error if not valid.
> - Replaces @projectId@ with the project id in **requestParameters**.
> - If **request** is blank, will set to standard project url: **/browse/<project key>.** |
> | Jira | **issue** | - Validates issue - standard error if not valid.
> - If **request** is blank, will set to standard issue url: **/browse/<issue key>** |
> | Confluence | **space** | - Ignored unless **title** is specified. |
> | Confluence | **title** | - Ignored unless **space** is specified.
> - Validates page exists - standard error if not valid.
> - If **request** is blank, will set to the standard page url: **/pages/viewpage.action?pageId=<contentId>**
> - If **request** is not blank, replaces @contentId@ with the content id of the page in **requestParameters**. |
> | Bamboo | **plan ** | - Validates plan exists - standard error if not valid.
> - If **request** is blank, will set to standard plan url: **/browse/<plan key>**. |
> | Bamboo | **job ** | - Validates plan exists - standard error if not valid.
> - If **request** is blank, will set to standard job url: **/browse/<plan key>-<job key>** |
> | Bamboo | **number** | - Adds the job number to the url if plan or job has been provided. |
> 
> - No specific parameters are currently available for Bitbucket or HipChat
> - **renderRequest** is not currently available for Crucible and FishEye