Use the http_request resource to send an HTTP request (GET
, PUT
, POST
, DELETE
, HEAD
, or OPTIONS
) with an arbitrary message. This resource is often useful when custom callbacks are necessary.
A http_request resource block sends HTTP requests with an arbitrary message. For example, send a DELETE
request to 'http://www.chef.io/some_page?message=please_delete_me'
.
http_request 'please_delete_me' do url 'http://www.chef.io/some_page' action :delete end
The full syntax for all of the properties that are available to the http_request resource is:
http_request 'name' do headers Hash message Object # defaults to 'name' if not specified notifies # see description provider Chef::Provider::HttpRequest subscribes # see description url String action Symbol # defaults to :get if not specified end
where
http_request
is the resourcename
is the name of the resource block:action
identifies the steps the chef-client will take to bring the node into the desired stateheaders
, message
, provider
, and url
are properties of this resource, with the Ruby type shown. See “Properties” section below for more information about all of the properties that may be used with this resource.This resource has the following actions:
:delete
DELETE
request.:get
GET
request.:head
HEAD
request.:nothing
:options
OPTIONS
request.:post
POST
request.:put
PUT
request.This resource has the following properties:
headers
Ruby Type: Hash
A Hash of custom headers. Default value: {}
.
ignore_failure
Ruby Types: TrueClass, FalseClass
Continue running a recipe if a resource fails for any reason. Default value: false
.
message
Ruby Type: Object
The message that is sent by the HTTP request. Default value: the name
of the resource block See “Syntax” section above for more information.
notifies
Ruby Type: Symbol, ‘Chef::Resource[String]’
A resource may notify another resource to take action when its state changes. Specify a 'resource[name]'
, the :action
that resource should take, and then the :timer
for that action. A resource may notifiy more than one resource; use a notifies
statement for each resource to be notified.
A timer specifies the point during the chef-client run at which a notification is run. The following timers are available:
:before
:delayed
:immediate
, :immediately
The syntax for notifies
is:
notifies :action, 'resource[name]', :timer
provider
Ruby Type: Chef Class
Optional. Explicitly specifies a provider.
retries
Ruby Type: Integer
The number of times to catch exceptions and retry the resource. Default value: 0
.
retry_delay
Ruby Type: Integer
The retry delay (in seconds). Default value: 2
.
subscribes
Ruby Type: Symbol, ‘Chef::Resource[String]’
A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a 'resource[name]'
, the :action
to be taken, and then the :timer
for that action.
A timer specifies the point during the chef-client run at which a notification is run. The following timers are available:
:before
:delayed
:immediate
, :immediately
The syntax for subscribes
is:
subscribes :action, 'resource[name]', :timer
url
Ruby Type: String
The URL to which an HTTP request is sent.
The following examples demonstrate various approaches for using resources in recipes. If you want to see examples of how Chef uses resources in recipes, take a closer look at the cookbooks that Chef authors and maintains: https://github.com/chef-cookbooks.
Send a GET request
http_request 'some_message' do url 'http://example.com/check_in' end
The message is sent as http://example.com/check_in?message=some_message
.
Send a POST request
To send a POST
request as JSON data, convert the message to JSON and include the correct content-type header. For example:
http_request 'posting data' do action :post url 'http://example.com/check_in' message ({:some => 'data'}.to_json) headers({'AUTHORIZATION' => "Basic #{ Base64.encode64('username:password')}", 'Content-Type' => 'application/data' }) end
Transfer a file only when the remote source changes
remote_file '/tmp/couch.png' do source 'http://couchdb.apache.org/img/sketch.png' action :nothing end http_request 'HEAD http://couchdb.apache.org/img/sketch.png' do message '' url 'http://couchdb.apache.org/img/sketch.png' action :head if File.exist?('/tmp/couch.png') headers 'If-Modified-Since' => File.mtime('/tmp/couch.png').httpdate end notifies :create, 'remote_file[/tmp/couch.png]', :immediately end
© Chef Software, Inc.
Licensed under the Creative Commons Attribution 3.0 Unported License.
The Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission.
We are not affiliated with, endorsed or sponsored by Chef Inc.
https://docs-archive.chef.io/release/12-13/resource_http_request.html