Skip to content
Simple HTTP and REST client for Ruby, inspired by microframework syntax for specifying actions.
Find file
New pull request
Fetching latest commit...
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


REST Client – simple DSL for accessing HTTP and REST resources

A simple HTTP and REST client for Ruby, inspired by the Sinatra's microframework style of specifying actions: get, put, post, delete.

Usage: Raw URL

require 'rest_client'

RestClient.get ''

RestClient.get '' '', :param1 => 'one', :nested => { :param2 => 'two' } "", { 'x' => 1 }.to_json, :content_type => :json, :accept => :json

RestClient.delete ''


Yeah, that's right! This does multipart sends for you! '/data', :myfile =>"/path/to/image.jpg")

This does two things for you:

  • Auto-detects that you have a File value sends it as multipart

  • Auto-detects the mime of the file and sets it in the HEAD of the payload for each entry

If you are sending params that do not contain a File object but the payload needs to be multipart then: '/data', :foo => 'bar', :multipart => true

Usage: ActiveResource-Style

resource = ''

private_resource = '', 'user', 'pass'
private_resource.put'pic.jpg'), :content_type => 'image/jpg'

See RestClient::Resource module docs for details.

Usage: Resource Nesting

site ='')
site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'

See RestClient::Resource docs for details.


  • for results code between 200 and 206 a RestClient::Response will be returned

  • for results code between 301 and 303 the redirection will be automatically followed

  • for other result codes a RestClient::Exception holding the Response will be raised, a specific exception class will be thrown for know error codes

    RestClient.get ''
    ➔ RestClient::ResourceNotFound: RestClient::ResourceNotFound
      RestClient.get ''
    rescue => e
    ➔ "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\n<html><head>\n<title>404 Not Found</title>..."

Result handling

A block can be passed to the RestClient method, this block will then be called with the Response. Response.return! can be called to invoke the default response's behavior (return the Response for 200..206, raise an exception in other cases).

# Don't raise exceptions but return the response
RestClient.get(''){|response| response}
➔ "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\n<html><head>\n<title>404 Not Found</title>..."

# Manage a specific error code
RestClient.get(''){ |response|
  case response.code
  when 200
    p "It worked !"
  when 423
    raise SomeCustomExceptionIfYouWant

Non-normalized URIs.

If you want to use non-normalized URIs, you can normalize them with the addressable gem (

require 'addressable/uri'

Lower-level access

For cases not covered by the general API, you can use the RestClient::Resource class which provide a lower-level API, see the class' rdoc for more information.


The restclient shell command gives an IRB session with RestClient already loaded:

$ restclient
➔ RestClient.get ''

Specify a URL argument for get/post/put/delete on that resource:

$ restclient
➔ put '/resource', 'data'

Add a user and password for authenticated resources:

$ restclient user pass
➔ delete '/private/resource'

Create ~/.restclient for named sessions:

  url: http://localhost:4567
  url: http://localhost:9292
  username: user
  password: pass

Then invoke:

$ restclient private_site

Use as a one-off, curl-style:

$ restclient get > output_body

$ restclient put < input_body


To enable logging you can

  • set RestClient.log with a ruby Logger

  • or set an environment variable to avoid modifying the code (in this case you can use a file name, “stdout” or “stderr”):

    $ RESTCLIENT_LOG=stdout path/to/my/program

Either produces logs like this:

RestClient.get "http://some/resource"
# => 200 OK | text/html 250 bytes
RestClient.put "http://some/resource", "payload"
# => 401 Unauthorized | application/xml 340 bytes

Note that these logs are valid Ruby, so you can paste them into the restclient shell or a script to replay your sequence of rest calls.


All calls to RestClient, including Resources, will use the proxy specified by RestClient.proxy:

RestClient.proxy = ""
RestClient.get "http://some/resource"
# => response from some/resource as proxied through

Often the proxy url is set in an environment variable, so you can do this to use whatever proxy the system is configured to use:

RestClient.proxy = ENV['http_proxy']


Request and Response objects know about HTTP cookies, and will automatically extract and set headers for them as needed:

response = RestClient.get ''
# => {"_applicatioN_session_id" => "1234"}

response2 =
  {:param1 => "foo"},
  {:cookies => {:session_id => "1234"}}
# ...response body

SSL Client Certificates
  :ssl_client_cert  =>"cert.pem")),
  :ssl_client_key   =>"key.pem"), "passphrase, if any"),
  :ssl_ca_file      =>  "ca_certificate.pem",
  :verify_ssl       =>  OpenSSL::SSL::VERIFY_PEER

Self-signed certificates can be generated with the openssl command-line tool.


Written by Adam Wiggins, major modifications by Blake Mizerany, maintained by Julien Kirch

Patches contributed by many, including Chris Anderson, Greg Borenstein, Ardekantur, Pedro Belo, Rafael Souza, Rick Olson, Aman Gupta, François Beausoleil and Nick Plante.

Released under the MIT License:

Main page:


Mailing list: (send a mail to subscribe).

IRC: #rest-client at freenode

Something went wrong with that request. Please try again.