HTTP

This module exposes actions to request HTTP resources

Configuration

This module accepts no configuration.

Download the given file and save it

Arguments

Name	Type	Description
`url`	`string`	Url of the file to download
`headers`	`object`	Headers to use when sending the requests. i.e.
`verify_ssl`	`boolean`	Whether the SSL certificate must be verified. Default to true.

Outputs

Name	Type	Description
`file_path`	`string`	Absolute file path on disk (legacy, prefer file_relative_path for chaining with other modules)
`file_relative_path`	`string`	File path relative to the playbook data directory, suitable for use as input to other modules (e.g. Scan File)

Requests a resource at a specified URL and returns the response as Raw or JSON

Arguments

Name	Type	Description
`url`	`string`	Target URL of the HTTP request
`headers`	`object`	Headers to use when sending the requests. e.g.
`auth_type`	`string`	Type of authorization, if applicable
`auth_token`	`string`	Token for Bearer authentication
`auth_username`	`string`	Username for Basic and Digest authentications
`auth_password`	`string`	Password for Basic and Digest authentications
`method`	`string`	Method of the HTTP request
`data`	`string`	The body to attach to the request
`json`	`object`	The JSON to attach as body of the request
`params`	``	Query string parameters to append to the URL
`fail_on_http_error`	`boolean`	Fail when the HTTP query returns in error. Default to true.
`verify_ssl`	`boolean`	Wether the SSL certificate must be verified. Default to true.

Outputs

Name	Type	Description
`reason`	`string`	Textual reason of responded HTTP Status, e.g. 'Not Found' or 'OK'.
`status_code`	`integer`	Integer code of responded HTTP Status
`url`	`string`	Final URL of the triggered resource
`headers`	`object`	Headers used by the server in the response
`encoding`	`string`	Encoding of the response
`elapsed`	`number`	The amount of seconds elapsed between sending the request and the arrival of the response
`text`	`string`	Content of the response in unicode
`json`	`object`	JSON-encoded value of the response

Module HTTP v1.120.3