Project

General

Profile

API » History » Version 30

Corey Osman, 08/09/2011 02:31 AM

1 1 Ohad Levy
h1. API
2
3 8 Ohad Levy
*NOTE*: Version of 0.1-6 or git develop branch are required to use the API
4
5 1 Ohad Levy
Foreman provides a "REST":http://en.wikipedia.org/wiki/Representational_State_Transfer API, communicating via JSON.
6
7 9 Ohad Levy
Please refer to this document for latest information about Foreman API.
8 1 Ohad Levy
9
Examples below are either via curl or ruby rest_client
10
11
most pages can be browsed via adding the format option to the url (at least for get requests), i.e.
12
13
<pre>
14 25 Romain Vrignaud
http://foreman/environments?format=json
15 1 Ohad Levy
</pre>
16
17
Or using HTTP Headers
18
<pre>
19
curl -H "Content-Type:application/json" -H "Accept:application/json"  http://foreman/hosts
20
</pre>
21
22
Output is JSON formatted, in the last example expect a similar output:
23
24
<pre>
25 10 Ohad Levy
[{"host":{"name":"pm1.local.net"}},{"host":{"name":"pm2.local.net"}}....]
26 1 Ohad Levy
</pre>
27
28 3 Ohad Levy
h2. List of API's
29 1 Ohad Levy
30 12 Justin Sherrill
|_.Path|_.REST Type|_.Description|_.Example Input JSON|  
31 14 Justin Sherrill
|_.Architectures |
32 13 Justin Sherrill
|/architectures|POST|Create a new Architecture|{architecture : {"name":string}}|
33 26 Romain Vrignaud
|/architectures/NAME|DELETE|Delete a Architecture||
34 18 Justin Sherrill
|/architectures|GET|Retrieve a list of Architectures||
35 26 Romain Vrignaud
|/architectures/NAME|PUT|Update an existing Architecture|{architecture : {"name":string}}|
36 16 Justin Sherrill
|_.Auth source ldaps |
37 15 Justin Sherrill
|/auth_source_ldaps|POST|Create a new Auth source ldap|{authsourceldap : {"account":string, "account_password":string, "attr_firstname":string, "attr_lastname":string, "attr_login":string, "attr_mail":string, "base_dn":string, "host":string, "name":string, "onthefly_register":string, "port":string, "tls":string, "type":string}}|
38 18 Justin Sherrill
|/auth_source_ldaps/ID|DELETE|Delete a Auth source ldap||
39
|/auth_source_ldaps|GET|Retrieve a list of Auth source ldaps||
40 15 Justin Sherrill
|/auth_source_ldaps/ID|PUT|Update an existing Auth source ldap|{authsourceldap : {"account":string, "account_password":string, "attr_firstname":string, "attr_lastname":string, "attr_login":string, "attr_mail":string, "base_dn":string, "host":string, "name":string, "onthefly_register":string, "port":string, "tls":string, "type":string}}|
41 16 Justin Sherrill
|_.Common parameters |
42 15 Justin Sherrill
|/common_parameters|POST|Create a new Common parameter|{commonparameter : {"name":string, "reference_id":int, "type":string, "value":string}}|
43 18 Justin Sherrill
|/common_parameters/ID|DELETE|Delete a Common parameter||
44
|/common_parameters|GET|Retrieve a list of Common parameters||
45 15 Justin Sherrill
|/common_parameters/ID|PUT|Update an existing Common parameter|{commonparameter : {"name":string, "reference_id":int, "type":string, "value":string}}|
46 16 Justin Sherrill
|_.Config templates |
47 19 Justin Sherrill
|/config_templates|POST|Create a new Config template|{configtemplate : {"hostgroup_id":int, "name":string, "snippet":boolean, "template":string, "template_kind_id":int}}|
48 18 Justin Sherrill
|/config_templates/ID|DELETE|Delete a Config template||
49
|/config_templates|GET|Retrieve a list of Config templates||
50 19 Justin Sherrill
|/config_templates/ID|PUT|Update an existing Config template|{configtemplate : {"hostgroup_id":int, "name":string, "snippet":boolean, "template":string, "template_kind_id":int}}|
51 15 Justin Sherrill
|/config_templates/build_pxe_default|GET|Deploy the default pxe template to all smart proxies.||
52 1 Ohad Levy
|_.Domains |
53
|/domains|POST|Create a new Domain|{domain : {"dns_id":int, "fullname":string, "name":string}}|
54 18 Justin Sherrill
|/domains/NAME|DELETE|Delete a Domain||
55
|/domains|GET|Retrieve a list of Domains||
56 15 Justin Sherrill
|/domains/NAME|PUT|Update an existing Domain|{domain : {"dns_id":int, "fullname":string, "name":string}}|
57 1 Ohad Levy
|_.Environments |
58
|/environments|POST|Create a new Environment|{environment : {"name":string}}|
59 18 Justin Sherrill
|/environments/NAME|DELETE|Delete a Environment||
60
|/environments|GET|Retrieve a list of Environments||
61 15 Justin Sherrill
|/environments/NAME|PUT|Update an existing Environment|{environment : {"name":string}}|
62 30 Corey Osman
|_.Fact names |
63
|/facts|Get| Gets list of all fact names|
64
|/facts/<factname>/values| GET | return all hosts with the given factname and its value|
65 16 Justin Sherrill
|_.Fact values |
66 15 Justin Sherrill
|/fact_values|POST|Create a new Fact value|{factvalue : {"fact_name_id":int, "host_id":int, "value":string}}|
67 18 Justin Sherrill
|/fact_values|GET|Retrieve a list of Fact values||
68 14 Justin Sherrill
|_.Hostgroups |
69 1 Ohad Levy
|/hostgroups|POST|Create a new Hostgroup|{hostgroup : {"architecture_id":int, "environment_id":int, "medium_id":int, "name":string, "operatingsystem_id":int, "ptable_id":int, "puppetmaster":string, "root_pass":string}}|
70 27 Romain Vrignaud
|/hostgroups/ID|DELETE|Delete a Hostgroup||
71 18 Justin Sherrill
|/hostgroups|GET|Retrieve a list of Hostgroups||
72 27 Romain Vrignaud
|/hostgroups/ID|PUT|Update an existing Hostgroup|{hostgroup : {"architecture_id":int, "environment_id":int, "medium_id":int, "name":string, "operatingsystem_id":int, "ptable_id":int, "puppetmaster":string, "root_pass":string}}|
73 1 Ohad Levy
|_.Hosts |
74
|/hosts|POST|Create a new Host|{host : {"architecture_id":int, "build":string, "comment":string, "disk":string, "domain_id":int, "enabled":string, "environment":string, "environment_id":int, "hostgroup_id":int, "installed_at":string, "ip":string, "last_compile":string, "last_freshcheck":string, "last_report":string, "mac":string, "medium_id":int, "model_id":int, "name":string, "operatingsystem_id":int, "owner_id":int, "owner_type":string, "ptable_id":int, "puppet_status":string, "puppetmaster":string, "root_pass":string, "serial":string, "source_file_id":int, "sp_ip":string, "sp_mac":string, "sp_name":string, "sp_subnet_id":int, "subnet_id":int}}|
75 18 Justin Sherrill
|/hosts/FQDN|DELETE|Delete a Host||
76
|/hosts|GET|Retrieve a list of Hosts||
77 15 Justin Sherrill
|/hosts/FQDN|PUT|Update an existing Host|{host : {"architecture_id":int, "build":string, "comment":string, "disk":string, "domain_id":int, "enabled":string, "environment":string, "environment_id":int, "hostgroup_id":int, "installed_at":string, "ip":string, "last_compile":string, "last_freshcheck":string, "last_report":string, "mac":string, "medium_id":int, "model_id":int, "name":string, "operatingsystem_id":int, "owner_id":int, "owner_type":string, "ptable_id":int, "puppet_status":string, "puppetmaster":string, "root_pass":string, "serial":string, "source_file_id":int, "sp_ip":string, "sp_mac":string, "sp_name":string, "sp_subnet_id":int, "subnet_id":int}}|
78
|/hosts/errors|GET|List of hosts in error state(only name)||
79
|/hosts/active|GET|List of active hosts (only name)||
80
|/hosts/out_of_sync|GET|List of out of sync hosts(only name)||
81
|/hosts/disabled|GET|List of disabled hosts(only name)||
82
|/hosts/FQDN/setBuild|GET|List of disabled hosts(only name)||
83
|/hosts/FQDN/facts|GET|Returns host facts||
84 23 Ohad Levy
|/hosts/FQDN/puppetclasses|GET|Returns host classes (direct and indirect(via a hostgroup)||
85 24 Ohad Levy
|/hosts/FQDN/reports|GET|Reports for host FQDN ||
86
|/hosts/FQDN/reports/last|GET|Last report for host FQDN ||
87 15 Justin Sherrill
|/hosts/FQDN/pxe_config|GET|Returns syslinux configuration file for fqdn||
88 1 Ohad Levy
|_.Hypervisors |
89
|/hypervisors|POST|Create a new Hypervisor|{hypervisor : {"kind":string, "name":string, "uri":string}}|
90 18 Justin Sherrill
|/hypervisors/ID|DELETE|Delete a Hypervisor||
91
|/hypervisors|GET|Retrieve a list of Hypervisors||
92 15 Justin Sherrill
|/hypervisors/ID|PUT|Update an existing Hypervisor|{hypervisor : {"kind":string, "name":string, "uri":string}}|
93 16 Justin Sherrill
|_.Lookup keys |
94 15 Justin Sherrill
|/lookup_keys|POST|Create a new Lookup key|{lookupkey : {"key":string}}|
95 18 Justin Sherrill
|/lookup_keys/ID|DELETE|Delete a Lookup key||
96
|/lookup_keys|GET|Retrieve a list of Lookup keys||
97 15 Justin Sherrill
|/lookup_keys/ID|PUT|Update an existing Lookup key|{lookupkey : {"key":string}}|
98 16 Justin Sherrill
|_.Medias |
99 1 Ohad Levy
|/media|POST|Create a new Medium|{medium : {"name":string, "path":string}}|
100 18 Justin Sherrill
|/media/ID|DELETE|Delete a Medium||
101
|/media|GET|Retrieve a list of Media||
102 15 Justin Sherrill
|/media/ID|PUT|Update an existing Medium|{medium : {"name":string, "path":string}}|
103 13 Justin Sherrill
|_.Models |
104 12 Justin Sherrill
|/models|POST|Create a new Model|{model : {"info":string, "name":string}}|
105 18 Justin Sherrill
|/models/ID|DELETE|Delete a Model||
106
|/models|GET|Retrieve a list of Models||
107 15 Justin Sherrill
|/models/ID|PUT|Update an existing Model|{model : {"info":string, "name":string}}|
108 13 Justin Sherrill
|_.Operatingsystems |
109
|/operatingsystems|POST|Create a new Operatingsystem|{operatingsystem : {"major":string, "minor":string, "name":string, "nameindicator":string, "release_name":string, "type":string}}|
110 18 Justin Sherrill
|/operatingsystems/ID|DELETE|Delete a Operatingsystem||
111
|/operatingsystems|GET|Retrieve a list of Operatingsystems||
112 1 Ohad Levy
|/operatingsystems/ID|PUT|Update an existing Operatingsystem|{operatingsystem : {"major":string, "minor":string, "name":string, "nameindicator":string, "release_name":string, "type":string}}|
113 20 Ohad Levy
|/operatingsystems/ID/bootfiles?media=<media_name>&architecture=x86_64|GET|tftp boot files and their respective urls (where they can be found)||
114 15 Justin Sherrill
|_.Ptables |
115 13 Justin Sherrill
|/ptables|POST|Create a new Ptable|{ptable : {"layout":string, "name":string, "operatingsystem_id":int}}|
116 18 Justin Sherrill
|/ptables/ID|DELETE|Delete a Ptable||
117
|/ptables|GET|Retrieve a list of Ptables||
118 13 Justin Sherrill
|/ptables/ID|PUT|Update an existing Ptable|{ptable : {"layout":string, "name":string, "operatingsystem_id":int}}|
119 15 Justin Sherrill
|_.Puppetclasses |
120 13 Justin Sherrill
|/puppetclasses|POST|Create a new Puppetclass|{puppetclass : {"name":string, "nameindicator":string, "operatingsystem_id":int}}|
121 18 Justin Sherrill
|/puppetclasses/ID|DELETE|Delete a Puppetclass||
122
|/puppetclasses|GET|Retrieve a list of Puppetclasses||
123 13 Justin Sherrill
|/puppetclasses/ID|PUT|Update an existing Puppetclass|{puppetclass : {"name":string, "nameindicator":string, "operatingsystem_id":int}}|
124 15 Justin Sherrill
|_.Reports |
125 18 Justin Sherrill
|/reports|POST|Create a new Report|{report : {"host_id":int, "metrics":string, "reported_at":string, "status":string}}|
126 1 Ohad Levy
|/reports/ID|DELETE|Delete a Report||
127 24 Ohad Levy
|/reports/last|GET|Retrieve the last report information||
128 28 Corey Osman
|/reports?numreports=xx|GET|Retrieve reports xx items at a single time||
129 13 Justin Sherrill
|_.Roles |
130 1 Ohad Levy
|/roles|POST|Create a new Role|{role : {"builtin":string, "name":string, "permissions":string}}|
131 18 Justin Sherrill
|/roles/ID|DELETE|Delete a Role||
132
|/roles|GET|Retrieve a list of Roles||
133 13 Justin Sherrill
|/roles/ID|PUT|Update an existing Role|{role : {"builtin":string, "name":string, "permissions":string}}|
134 15 Justin Sherrill
|_.Smart proxies |
135 16 Justin Sherrill
|/smart_proxies|POST|Create a new Smart proxy|{smartproxy : {"name":string, "url":string}}|
136 18 Justin Sherrill
|/smart_proxies/ID|DELETE|Delete a Smart proxy||
137
|/smart_proxies|GET|Retrieve a list of Smart proxies||
138 15 Justin Sherrill
|/smart_proxies/ID|PUT|Update an existing Smart proxy|{smartproxy : {"name":string, "url":string}}|
139
|_.Subnets |
140 13 Justin Sherrill
|/subnets|POST|Create a new Subnet|{subnet : {"dhcp_id":int, "domain_id":int, "mask":string, "name":string, "network":string, "priority":string, "ranges":string, "tftp_id":int, "vlanid":int}}|
141 18 Justin Sherrill
|/subnets/ID|DELETE|Delete a Subnet||
142
|/subnets|GET|Retrieve a list of Subnets||
143 13 Justin Sherrill
|/subnets/ID|PUT|Update an existing Subnet|{subnet : {"dhcp_id":int, "domain_id":int, "mask":string, "name":string, "network":string, "priority":string, "ranges":string, "tftp_id":int, "vlanid":int}}|
144 15 Justin Sherrill
|_.Usergroups |
145 13 Justin Sherrill
|/usergroups|POST|Create a new Usergroup|{usergroup : {"name":string}}|
146 18 Justin Sherrill
|/usergroups/ID|DELETE|Delete a Usergroup||
147
|/usergroups|GET|Retrieve a list of Usergroups||
148 4 Ohad Levy
|/usergroups/ID|PUT|Update an existing Usergroup|{usergroup : {"name":string}}|
149 1 Ohad Levy
|_.Users |
150 12 Justin Sherrill
|/users|POST|Create a new User|{user : {"admin":string, "auth_source_id":int, "domains_andor":string, "facts_andor":string, "filter_on_owner":string, "firstname":string, "hostgroups_andor":string, "last_login_on":string, "lastname":string, "login":string, "mail":string, "password_hash":string, "password_salt":string, "role_id":int}}|
151 18 Justin Sherrill
|/users/ID|DELETE|Delete a User||
152
|/users|GET|Retrieve a list of Users||
153 1 Ohad Levy
|/users/ID|PUT|Update an existing User|{user : {"admin":string, "auth_source_id":int, "domains_andor":string, "facts_andor":string, "filter_on_owner":string, "firstname":string, "hostgroups_andor":string, "last_login_on":string, "lastname":string, "login":string, "mail":string, "password_hash":string, "password_salt":string, "role_id":int}}|
154 6 Ohad Levy
|_.Miscellaneous |
155 17 Justin Sherrill
|/dashboard|GET|Summary statistcs (total hosts, active hosts, hosts in error etc)||
156 21 Lukas Zapletal
|/status|GET|System status (result ok/failed, database lag in miliseconds)||
157 18 Justin Sherrill
158 1 Ohad Levy
159
160
161 22 Ohad Levy
see also [[Smart-Proxy:API]]
162 1 Ohad Levy
163
Please raise a new issue if you need additional API's