How can I perform HTTP POST requests from within a Jenkins Groovy script?

Question

I need to be able to create simple HTTP POST request during our Jenkins Pipeline builds. However I cannot use a simple curl sh script as I need it to work on Windows and Linux nodes, and I don't wish to enforce more tooling installs on nodes if I can avoid it.

The Groovy library in use in the Pipeline plugin we're using should be perfect for this task. There is an extension available for Groovy to perform simple POSTs called http-builder, but I can't for the life of me work out how to make use of it in Jenkins' Groovy installation.

If I try to use Grapes Grab to use it within a Pipeline script I get an error failing to do so, as seen here.

@Grapes(
    @Grab(group='org.codehaus.groovy.modules.http-builder', module='http-builder', version='0.7.1')
)

Maybe Grapes Grab isn't supported in the bundled version of Groovy Jenkins uses. Is it possible to simply download and add http-builder and its dependencies to the Jenkins Groovy installation that goes out to the nodes?

Possible duplicate http://stackoverflow.com/questions/25692515/groovy-built-in-rest-http-client — KeepCalmAndCarryOn, Mar 20 '16 at 20:33
Sadly not - This has more to do with how Jenkins integrates with it. Its not as simple as that. :/ — S.Richmond, Mar 20 '16 at 23:22

score 45 · Answer 1 · answered May 27 '16 at 01:28

45

For the Jenkin's Pipeline I would recommend installing the "HTTP-Request" plugin

It is nicely integrated in groovy so you can use it like this:

def response = httpRequest "http://httpbin.org/response-headers?param1=${param1}"

answered May 27 '16 at 01:28

Alfredo MS

605
6
8

1

Quite important limitation: it doesn't allow to add header programmatically. – eleven Jul 22 '16 at 15:13
18

It does: ``httpRequest customHeaders: [[name: 'FOO', value: 'BAR']], url: 'http://company.com'`` – LoganMzz Nov 07 '16 at 13:28
For security’ sake, be aware that: _"Every execution will log all parameters. Be careful to not pass private information such as passwords or personal information"_ (quoting official doc) – Enrique S. Filiage Mar 16 '21 at 12:45
Hi there, Do you happen to know how to send https request through httprequest plugin in jenkins pipeline, Since the certificate is private, so my https request will be blocked by certification error, are there any parameters as curl command has like -k?? Thanks! – Nina0408 Apr 08 '22 at 00:44

score 5 · Accepted Answer · answered Apr 08 '16 at 18:49

Perhaps I'm missing something, but why not just use standard java libraries that are already on the jenkins classpath?

import java.io.BufferedReader
import java.io.InputStreamReader
import java.io.OutputStreamWriter
import java.net.URL
import java.net.URLConnection

def sendPostRequest(urlString, paramString) {
    def url = new URL(urlString)
    def conn = url.openConnection()
    conn.setDoOutput(true)
    def writer = new OutputStreamWriter(conn.getOutputStream())

    writer.write(paramString)
    writer.flush()
    String line
    def reader = new BufferedReader(new     InputStreamReader(conn.getInputStream()))
    while ((line = reader.readLine()) != null) {
      println line
    }
    writer.close()
    reader.close()
}

sendPostRequest("http://www.something.com", "param1=abc&param2=def")

Because Script Security Plugin don't allow to call URL.openConnection() method — LoganMzz, Nov 07 '16 at 12:47

How can I perform HTTP POST requests from within a Jenkins Groovy script?

2 Answers2

Linked