API » History » Version 5

« Previous - Version 5/39 (diff) - Next » - Current version
Frank Sweetser, 04/06/2011 09:44 AM


Foreman Smart Proxy provides a REST API, communicating via JSON.

Please refer to this document for latest information about Foreman Smart Proxy API.

List of API's

Path REST Type Description Example Input JSON
/features GET List of features supported by the proxy
/dhcp GET Retrieve a list of subnets
/dhcp/ GET Retrieve subnets records
/dhcp/ GET Retrieve reservation information
/dhcp/ GET Provides an unused ip address in subnet
/dhcp/ POST creates new reservation in subnet {"hostname":string, "name":string, "filename":string, "ip":string, "nextserver":string, "mac":string}
/dhcp/ DELETE Deletes reservation from subnet
/dns POST Create a new DNS record {"fqdn":string(name/ip), "value":string(ip/reverse), "type":string(A/PTR)}
/dns/value DELETE remove value(ip or reverse) DNS record
/tftp/00:11:22:33:44:55 POST creates pxelinux configuration file for host with MAC address 00:11:22:33:44:55 {"syslinux_config":string}
/tftp/00:11:22:33:44:55 DELETE remove pxelinux configuration file for host with MAC address 00:11:22:33:44:55
/tftp/create_default POST creates a default pxelinux configuration file {"syslinux_config":string}
/tftp/fetch_boot_file POST creates a default pxelinux configuration file {"prefix":string, "path":string}
/puppet/ca GET list of all puppet certificates
/puppet/ca/autosign GET list of all puppet autosign entires
/puppet/ca/autosign/certname POST Add certname to Puppet autosign
/puppet/ca/autosign/certname DELETE Remove certname from Puppet autosign
/puppet/run POST Trigger puppet run / kick ["hostA", "hostB"]

Please raise a new issue if you need additional API's

Manually Calling the API

The API can be manually tested out using curl. GET types can be retrieved like any other URL. This one, for example, will return the HTML formatted page with the list of features enabled on the proxy.

curl http://localhost:8443/features

POST URLs, used to create objects or trigger actions, need to have the parameters passed in via the -d argument. This curl command line will trigger a puppetrun on

curl -d '' http://localhost:8443/puppet/run

Multiple post options may be specified by repeating the -d argument.

curl -d 'prefix=boot/CentOS-5-x86_64' -d 'path=http://yourlocalmirrorhere/pub/centos/5/os/x86_64/images/pxeboot/vmlinuz'  http://localhost:8443/tftp/fetch_boot_file

When you are creating an object, the identifier for the object is typically passed in as part of the URL, rather than as a POST value. For example, this will create a PXE boot configuration file for a host with MAC address 00:11:22:33:44:55, and will just put "Hello World" as the contents of the file. (A real world example would, of course, substitute a valid PXE boot configuration in the string.)

curl -d 'syslinux_config=Hello World' http://localhost:8443/tftp/00:11:22:33:44:55

In order to delete objects, you use the same URL as in the original creation, but pass it not POST values, and use the DELETE HTTP method instead of POST. This will delete the PXE boot configuration file created above.

curl -X DELETE http://localhost:8443/tftp/00:11:22:33:44:55