Foreman API v2 ist zurzeit die Standard-API-Version.

Ressourcen

Architectures

Ressource Beschreibung
GET /api/architectures Liste der Architekturen
GET /api/operatingsystems/:operatingsystem_id/architectures Alle Architekturen für das Betriebssystem auflisten
GET /api/architectures/:id Architektur anzeigen
POST /api/architectures Architektur erstellen
PUT /api/architectures/:id Architektur aktualisieren
DELETE /api/architectures/:id Architektur löschen

Audits

Ressource Beschreibung
GET /api/audits Alle Audits auflisten
GET /api/hosts/:host_id/audits Alle Audits für einen angegebenen Host auflisten
GET /api/audits/:id Audit anzeigen

Auth source ldaps

Ressource Beschreibung
GET /api/auth_source_ldaps Alle LDAP-Authentifizierungsquellen auflisten
GET /api/locations/:location_id/auth_source_ldaps Liste der LDAP-Authentisierungsquellen pro Standort
GET /api/organizations/:organization_id/auth_source_ldaps Liste der LDAP-Authentisierungsquellen pro Organisation
GET /api/auth_source_ldaps/:id LDAP-Authentifizierungsquelle anzeigen
POST /api/auth_source_ldaps LDAP-Authentifizierungsquelle erstellen
PUT /api/auth_source_ldaps/:id LDAP-Authentifizierungsquelle aktualisieren
PUT /api/auth_source_ldaps/:id/test LDAP-Verbindung testen
DELETE /api/auth_source_ldaps/:id LDAP-Authentifizierungsquelle löschen

Autosign

Ressource Beschreibung
GET /api/smart_proxies/smart_proxy_id/autosign Alle Autosign-Einträge auflisten
POST /api/smart_proxies/:smart_proxy_id/autosign Create autosign entry
DELETE /api/smart_proxies/:smart_proxy_id/autosign/:id Delete autosign entry

Bookmarks

Ressource Beschreibung
GET /api/bookmarks Alle Lesezeichen auflisten
GET /api/bookmarks/:id Lesezeichen anzeigen
POST /api/bookmarks Lesezeichen erstellen
PUT /api/bookmarks/:id Lesezeichen Aktualisieren
DELETE /api/bookmarks/:id Lesezeichen löschen

Common parameters

Ressource Beschreibung
GET /api/common_parameters Alle globalen Parameter auflisten
GET /api/common_parameters/:id Globalen Parameter anzeigen
POST /api/common_parameters Globale Parameter erstellen
PUT /api/common_parameters/:id Globalen Parameter aktualisieren
DELETE /api/common_parameters/:id Globalen Parameter löschen

Compute attributes

Ressource Beschreibung
POST /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes Rechenattributset erstellen
POST /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes Rechenattributset erstellen
POST /api/compute_resources/:compute_resource_id/compute_attributes Rechenattributset erstellen
POST /api/compute_profiles/:compute_profile_id/compute_attributes Rechenattributset erstellen
POST /api/compute_attributes Rechenattributset erstellen
PUT /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id Rechenattributset aktualisieren
PUT /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id Rechenattributset aktualisieren
PUT /api/compute_resources/:compute_resource_id/compute_attributes/:id Rechenattributset aktualisieren
PUT /api/compute_profiles/:compute_profile_id/compute_attributes/:id Rechenattributset aktualisieren
PUT /api/compute_attributes/:id Rechenattributset aktualisieren

Compute profiles

Ressource Beschreibung
GET /api/compute_profiles Liste mit Rechenprofilen
GET /api/compute_profiles/:id Rechenprofilen anzeigen
POST /api/compute_profiles Rechenprofilen erstellen
PUT /api/compute_profiles/:id Rechenprofilen aktualisieren
DELETE /api/compute_profiles/:id Rechenprofilen löschen

Compute resources

Ressource Beschreibung
GET /api/compute_resources Alle Rechenressourcen auflisten
GET /api/compute_resources/:id Rechenressource anzeigen
POST /api/compute_resources Rechenressource erstellen
PUT /api/compute_resources/:id Rechenressource aktualisieren
DELETE /api/compute_resources/:id Rechenressource löschen
GET /api/compute_resources/:id/available_images Verfügbare Abbilder für eine Rechenressource auflisten
GET /api/compute_resources/:id/available_clusters Verfügbare Cluster für eine Rechenressource auflisten
GET /api/compute_resources/:id/available_flavors Verfügbare Varianten für eine Rechenressource auflisten
GET /api/compute_resources/:id/available_folders Verfügbare Ordner für eine Rechenressource auflisten
GET /api/compute_resources/:id/available_zones Verfügbare Zonen für eine Rechenressource auflisten
GET /api/compute_resources/:id/available_networks Verfügbare Netzwerke für eine Rechenressource auflisten
GET /api/compute_resources/:id/available_clusters/:cluster_id/available_networks Verfügbare Netzwerke für einen Rechenressourcencluster auflisten
GET /api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools Ressourcen-Pools für ein Rechenressourcen-Cluster auflisten
GET /api/compute_resources/:id/available_storage_domains Speicherdomänen for Rechenressource auflisten
GET /api/compute_resources/:id/available_storage_domains/:storage_domain Attribute für eine angegebene Speicherdomäne auflisten
GET /api/compute_resources/:id/available_storage_pods Storage-Pods für Rechenressource auflisten
GET /api/compute_resources/:id/available_storage_pods/:storage_pod Attribute für angegebenen Storage-Pod auflisten
GET /api/compute_resources/:id/available_security_groups Verfügbare Sicherheitsgruppen für eine Rechenressource auflisten
PUT /api/compute_resources/:id/associate VMs den Hosts zuweisen
PUT /api/compute_resources/:id/refresh_cache Refresh Compute Resource Cache

Config groups

Ressource Beschreibung
GET /api/config_groups Alle Konfigurationsgruppen auflisten
GET /api/config_groups/:id Konfigurationsgruppe anzeigen
POST /api/config_groups Konfigurationsgruppe erstellen
PUT /api/config_groups/:id Konfigurationsgruppe Aktualisieren
DELETE /api/config_groups/:id Konfigurationsgruppe löschen

Config reports

Ressource Beschreibung
GET /api/config_reports Alle Berichte auflisten
GET /api/config_reports/:id Bericht anzeigen
POST /api/config_reports Bericht erstellen
DELETE /api/config_reports/:id Bericht löschen
GET /api/hosts/:host_id/config_reports/last Letzten Bericht für einen Host anzeigen

Config templates

Ressource Beschreibung
GET /api/config_templates Bereitstellungsvorlagen auflisten
GET /api/operatingsystems/:operatingsystem_id/config_templates Bereitstellungsvorlagen pro Betriebssystem auflisten
GET /api/locations/:location_id/config_templates Bereitstellungsvorlagen pro Standort auflisten
GET /api/organizations/:organization_id/config_templates Bereitstellungsvorlagen pro Organisation auflisten
GET /api/config_templates/:id Details der Bereitstellungsvorlage anzeigen
POST /api/config_templates Bereitstellungsvorlage erstellen
PUT /api/config_templates/:id Bereitstellungsvorlage aktualisieren
GET /api/config_templates/revision
DELETE /api/config_templates/:id Bereitstellungsvorlage löschen
POST /api/config_templates/build_pxe_default Standard-PXE-Menü auf allen konfigurierten TFTP-Servern aktualisieren
POST /api/config_templates/:id/clone Bereitstellungsvorlage klonen

Dashboard

Ressource Beschreibung
GET /api/dashboard Übersichtsseitendetails abholen

Domains

Ressource Beschreibung
GET /api/domains Liste der Domänen
GET /api/subnets/:subnet_id/domains Liste der Domänen pro Subnetz
GET /api/locations/:location_id/domains Liste der Domänen pro Standort
GET /api/organizations/:organization_id/domains Liste der Domänen pro Organisation
GET /api/domains/:id Domäne anzeigen
POST /api/domains Domäne erstellen
PUT /api/domains/:id Domain Aktualisieren
DELETE /api/domains/:id Domäne löschen

Environments

Ressource Beschreibung
POST /api/smart_proxies/:id/import_puppetclasses Puppet-Klassen von Puppet-Proxy importieren
POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses Puppet-Klassen von Puppet-Proxy für eine Umgebung importieren
POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses Puppet-Klassen von Puppet-Proxy für eine Umgebung importieren
GET /api/environments Alle Umgebungen auflisten
GET /api/puppetclasses/:puppetclass_id/environments Umgebungen der Puppet-Klasse auflisten
GET /api/locations/:location_id/environments Umgebungen pro Standort auflisten
GET /api/organizations/:organization_id/environments Umgebungen pro Organisation auflisten
GET /api/environments/:id Umgebung anzeigen
POST /api/environments Umgebung erstellen
PUT /api/environments/:id Umgebung aktualisieren
DELETE /api/environments/:id Umgebung löschen

External usergroups

Ressource Beschreibung
GET /api/usergroups/:usergroup_id/external_usergroups Alle externen Benutzergruppen für die Benutzergruppe auflisten
GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups Alle externen Benutzergruppen für die LDAP-Authentifizierungsquelle auflisten
GET /api/usergroups/:usergroup_id/external_usergroups/:id Externe Benutzergruppe für die Benutzergruppe anzeigen
GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id Externe Benutzergruppe für die LDAP-Authentifizierungsquelle anzeigen
POST /api/usergroups/:usergroup_id/external_usergroups Mit einer Benutzergruppe verknüpfte, externe Benutzergruppe erstellen
PUT /api/usergroups/:usergroup_id/external_usergroups/:id Externe Benutzergruppe aktualisieren
PUT /api/usergroups/:usergroup_id/external_usergroups/:id/refresh Externe Benutzergruppe aktualisieren
DELETE /api/usergroups/:usergroup_id/external_usergroups/:id Externe Benutzergruppe löschen

Fact values

Ressource Beschreibung
GET /api/fact_values Alle Faktwerte auflisten
GET /api/hosts/:host_id/facts Alle Faktwerte eines angegebenen Hosts auflisten

Filters

Ressource Beschreibung
GET /api/filters Alle Filter auflisten
GET /api/filters/:id Filter anzeigen
POST /api/filters Erstelle einen Filter
PUT /api/filters/:id Filter Aktualisieren
DELETE /api/filters/:id Filter löschen

Home

Ressource Beschreibung
GET /api Verfügbare API-Verknüpfungen anzeigen
GET /api/status Status anzeigen

Host classes

Ressource Beschreibung
GET /api/hosts/:host_id/puppetclass_ids Alle Puppet-Klassen-Kennungen für den Host auflisten
POST /api/hosts/:host_id/puppetclass_ids Puppet-Klasse dem Host zuweisen
DELETE /api/hosts/:host_id/puppetclass_ids/:id Puppet-Klasse vom Host entfernen

Hostgroup classes

Ressource Beschreibung
GET /api/hostgroups/:hostgroup_id/puppetclass_ids Alle Puppet-Klassen-Kennungen für die Hostgruppe auflisten
POST /api/hostgroups/:hostgroup_id/puppetclass_ids Puppet-Klasse der Hostgruppe zuweisen
DELETE /api/hostgroups/:hostgroup_id/puppetclass_ids/:id Puppet-Klasse von Hostgruppe entfernen

Hostgroups

Ressource Beschreibung
GET /api/hostgroups Alle Hostgruppen auflisten
GET /api/puppetclasses/:puppetclass_id/hostgroups Alle Hostgruppen für eine Puppet-Klasse auflisten
GET /api/locations/:location_id/hostgroups Alle Hostgruppen pro Standort auflisten
GET /api/organizations/:organization_id/hostgroups Alle Hostgruppen pro Organisation auflisten
GET /api/hostgroups/:id Hostgruppe anzeigen
POST /api/hostgroups Hostgruppe erstellen
PUT /api/hostgroups/:id Hostgruppe aktualisieren
DELETE /api/hostgroups/:id Hostgruppe löschen
POST /api/hostgroups/:id/clone Hostgruppe klonen
PUT /api/hostgroups/:id/rebuild_config Orchestrierungs-Konfig neu erstellen

Hosts

Ressource Beschreibung
GET /api/hosts Alle Hosts auflisten
GET /api/hostgroups/:hostgroup_id/hosts Alle Hosts für eine Hostgruppe auflisten
GET /api/locations/:location_id/hosts Hosts pro Standort auflisten
GET /api/organizations/:organization_id/hosts Hosts pro Organisation auflisten
GET /api/environments/:environment_id/hosts Hosts pro Umgebung auflisten
GET /api/hosts/:id Host anzeigen
POST /api/hosts Host erstellen
PUT /api/hosts/:id Host Aktualisieren
DELETE /api/hosts/:id Host löschen
GET /api/hosts/:id/enc Get ENC values of host
GET /api/hosts/:id/status Konfigurationsstatus des Hosts abholen
GET /api/hosts/:id/status/:type Hoststatus abholen
GET /api/hosts/:id/vm_compute_attributes VM-Attribute des Hosts abrufen
PUT /api/hosts/:id/disassociate Host von einer VM lösen
PUT /api/hosts/:id/power Power-Operation auf Host ausführen
PUT /api/hosts/:id/boot Host von angegebenem Gerät starten
POST /api/hosts/facts Fakten für einen Host hochladen mit Erstellung des Hosts, wenn erforderlich
PUT /api/hosts/:id/rebuild_config Orchestrierungs-Konfig neu erstellen
GET /api/hosts/:id/template/:kind Inhaltsvorschau der gerenderten Bereitstellungsvorlage

Http proxies

Ressource Beschreibung
GET /api/http_proxies List of HTTP Proxies
GET /api/http_proxies/:id Show an HTTP Proxy
POST /api/http_proxies Create an HTTP Proxy
PUT /api/http_proxies/:id Update an HTTP Proxy
DELETE /api/http_proxies/:id Delete an HTTP Proxy

Images

Ressource Beschreibung
GET /api/compute_resources/:compute_resource_id/images Alle Abbilder für eine Rechenressource auflisten
GET /api/operatingsystems/:operatingsystem_id/images Alle Abbilder für das Betriebssystem auflisten
GET /api/architectures/:architecture_id/images Alle Abbilder für die Architektur auflisten
GET /api/compute_resources/:compute_resource_id/images/:id Abbild anzeigen
GET /api/operatingsystems/:operatingsystem_id/images/:id Abbild anzeigen
GET /api/architectures/:architecture_id/images/:id Abbild anzeigen
POST /api/compute_resources/:compute_resource_id/images Ein Abbild erstellen
PUT /api/compute_resources/:compute_resource_id/images/:id Abbild aktualisieren
DELETE /api/compute_resources/:compute_resource_id/images/:id Abbild löschen

Interfaces

Ressource Beschreibung
GET /api/hosts/:host_id/interfaces Alle Host-Schnittstellen auflisten
GET /api/domains/:domain_id/interfaces Alle Schnittstellen für Domäne auflisten
GET /api/subnets/:subnet_id/interfaces Alle Schnittstellen für das Subnetz auflisten
GET /api/hosts/:host_id/interfaces/:id Schnittstelle für den Host anzeigen
POST /api/hosts/:host_id/interfaces Schnittstelle auf einem Host erstellen
PUT /api/hosts/:host_id/interfaces/:id Host-Schnittstelle aktualisieren
DELETE /api/hosts/:host_id/interfaces/:id Host-Schnittstelle löschen

Locations

Ressource Beschreibung
GET /api/locations List all locations
GET /api/locations/:id Show a location
POST /api/locations Create a location
PUT /api/locations/:id Update a location
DELETE /api/locations/:id Delete a location

Mail notifications

Ressource Beschreibung
GET /api/mail_notifications Lister der E-Mail-Benachrichtigungen
GET /api/mail_notifications/:id E-Mail-Benachrichtigung anzeigen

Media

Ressource Beschreibung
GET /api/media Alle Installationsmedien auflisten
GET /api/operatingsystems/:operatingsystem_id/media Alle Medien für ein Betriebssystem auflisten
GET /api/locations/:location_id/media Alle Medien für einen Standort auflisten
GET /api/organizations/:organization_id/media Alle Medien pro Organisation auflisten
GET /api/media/:id Datenträger anzeigen
POST /api/media Medium erstellen
PUT /api/media/:id Medium aktualisieren
DELETE /api/media/:id Datenträger löschen

Models

Ressource Beschreibung
GET /api/models Alle Hardwaremodelle auflisten
GET /api/models/:id Hardwaremodell anzeigen
POST /api/models Hardwaremodell erstellen
PUT /api/models/:id Hardwaremodell aktualisieren
DELETE /api/models/:id Hardwaremodell löschen

Operating systems

Ressource Beschreibung
GET /api/operatingsystems Alle Betriebssysteme auflisten
GET /api/architectures/:architecture_id/operatingsystems Alle Betriebssysteme für verschachtelte Architektur auflisten
GET /api/media/:medium_id/operatingsystems Alle Betriebssysteme für verschachteltes Medium auflisten
GET /api/ptables/:ptable_id/operatingsystems Alle Betriebssysteme für verschachtelte Partitionstabelle auflisten
GET /api/config_templates/:config_template_id/operatingsystems Alle Betriebssysteme für verschachtelte Bereitstellungsvorlage auflisten
GET /api/provisioning_templates/:provisioning_template_id/operatingsystems Alle Betriebssysteme für verschachtelte Bereitstellungsvorlage auflisten
GET /api/operatingsystems/:id Betriebssystem anzeigen
POST /api/operatingsystems Betriebssystem erstellen
PUT /api/operatingsystems/:id Betriebssystem aktualisieren
DELETE /api/operatingsystems/:id Betriebssystem löschen
GET /api/operatingsystems/:id/bootfiles Bootdateien für ein Betriebssystem auflisten

Organizations

Ressource Beschreibung
GET /api/organizations List all organizations
GET /api/organizations/:id Show an organization
POST /api/organizations Create an organization
PUT /api/organizations/:id Update an organization
DELETE /api/organizations/:id Delete an organization

Os default templates

Ressource Beschreibung
GET /api/operatingsystems/:operatingsystem_id/os_default_templates Standardvorlagen-Kombinationen für ein Betriebssystem auflisten
GET /api/config_templates/:config_template_id/os_default_templates Betriebssysteme auflisten, für die diese Vorlage als Standard gesetzt ist
GET /api/provisioning_templates/:provisioning_template_id/os_default_templates Betriebssysteme auflisten, für die diese Vorlage als Standard gesetzt ist
GET /api/operatingsystems/:operatingsystem_id/os_default_templates/:id Standardvorlagen-Kombination für ein Betriebssystem anzeigen
POST /api/operatingsystems/:operatingsystem_id/os_default_templates Standardvorlagen-Kombination für ein Betriebssystem erstellen
PUT /api/operatingsystems/:operatingsystem_id/os_default_templates/:id Standardvorlagen-Kombination für ein Betriebssystem aktualisieren
DELETE /api/operatingsystems/:operatingsystem_id/os_default_templates/:id Standardvorlagen-Kombination für ein Betriebssystem löschen

Override values

Ressource Beschreibung
GET /api/smart_variables/:smart_variable_id/override_values Liste der Überschreibungswerte für eine bestimmte Smart-Variable
GET /api/smart_class_parameters/:smart_class_parameter_id/override_values Liste der Überschreibungswerte für einen bestimmten Smart-Klassenparameter
GET /api/smart_variables/:smart_variable_id/override_values/:id Überschreibungswert für eine bestimmte Smart-Variable anzeigen
GET /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id Überschreibungswert für einen bestimmten Smart-Klassenparameter anzeigen
POST /api/smart_variables/:smart_variable_id/override_values Überschreibungswert für eine bestimmte Smart-Variable erzeugen
POST /api/smart_class_parameters/:smart_class_parameter_id/override_values Überschreibungswert für einen bestimmten Smart-Klassenparameter erzeugen
PUT /api/smart_variables/:smart_variable_id/override_values/:id Überschreibungswert für eine bestimmte Smart-Variable aktualisieren
PUT /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id Überschreibungswert für einen bestimmten Smart-Klassenparameter aktualisieren
DELETE /api/smart_variables/:smart_variable_id/override_values/:id Überschreibungswert für eine bestimmte Smart-Variable löschen
DELETE /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id Überschreibungswert für einen bestimmten Smart-Klassenparameter löschen

Parameters

Ressource Beschreibung
GET /api/hosts/:host_id/parameters Alle Parameter für einen Host auflisten
GET /api/hostgroups/:hostgroup_id/parameters Alle Parameter für eine Hostgruppe auflisten
GET /api/domains/:domain_id/parameters Alle Parameter für eine Domäne auflisten
GET /api/operatingsystems/:operatingsystem_id/parameters Alle Parameter für ein Betriebssystem auflisten
GET /api/locations/:location_id/parameters Alle Parameter für einen Standort auflisten
GET /api/organizations/:organization_id/parameters Alle Parameter für eine Organisation auflisten
GET /api/subnets/:subnet_id/parameters Alle Parameter für ein Subnetz auflisten
GET /api/hosts/:host_id/parameters/:id Verschachtelten Parameter für einen Host anzeigen
GET /api/hostgroups/:hostgroup_id/parameters/:id Verschachtelten Parameter für eine Hostgruppe anzeigen
GET /api/domains/:domain_id/parameters/:id Verschachtelten Parameter für eine Domäne anzeigen
GET /api/operatingsystems/:operatingsystem_id/parameters/:id Verschachtelten Parameter für ein Betriebssystem anzeigen
GET /api/locations/:location_id/parameters/:id Verschachtelten Parameter für einen Standort anzeigen
GET /api/organizations/:organization_id/parameters/:id Verschachtelten Parameter für eine Organisation anzeigen
GET /api/subnets/:subnet_id/parameters/:id Verschachtelten Parameter für ein Subnetz anzeigen
POST /api/hosts/:host_id/parameters Verschachtelten Parameter für einen Host erstellen
POST /api/hostgroups/:hostgroup_id/parameters Verschachtelten Parameter für eine Hostgruppe erstellen
POST /api/domains/:domain_id/parameters Verschachtelten Parameter für eine Domäne erstellen
POST /api/operatingsystems/:operatingsystem_id/parameters Verschachtelten Parameter für ein Betriebssystem erstellen
POST /api/locations/:location_id/parameters Verschachtelten Parameter für einen Standort erstellen
POST /api/organizations/:organization_id/parameters Verschachtelten Parameter für eine Organisation erstellen
POST /api/subnets/:subnet_id/parameters Verschachtelten Parameter für ein Subnetz erstellen
PUT /api/hosts/:host_id/parameters/:id Verschachtelten Parameter für einen Host aktualisieren
PUT /api/hostgroups/:hostgroup_id/parameters/:id Verschachtelten Parameter für eine Hostgruppe aktualisieren
PUT /api/domains/:domain_id/parameters/:id Verschachtelten Parameter für eine Domäne aktualisieren
PUT /api/operatingsystems/:operatingsystem_id/parameters/:id Verschachtelten Parameter für ein Betriebssystem aktualisieren
PUT /api/locations/:location_id/parameters/:id Verschachtelten Parameter für einen Standort aktualisieren
PUT /api/organizations/:organization_id/parameters/:id Verschachtelten Parameter für eine Organisation aktualisieren
PUT /api/subnets/:subnet_id/parameters/:id Verschachtelten Parameter für ein Subnetz aktualisieren
DELETE /api/hosts/:host_id/parameters/:id Verschachtelten Parameter für einen Host löschen
DELETE /api/hostgroups/:hostgroup_id/parameters/:id Verschachtelten Parameter für eine Hostgruppe löschen
DELETE /api/domains/:domain_id/parameters/:id Verschachtelten Parameter für eine Domäne löschen
DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id Verschachtelten Parameter für ein Betriebssystem löschen
DELETE /api/locations/:location_id/parameters/:id Verschachtelten Parameter für einen Standort löschen
DELETE /api/organizations/:organization_id/parameters/:id Verschachtelten Parameter für eine Organisation löschen
DELETE /api/subnets/:subnet_id/parameters/:id Verschachtelten Parameter für ein Subnetz löschen
DELETE /api/hosts/:host_id/parameters Alle verschachtelten Parameter für einen Host löschen
DELETE /api/hostgroups/:hostgroup_id/parameters Alle verschachtelten Parameter für eine Hostgruppe löschen
DELETE /api/domains/:domain_id/parameters Alle verschachtelten Parameter für eine Domäne löschen
DELETE /api/operatingsystems/:operatingsystem_id/parameters Alle verschachtelten Parameter für ein Betriebssystem löschen
DELETE /api/locations/:location_id/parameters Alle verschachtelten Parameter für einen Standort löschen
DELETE /api/organizations/:organization_id/parameters Alle verschachtelten Parameter für eine Organisation löschen
DELETE /api/subnets/:subnet_id/parameters Alle verschachtelten Parameter für ein Subnetz löschen

Permissions

Ressource Beschreibung
GET /api/permissions Alle Berechtigungen auflisten
GET /api/permissions/:id Berechtigung anzeigen
GET /api/permissions/resource_types Verfügbare Ressourcentypen auflisten.

Personal access tokens

Ressource Beschreibung
GET /api/users/:user_id/personal_access_tokens List all Personal Access Tokens for a user
GET /api/users/:user_id/personal_access_tokens/:id Show a Personal Access Token for a user
POST /api/users/:user_id/personal_access_tokens Create a Personal Access Token for a user
DELETE /api/users/:user_id/personal_access_tokens/:id Revoke a Personal Access Token for a user

Plugins

Ressource Beschreibung
GET /api/plugins Installierte Plugins auflisten

Provisioning templates

Ressource Beschreibung
GET /api/provisioning_templates Bereitstellungsvorlagen auflisten
GET /api/operatingsystems/:operatingsystem_id/provisioning_templates Bereitstellungsvorlagen pro Betriebssystem auflisten
GET /api/locations/:location_id/provisioning_templates Bereitstellungsvorlagen pro Standort auflisten
GET /api/organizations/:organization_id/provisioning_templates Bereitstellungsvorlagen pro Organisation auflisten
GET /api/provisioning_templates/:id Details der Bereitstellungsvorlage anzeigen
POST /api/provisioning_templates Bereitstellungsvorlage erstellen
PUT /api/provisioning_templates/:id Bereitstellungsvorlage aktualisieren
GET /api/provisioning_templates/revision
DELETE /api/provisioning_templates/:id Bereitstellungsvorlage löschen
POST /api/provisioning_templates/build_pxe_default Standard-PXE-Menü auf allen konfigurierten TFTP-Servern aktualisieren
POST /api/provisioning_templates/:id/clone Bereitstellungsvorlage klonen
GET /api/provisioning_templates/:id/export Export als Provisionierungsvorlage nach ERB

Ptables

Ressource Beschreibung
GET /api/ptables Alle Partitionstabellen auflisten
GET /api/operatingsystems/:operatingsystem_id/ptables Alle Partitionstabellen für ein Betriebssystem auflisten
GET /api/locations/:location_id/ptables Alle Partitionstabellen pro Standort auflisten
GET /api/organizations/:organization_id/ptables Alle Partitionstabellen pro Organisation auflisten
GET /api/ptables/:id Partitionstabelle anzeigen
POST /api/ptables Partitionstabelle erstellen
GET /api/ptables/revision
PUT /api/ptables/:id Partitionstabelle aktualisieren
DELETE /api/ptables/:id Partitionstabelle löschen
POST /api/ptables/:id/clone Vorlage klonen
GET /api/ptables/:id/export Export als Partitionsvorlage nach ERB

Puppet hosts

Ressource Beschreibung
PUT /api/hosts/:id/puppetrun Puppet-Agent-Lauf auf dem Host erzwingen

Puppetclasses

Ressource Beschreibung
GET /api/puppetclasses Alle Puppet-Klassen auflisten
GET /api/hosts/:host_id/puppetclasses Alle Puppet-Klassen für einen Host auflisten
GET /api/hostgroups/:hostgroup_id/puppetclasses Alle Puppet-Klassen für eine Hostgruppe auflisten
GET /api/environments/:environment_id/puppetclasses Alle Puppet-Klassen für eine Umgebung auflisten
GET /api/puppetclasses/:id Puppet-Klasse anzeigen
GET /api/hosts/:host_id/puppetclasses/:id Puppet-Klasse für Host anzeigen
GET /api/hostgroups/:hostgroup_id/puppetclasses/:id Puppet-Klasse für eine Hostgruppe anzeigen
GET /api/environments/:environment_id/puppetclasses/:id Puppet-Klasse für eine Umgebung anzeigen
POST /api/puppetclasses Erstelle eine Puppet-Klasse
PUT /api/puppetclasses/:id Puppet-Klasse aktualisieren
DELETE /api/puppetclasses/:id Puppet-Klasse löschen

Realms

Ressource Beschreibung
GET /api/realms Liste der Realms
GET /api/realms/:id Realm anzeigen
POST /api/realms Realm erstellen
PUT /api/realms/:id Realm aktualisieren
DELETE /api/realms/:id Realm löschen

Reports

Ressource Beschreibung
GET /api/reports Alle Berichte auflisten
GET /api/reports/:id Bericht anzeigen
POST /api/reports Bericht erstellen
DELETE /api/reports/:id Bericht löschen
GET /api/hosts/:host_id/reports/last Letzten Bericht für einen Host anzeigen

Roles

Ressource Beschreibung
GET /api/roles Alle Rollen auflisten
GET /api/roles/:id Rolle anzeigen
POST /api/roles Rolle erstellen
PUT /api/roles/:id Rolle aktualisieren
DELETE /api/roles/:id Rolle löschen
POST /api/roles/:id/clone Clone a role

Settings

Ressource Beschreibung
GET /api/settings Alle Einstellungen auflisten
GET /api/settings/:id Einstellung anzeigen
PUT /api/settings/:id Einstellung aktualisieren

Smart class parameters

Ressource Beschreibung
GET /api/smart_class_parameters Alle Smart-Klassenparameter auflisten
GET /api/hosts/:host_id/smart_class_parameters Liste der Smart-Klassenparameter für einen bestimmten Host
GET /api/hostgroups/:hostgroup_id/smart_class_parameters Liste der Smart-Klassenparameter für eine bestimmte Hostgruppe
GET /api/puppetclasses/:puppetclass_id/smart_class_parameters Liste der Smart-Klassenparameter für eine bestimmte Puppetklasse
GET /api/environments/:environment_id/smart_class_parameters Liste der Smart-Klassenparameter für eine bestimmte Umgebung
GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters Liste der Smart-Klassenparameter für eine bestimmte Umgebung/Puppet-Klasse-Kombination
GET /api/smart_class_parameters/:id Smart-Klassenparameter anzeigen
PUT /api/smart_class_parameters/:id Smart-Klassenparameter aktualisieren

Smart proxies

Ressource Beschreibung
POST /api/smart_proxies/:id/import_puppetclasses Puppet-Klassen von Puppet-Proxy importieren
POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses Puppet-Klassen von Puppet-Proxy für eine Umgebung importieren
POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses Puppet-Klassen von Puppet-Proxy für eine Umgebung importieren
GET /api/smart_proxies Alle Smart-Proxys auflisten
GET /api/smart_proxies/:id Smart-Proxy anzeigen
POST /api/smart_proxies Smart-Proxy erstellen
PUT /api/smart_proxies/:id Smart proxy aktualisieren
DELETE /api/smart_proxies/:id Smart-Proxy löschen
PUT /api/smart_proxies/:id/refresh Smart-Proxy-Funktionen aktualisieren

Smart variables

Ressource Beschreibung
GET /api/smart_variables Alle Smart-Variablen auflisten
GET /api/hosts/:host_id/smart_variables Liste der Smart-Variablen für einen bestimmten Host
GET /api/hostgroups/:hostgroup_id/smart_variables Liste der Smart-Variablen für eine bestimmte Hostgruppe
GET /api/puppetclasses/:puppetclass_id/smart_variables Liste der Smart-Variablen für eine bestimmte Puppet-Klasse
GET /api/smart_variables/:id Smart-Variable anzeigen
POST /api/smart_variables Smart-Variable erstellen
PUT /api/smart_variables/:id Smart variable aktualisieren
DELETE /api/smart_variables/:id Smart-Variable löschen

Ssh keys

Ressource Beschreibung
GET /api/users/:user_id/ssh_keys List all SSH keys for a user
GET /api/users/:user_id/ssh_keys/:id Show an SSH key from a user
POST /api/users/:user_id/ssh_keys Add an SSH key for a user
DELETE /api/users/:user_id/ssh_keys/:id Delete an SSH key for a user

Statistics

Ressource Beschreibung
GET /api/statistics Statistiken abholen

Subnets

Ressource Beschreibung
GET /api/subnets Liste von Subnetzen
GET /api/domains/:domain_id/subnets Liste von Subnetzen für eine Domäne
GET /api/locations/:location_id/subnets Liste von Subnetzen pro Standort
GET /api/organizations/:organization_id/subnets Liste von Subnetzen pro Organisation
GET /api/subnets/:id Subnetz anzeigen
POST /api/subnets Subnetz erstellen
PUT /api/subnets/:id Subnet aktualisieren
DELETE /api/subnets/:id Subnetz löschen
GET /api/subnets/:id/freeip Provides an unused IP address in this subnet

Tasks

Ressource Beschreibung
GET /api/orchestration/:id/tasks Alle Aufgaben für ein angegebenes Orchestrierungsereignis auflisten

Template combinations

Ressource Beschreibung
GET /api/config_templates/:config_template_id/template_combinations DEPRECATED Vorlagenkombination auflisten
GET /api/provisioning_templates/:provisioning_template_id/template_combinations Vorlagenkombination auflisten
GET /api/hostgroups/:hostgroup_id/template_combinations Vorlagenkombination auflisten
GET /api/environments/:environment_id/template_combinations Vorlagenkombination auflisten
POST /api/config_templates/:config_template_id/template_combinations DEPRECATED Vorlage-Kombination hinzufügen
POST /api/provisioning_templates/:provisioning_template_id/template_combinations Vorlage-Kombination hinzufügen
POST /api/hostgroups/:hostgroup_id/template_combinations Vorlage-Kombination hinzufügen
POST /api/environments/:environment_id/template_combinations Vorlage-Kombination hinzufügen
GET /api/template_combinations/:id Vorlagenkombination anzeigen
GET /api/config_templates/:config_template_id/template_combinations/:id DEPRECATED Vorlagenkombination anzeigen
GET /api/provisioning_templates/:provisioning_template_id/template_combinations/:id Vorlagenkombination anzeigen
GET /api/hostgroups/:hostgroup_id/template_combinations/:id Vorlagenkombination anzeigen
GET /api/environments/:environment_id/template_combinations/:id Vorlagenkombination anzeigen
PUT /api/provisioning_templates/:provisioning_template_id/template_combinations/:id Vorlagen-Kombination aktualisieren
PUT /api/config_templates/:config_template_id/template_combinations/:id DEPRECATED Vorlagen-Kombination aktualisieren
PUT /api/hostgroups/:hostgroup_id/template_combinations/:id Vorlagen-Kombination aktualisieren
PUT /api/environments/:environment_id/template_combinations/:id Vorlagen-Kombination aktualisieren
DELETE /api/template_combinations/:id Vorlagenkombination löschen

Template kinds

Ressource Beschreibung
GET /api/template_kinds Alle Vorlagenarten auflisten

Usergroups

Ressource Beschreibung
GET /api/usergroups Alle Benutzergruppen auflisten
GET /api/usergroups/:id Benutzergruppe anzeigen
POST /api/usergroups Eine Benutzergruppe erstellen
PUT /api/usergroups/:id Benutzergruppe aktualisieren
DELETE /api/usergroups/:id Benutzergruppe löschen

Users

Ressource Beschreibung
GET /api/users Alle Benutzer auflisten
GET /api/auth_source_ldaps/:auth_source_ldap_id/users Aller Benutzer für die LDAP-Authentifizierungsquelle auflisten
GET /api/usergroups/:usergroup_id/users Alle Benutzer für die Benutzergruppe auflisten
GET /api/roles/:role_id/users Alle Benutzer für die Rolle auflisten
GET /api/locations/:location_id/users Alle Benutzer für den Standort auflisten
GET /api/organizations/:organization_id/users Alle Benutzer für die Organisation auflisten
GET /api/users/:id Benutzer anzeigen
POST /api/users Einen Benutzer erstellen
PUT /api/users/:id Benutzer aktualisieren
DELETE /api/users/:id Benutzer löschen