HTTP Put

preview

We're still working on this feature, but we'd love for you to try it out!

This feature is currently provided as part of a preview program pursuant to our pre-release policies.

This page provides a comprehensive reference for http put available in the workflow automation actions catalog. These actions enable you to http put request operations.

Prerequisites

Before using HTTP actions in workflow automation, ensure you have:

Target API endpoint URLs.
Any required authentication credentials (API keys, tokens, etc.).
Understanding of the API request/response formats.

Tip

HTTP actions support secret syntax for any header value, allowing you to securely pass sensitive data like API keys. See secrets management for more information.

Automatic request headers

All HTTP requests performed by Workflow Automation automatically include the following headers:

Header	Format
`x-abuse-info`	`Request sent by a New Relic WorkflowAutomation. {runId}` where `{runId}` is the workflow run ID
`User-Agent`	`NewRelic/WorkflowAutomation (region={region}; https://newrelic.com ; support@newrelic.com)` where `{region}` is the New Relic region

Create resource at URI

Performs an HTTP PUT request to update data at an API endpoint.

Important

If you need to pass sensitive data to an input, for example an Api-Key header, you can use values stored via the secretsManagementCreateSecret NerdGraph mutation.

Example:

{
  "inputs": [
    {
      "key": "headers",
      "value": "{\"Api-Key\": \"${{ :secrets:NR_API_KEY }}\"}"
    }
  ]
}

Input Field	Optionality	Type	Description
url	Required	String	The target URL for the request. The scheme must be included: `https://example.com`
urlParams	Optional	Map	The query parameters to append to the URL. Takes a stringified JSON object.
headers	Optional	Map	The headers to add to the request. Takes a stringified JSON object.
body	Optional	String	The request body.
selectors	Optional	List	The selectors to get only the specified parameters as output.

Output Field	Type	Description
responseBody	String	The body of the response.
statusCode	Int	The HTTP status code of the response.
success	Boolean	Status of the request.
errorMessage	String	Failure reason as message.

Workflow definition	Inputs	Outputs
`name: httpPutTest steps: - name: query type: action action: http.put version: 1 inputs: url: ${{ .workflowInputs.url }} urlParams: ${{ .workflowInputs.urlParams }} headers: ${{ .workflowInputs.headers }} body: ${{ .workflowInputs.body }} selectors: ${{ .workflowInputs.selectors }}`	`{ "inputs": [ { "key": "url", "value": "https://example.com" }, { "key": "headers", "value": "{\"Content-Type\":\"application/json\"}" }, { "key": "urlParams", "value": "{\"foo\": \"bar\"}" }, { "key": "body", "value": "{\"foo\": \"bar\"}" }, { "key": "selectors", "value": "[{\"name\": \"responseBody\", \"expression\": \".responseBody\"}, {\"name\": \"statusCode\", \"expression\": \".statusCode\"}]" } ] }`	`Success case: { "responseBody": "", "statusCode": 200 "success": true } Failure case: { "errorMessage": "An unexpected error failed to call http post endpoint.", "success": false }`

Workflow definition

Inputs

Outputs

name: httpPutTest

  steps:
    - name: query
      type: action
      action: http.put
      version: 1
      inputs:
        url: ${{ .workflowInputs.url }}
        urlParams: ${{ .workflowInputs.urlParams }}
        headers: ${{ .workflowInputs.headers }}
        body: ${{ .workflowInputs.body }}
        selectors: ${{ .workflowInputs.selectors }}

{
    "inputs": [
      {
        "key": "url",
        "value": "https://example.com"
      },
      {
        "key": "headers",
        "value": "{\"Content-Type\":\"application/json\"}"
      },
      {
        "key": "urlParams",
        "value": "{\"foo\": \"bar\"}"
      },
      {
        "key": "body",
        "value": "{\"foo\": \"bar\"}"
      },
      {
        "key": "selectors",
        "value": "[{\"name\": \"responseBody\", \"expression\": \".responseBody\"}, {\"name\": \"statusCode\", \"expression\": \".statusCode\"}]"
      }
    ]
  }

Success case:
    {
      "responseBody": "",
      "statusCode": 200
      "success": true
    }

  Failure case:
    {
      "errorMessage": "An unexpected error failed to call http post endpoint.",
      "success": false
    }

preview

Prerequisites.css-21sua1{background:none;border:none;width:0;padding:0;}

Tip

Automatic request headers

Create resource at URI

Important

Prerequisites