The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

HTTP Request Plugin

httpRequest: Perform an HTTP Request and return a response object

Performs an HTTP request, and returns a response object.

Usage example:

        def response = httpRequest 'http://localhost:8080/jenkins/api/json?pretty=true'
        println("Status: "+response.status)
        println("Content: "+response.content)
        

If Jenkins restarts after the HTTP request is made, but before the HTTP response is received, the HTTP request fails.

validResponseCodes is a comma-separated string of single values or from:to ranges. For example '200' to accept only 200 or '201,301:303' to accept 201 as well as the range from 301 to 303.

The methods of the response object are:

  • String getContent(): The HTTP Response entity. This means the text of the response without the headers. If the response does not contain an entity, getContent() returns null.
  • int getStatus(): The HTTP status code.

  • url
    • Type: String
  • acceptType (optional)
    • Values: NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAM
  • authentication (optional)
    • Type: String
  • consoleLogResponseBody (optional)
    • Type: boolean
  • contentType (optional)
    • Values: NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAM
  • customHeaders (optional)
      Array/List
      Nested Object
    • name
      • Type: String
    • value
      • Type: String
    • maskValue
      • Type: boolean
  • httpMode (optional)
    • Values: GET, HEAD, POST, PUT, DELETE, OPTIONS, PATCH
  • httpProxy (optional)
    • Type: String
  • ignoreSslErrors (optional)
    • Type: boolean
  • multipartName (optional)
    • Type: String
  • outputFile (optional)
    • Type: String
  • quiet (optional)
    • Type: boolean
  • requestBody (optional)
    • Type: String
  • responseHandle (optional)
    • Values: NONE, LEAVE_OPEN, STRING
  • timeout (optional)
    • Type: int
  • uploadFile (optional)
    • Type: String
  • useSystemProperties (optional)
    • Type: boolean
  • validResponseCodes (optional)
    • Type: String
  • validResponseContent (optional)
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.