目前 Foreman API v2 是預設的 API 版本。

資源

Architectures

資源 描述
GET /api/architectures 列出所有架構
GET /api/operatingsystems/:operatingsystem_id/architectures 列出作業系統的所有架構
GET /api/architectures/:id 顯示架構
POST /api/architectures 建立架構
PUT /api/architectures/:id 更新架構
DELETE /api/architectures/:id 刪除架構

Audits

資源 描述
GET /api/audits 列出所有稽核
GET /api/hosts/:host_id/audits 列出一部主機的所有稽核
GET /api/audits/:id 顯示稽核

Auth source ldaps

資源 描述
GET /api/auth_source_ldaps 列出所有 LDAP 的認證來源
GET /api/locations/:location_id/auth_source_ldaps List LDAP authentication sources per location
GET /api/organizations/:organization_id/auth_source_ldaps List LDAP authentication sources per organization
GET /api/auth_source_ldaps/:id 顯示一項 LDAP 認證來源
POST /api/auth_source_ldaps 建立 LDAP 認證來源
PUT /api/auth_source_ldaps/:id 更新 LDAP 認證來源
PUT /api/auth_source_ldaps/:id/test 測試 LDAP 連線
DELETE /api/auth_source_ldaps/:id 刪除 LDAP 認證來源

Autosign

資源 描述
GET /api/smart_proxies/smart_proxy_id/autosign 列出所有 autosign 項目
POST /api/smart_proxies/:smart_proxy_id/autosign Create autosign entry
DELETE /api/smart_proxies/:smart_proxy_id/autosign/:id Delete autosign entry

Bookmarks

資源 描述
GET /api/bookmarks 列出所有書籤
GET /api/bookmarks/:id 顯示書籤
POST /api/bookmarks 建立書籤
PUT /api/bookmarks/:id 更新書籤
DELETE /api/bookmarks/:id 刪除書籤

Common parameters

資源 描述
GET /api/common_parameters 列出所有全域參數。
GET /api/common_parameters/:id 顯示全域參數
POST /api/common_parameters 建立全域參數
PUT /api/common_parameters/:id 更新全域參數
DELETE /api/common_parameters/:id 刪除全域參數

Compute attributes

資源 描述
POST /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes 建立運算屬性集
POST /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes 建立運算屬性集
POST /api/compute_resources/:compute_resource_id/compute_attributes 建立運算屬性集
POST /api/compute_profiles/:compute_profile_id/compute_attributes 建立運算屬性集
POST /api/compute_attributes 建立運算屬性集
PUT /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id 更新運算屬性集
PUT /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id 更新運算屬性集
PUT /api/compute_resources/:compute_resource_id/compute_attributes/:id 更新運算屬性集
PUT /api/compute_profiles/:compute_profile_id/compute_attributes/:id 更新運算屬性集
PUT /api/compute_attributes/:id 更新運算屬性集

Compute profiles

資源 描述
GET /api/compute_profiles 運算設定檔清單
GET /api/compute_profiles/:id 顯示運算設定檔
POST /api/compute_profiles 建立運算設定檔
PUT /api/compute_profiles/:id 更新運算設定檔
DELETE /api/compute_profiles/:id 刪除運算設定檔

Compute resources

資源 描述
GET /api/compute_resources 列出所有運算資源
GET /api/compute_resources/:id 顯示運算資源
POST /api/compute_resources 建立運算資源
PUT /api/compute_resources/:id 更新運算資源
DELETE /api/compute_resources/:id 刪除運算資源
GET /api/compute_resources/:id/available_images 列出運算資源的可用映像檔
GET /api/compute_resources/:id/available_clusters 列出運算資源的可用叢集
GET /api/compute_resources/:id/available_flavors 列出運算資源的可用選擇
GET /api/compute_resources/:id/available_folders 列出運算資源的可用資料夾
GET /api/compute_resources/:id/available_zones 列出運算資源的可用區域
GET /api/compute_resources/:id/available_networks 列出運算資源的可用網路
GET /api/compute_resources/:id/available_clusters/:cluster_id/available_networks 列出運算資源叢集的可用網路
GET /api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools 列出運算資源叢集的資源集區
GET /api/compute_resources/:id/available_storage_domains 列出運算資源的儲存區域
GET /api/compute_resources/:id/available_storage_domains/:storage_domain 列出某個儲存區域的屬性
GET /api/compute_resources/:id/available_storage_pods 列出運算資源的儲存容器
GET /api/compute_resources/:id/available_storage_pods/:storage_pod 列出某個儲存容器的屬性
GET /api/compute_resources/:id/available_security_groups 列出運算資源的可用安全群組
PUT /api/compute_resources/:id/associate 將 VM 與主機建立關連
PUT /api/compute_resources/:id/refresh_cache Refresh Compute Resource Cache

Config groups

資源 描述
GET /api/config_groups 配置群組清單
GET /api/config_groups/:id 顯示配置群組
POST /api/config_groups 建立配置群組
PUT /api/config_groups/:id 更新配置群組
DELETE /api/config_groups/:id 刪除配置群組

Config reports

資源 描述
GET /api/config_reports 列出所有報告
GET /api/config_reports/:id 顯示報告
POST /api/config_reports 建立報表
DELETE /api/config_reports/:id 刪除報告
GET /api/hosts/:host_id/config_reports/last 顯示主機的最後報告

Config templates

資源 描述
GET /api/config_templates 列出佈建範本
GET /api/operatingsystems/:operatingsystem_id/config_templates 列出各個作業系統的佈建範本
GET /api/locations/:location_id/config_templates 列出各個位置上的佈建範本
GET /api/organizations/:organization_id/config_templates 列出各個組織的佈建範本
GET /api/config_templates/:id 顯示佈建範本的詳情
POST /api/config_templates 建立佈建範本
PUT /api/config_templates/:id 更新佈建範本
GET /api/config_templates/revision
DELETE /api/config_templates/:id 刪除佈建範本
POST /api/config_templates/build_pxe_default 更新所有經過配置的 TFTP 伺服器上的預設 PXE 選單
POST /api/config_templates/:id/clone 複製佈建範本

Dashboard

資源 描述
GET /api/dashboard 取得控制面板詳細資料

Domains

資源 描述
GET /api/domains 區域清單
GET /api/subnets/:subnet_id/domains 各個子網路中的區域之清單
GET /api/locations/:location_id/domains 各個位置上的區域之清單
GET /api/organizations/:organization_id/domains 各個組織中的區域之清單
GET /api/domains/:id 顯示區域
POST /api/domains 建立網域
PUT /api/domains/:id 更新區域
DELETE /api/domains/:id 刪除區域

Environments

資源 描述
POST /api/smart_proxies/:id/import_puppetclasses 由 puppet 代理伺服器匯入 puppet 類別。
POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses 為環境由 puppet 代理伺服器匯入 puppet 類別
POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses 為環境由 puppet 代理伺服器匯入 puppet 類別
GET /api/environments 列出所有環境
GET /api/puppetclasses/:puppetclass_id/environments 列出 Puppet 類別的環境
GET /api/locations/:location_id/environments 列出各個位置的環境
GET /api/organizations/:organization_id/environments 列出各個組織的環境
GET /api/environments/:id 顯示環境
POST /api/environments 建立環境
PUT /api/environments/:id 更新環境
DELETE /api/environments/:id 刪除環境

External usergroups

資源 描述
GET /api/usergroups/:usergroup_id/external_usergroups 列出使用者群組的所有外部使用者群組
GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups 列出 LDAP 認證來源的所有外部使用者群組
GET /api/usergroups/:usergroup_id/external_usergroups/:id 顯示使用者群組的外部使用者群組
GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id 顯示 LDAP 認證來源的外部使用者群組
POST /api/usergroups/:usergroup_id/external_usergroups 建立連往使用者群組的外部使用者群組
PUT /api/usergroups/:usergroup_id/external_usergroups/:id 更新外部使用者群組
PUT /api/usergroups/:usergroup_id/external_usergroups/:id/refresh 刷新外部使用者群組
DELETE /api/usergroups/:usergroup_id/external_usergroups/:id 刪除外部使用者群組

Fact values

資源 描述
GET /api/fact_values 列出所有詳情值
GET /api/hosts/:host_id/facts 列出一部主機的所有詳情值

Filters

資源 描述
GET /api/filters 列出所有篩選器
GET /api/filters/:id 顯示篩選器
POST /api/filters 建立篩選器
PUT /api/filters/:id 更新篩選器
DELETE /api/filters/:id 刪除篩選器

Home

資源 描述
GET /api 顯示可用的 API 連結
GET /api/status 顯示狀態

Host classes

資源 描述
GET /api/hosts/:host_id/puppetclass_ids 列出主機的所有 Puppet 類別 ID
POST /api/hosts/:host_id/puppetclass_ids 新增 Puppet 類別至主機
DELETE /api/hosts/:host_id/puppetclass_ids/:id 從主機移除一個 Puppet 類別

Hostgroup classes

資源 描述
GET /api/hostgroups/:hostgroup_id/puppetclass_ids 列出主機群組的所有 Puppet 類別 ID
POST /api/hostgroups/:hostgroup_id/puppetclass_ids 新增 Puppet 類別至主機群組
DELETE /api/hostgroups/:hostgroup_id/puppetclass_ids/:id 從主機群組移除一個 Puppet 類別

Hostgroups

資源 描述
GET /api/hostgroups 列出所有主機群組
GET /api/puppetclasses/:puppetclass_id/hostgroups 列出 Puppet 類別的所有主機群組
GET /api/locations/:location_id/hostgroups 列出各個位置上的所有主機群組
GET /api/organizations/:organization_id/hostgroups 列出各個組織中的所有主機群組
GET /api/hostgroups/:id 顯示主機群組
POST /api/hostgroups 建立主機群組
PUT /api/hostgroups/:id 更新主機群組
DELETE /api/hostgroups/:id 刪除主機群組
POST /api/hostgroups/:id/clone 複製主機群組
PUT /api/hostgroups/:id/rebuild_config 重建協調配置

Hosts

資源 描述
GET /api/hosts 列出所有主機
GET /api/hostgroups/:hostgroup_id/hosts 列出主機群組的所有主機
GET /api/locations/:location_id/hosts 列出各個位置中的主機
GET /api/organizations/:organization_id/hosts 列出各個組織中的主機
GET /api/environments/:environment_id/hosts 列出各個環境中的主機
GET /api/hosts/:id 顯示主機
POST /api/hosts 建立主機
PUT /api/hosts/:id 更新主機
DELETE /api/hosts/:id 刪除主機
GET /api/hosts/:id/enc Get ENC values of host
GET /api/hosts/:id/status 取得主機配置狀態
GET /api/hosts/:id/status/:type 取得主機的狀態
GET /api/hosts/:id/vm_compute_attributes 取得主機的 vm 狀態
PUT /api/hosts/:id/disassociate 解除主機與 VM 的相聯性
PUT /api/hosts/:id/power 在主機上執行一項電源作業
PUT /api/hosts/:id/boot 從特定裝置啟動主機
POST /api/hosts/facts 上傳主機的詳情,並視需求建立主機
PUT /api/hosts/:id/rebuild_config 重建協調配置
GET /api/hosts/:id/template/:kind 預覽已轉譯的範本內容

Http proxies

資源 描述
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

資源 描述
GET /api/compute_resources/:compute_resource_id/images 列出運算資源的所有映像檔
GET /api/operatingsystems/:operatingsystem_id/images 列出作業系統的所有映像檔
GET /api/architectures/:architecture_id/images 列出架構的所有映像檔
GET /api/compute_resources/:compute_resource_id/images/:id 顯示映像檔
GET /api/operatingsystems/:operatingsystem_id/images/:id 顯示映像檔
GET /api/architectures/:architecture_id/images/:id 顯示映像檔
POST /api/compute_resources/:compute_resource_id/images 建立映像檔
PUT /api/compute_resources/:compute_resource_id/images/:id 更新映像檔
DELETE /api/compute_resources/:compute_resource_id/images/:id 刪除映像檔

Interfaces

資源 描述
GET /api/hosts/:host_id/interfaces 列出主機的所有介面卡
GET /api/domains/:domain_id/interfaces 列出區域中的所有介面卡
GET /api/subnets/:subnet_id/interfaces 列出子網路中的所有介面卡
GET /api/hosts/:host_id/interfaces/:id 顯示主機的介面卡
POST /api/hosts/:host_id/interfaces 在主機上建立介面
PUT /api/hosts/:host_id/interfaces/:id 更新主機的介面卡
DELETE /api/hosts/:host_id/interfaces/:id 刪除主機的介面卡

Locations

資源 描述
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

資源 描述
GET /api/mail_notifications 電子郵件通知之清單
GET /api/mail_notifications/:id 顯示電子郵件通知

Media

資源 描述
GET /api/media 列出所有安裝媒介
GET /api/operatingsystems/:operatingsystem_id/media 列出作業系統的所有媒介
GET /api/locations/:location_id/media 列出各個位置上的所有媒介
GET /api/organizations/:organization_id/media 列出各個組織中的所有媒介
GET /api/media/:id 顯示媒介
POST /api/media 建立媒介
PUT /api/media/:id 更新媒介
DELETE /api/media/:id 刪除媒介

Models

資源 描述
GET /api/models 列出所有硬體型號
GET /api/models/:id 顯示硬體型號
POST /api/models 建立硬體型號
PUT /api/models/:id 更新硬體型號
DELETE /api/models/:id 刪除硬體型號

Operating systems

資源 描述
GET /api/operatingsystems 列出所有作業系統
GET /api/architectures/:architecture_id/operatingsystems 列出巢狀架構的所有作業系統
GET /api/media/:medium_id/operatingsystems 列出巢狀媒介的所有作業系統
GET /api/ptables/:ptable_id/operatingsystems 列出巢狀分割表的所有作業系統
GET /api/config_templates/:config_template_id/operatingsystems 列出巢狀佈建範本的所有作業系統
GET /api/provisioning_templates/:provisioning_template_id/operatingsystems 列出巢狀佈建範本的所有作業系統
GET /api/operatingsystems/:id 顯示作業系統
POST /api/operatingsystems 建立作業系統
PUT /api/operatingsystems/:id 更新作業系統
DELETE /api/operatingsystems/:id 刪除作業系統
GET /api/operatingsystems/:id/bootfiles 列出作業系統的開機檔案

Organizations

資源 描述
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

資源 描述
GET /api/operatingsystems/:operatingsystem_id/os_default_templates 列出一個作業系統的預設範本組合
GET /api/config_templates/:config_template_id/os_default_templates 列出作業系統,而此範本已被設為預設值
GET /api/provisioning_templates/:provisioning_template_id/os_default_templates 列出作業系統,而此範本已被設為預設值
GET /api/operatingsystems/:operatingsystem_id/os_default_templates/:id 顯示一個作業系統的預設範本組合
POST /api/operatingsystems/:operatingsystem_id/os_default_templates 為作業系統建立預設範本
PUT /api/operatingsystems/:operatingsystem_id/os_default_templates/:id 更新作業系統的預設範本組合
DELETE /api/operatingsystems/:operatingsystem_id/os_default_templates/:id 刪除一個作業系統的預設範本組合

Override values

資源 描述
GET /api/smart_variables/:smart_variable_id/override_values 特定智慧型變數的置換值之清單
GET /api/smart_class_parameters/:smart_class_parameter_id/override_values 特定智慧型類別參數的置換值之清單
GET /api/smart_variables/:smart_variable_id/override_values/:id 顯示特定智慧變數的置換值
GET /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id 顯示特定智慧類別參數的置換值
POST /api/smart_variables/:smart_variable_id/override_values 為特定智慧型變數建立置換值
POST /api/smart_class_parameters/:smart_class_parameter_id/override_values 為特定的智慧型類別參數建立置換值
PUT /api/smart_variables/:smart_variable_id/override_values/:id 更新特定智慧變數的置換值
PUT /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id 更新特定智慧類別參數的置換值
DELETE /api/smart_variables/:smart_variable_id/override_values/:id 刪除特定智慧型變數的置換值
DELETE /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id 刪除特定智慧型類別參數的置換值

Parameters

資源 描述
GET /api/hosts/:host_id/parameters 列出主機的所有參數
GET /api/hostgroups/:hostgroup_id/parameters 列出主機群組的所有參數
GET /api/domains/:domain_id/parameters 列出區域的所有參數
GET /api/operatingsystems/:operatingsystem_id/parameters 列出作業系統的所有參數
GET /api/locations/:location_id/parameters 列出位置上的所有參數
GET /api/organizations/:organization_id/parameters 列出組織的所有參數
GET /api/subnets/:subnet_id/parameters List all parameters for a subnet
GET /api/hosts/:host_id/parameters/:id 顯示主機的巢狀參數
GET /api/hostgroups/:hostgroup_id/parameters/:id 顯示主機群組的巢狀參數
GET /api/domains/:domain_id/parameters/:id 顯示區域的巢狀參數
GET /api/operatingsystems/:operatingsystem_id/parameters/:id 顯示作業系統的巢狀參數
GET /api/locations/:location_id/parameters/:id 顯示位置的巢狀參數
GET /api/organizations/:organization_id/parameters/:id 顯示組織的巢狀參數
GET /api/subnets/:subnet_id/parameters/:id Show a nested parameter for a subnet
POST /api/hosts/:host_id/parameters 為主機建立巢式參數
POST /api/hostgroups/:hostgroup_id/parameters 為主機群組建立巢式參數
POST /api/domains/:domain_id/parameters 為網域建立巢式參數
POST /api/operatingsystems/:operatingsystem_id/parameters 為作業系統建立巢式參數。
POST /api/locations/:location_id/parameters 為地點建立巢式參數
POST /api/organizations/:organization_id/parameters 為組織建立巢式參數。
POST /api/subnets/:subnet_id/parameters Create a nested parameter for a subnet
PUT /api/hosts/:host_id/parameters/:id 更新主機的巢狀參數
PUT /api/hostgroups/:hostgroup_id/parameters/:id 更新主機群組的巢狀參數
PUT /api/domains/:domain_id/parameters/:id 更新區域的巢狀參數
PUT /api/operatingsystems/:operatingsystem_id/parameters/:id 更新作業系統的巢狀參數
PUT /api/locations/:location_id/parameters/:id 更新位置的巢狀參數
PUT /api/organizations/:organization_id/parameters/:id 更新組織的巢狀參數
PUT /api/subnets/:subnet_id/parameters/:id Update a nested parameter for a subnet
DELETE /api/hosts/:host_id/parameters/:id 刪除主機的巢狀參數
DELETE /api/hostgroups/:hostgroup_id/parameters/:id 刪除主機群組的巢狀參數
DELETE /api/domains/:domain_id/parameters/:id 刪除區域的巢狀參數
DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id 刪除作業系統的巢狀參數
DELETE /api/locations/:location_id/parameters/:id 刪除位置的巢狀參數
DELETE /api/organizations/:organization_id/parameters/:id 刪除組織的巢狀參數
DELETE /api/subnets/:subnet_id/parameters/:id Delete a nested parameter for a subnet
DELETE /api/hosts/:host_id/parameters 刪除一個主機上的所有巢狀參數
DELETE /api/hostgroups/:hostgroup_id/parameters 刪除一個主機群組中的所有巢狀參數
DELETE /api/domains/:domain_id/parameters 刪除一個區域中的所有巢狀參數
DELETE /api/operatingsystems/:operatingsystem_id/parameters 刪除作業系統上的所有巢狀參數
DELETE /api/locations/:location_id/parameters 刪除一個位置上的所有巢狀參數
DELETE /api/organizations/:organization_id/parameters 刪除一個組織中的所有巢狀參數
DELETE /api/subnets/:subnet_id/parameters Delete all nested parameters for a subnet

Permissions

資源 描述
GET /api/permissions 列出所有權限
GET /api/permissions/:id 顯示權限
GET /api/permissions/resource_types 列出可用的資源類型

Personal access tokens

資源 描述
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

資源 描述
GET /api/plugins 列出已安裝的外掛程式

Provisioning templates

資源 描述
GET /api/provisioning_templates 列出佈建範本
GET /api/operatingsystems/:operatingsystem_id/provisioning_templates 列出各個作業系統的佈建範本
GET /api/locations/:location_id/provisioning_templates 列出各個位置上的佈建範本
GET /api/organizations/:organization_id/provisioning_templates 列出各個組織的佈建範本
GET /api/provisioning_templates/:id 顯示佈建範本的詳情
POST /api/provisioning_templates 建立佈建範本
PUT /api/provisioning_templates/:id 更新佈建範本
GET /api/provisioning_templates/revision
DELETE /api/provisioning_templates/:id 刪除佈建範本
POST /api/provisioning_templates/build_pxe_default 更新所有經過配置的 TFTP 伺服器上的預設 PXE 選單
POST /api/provisioning_templates/:id/clone 複製佈建範本
GET /api/provisioning_templates/:id/export Export a provisioning template to ERB

Ptables

資源 描述
GET /api/ptables 列出所有分割表
GET /api/operatingsystems/:operatingsystem_id/ptables 列出作業系統的所有分割表
GET /api/locations/:location_id/ptables 列出每個地點的所有分割表
GET /api/organizations/:organization_id/ptables 列出各個組織的所有分割表
GET /api/ptables/:id 顯示分割表
POST /api/ptables 建立分割表
GET /api/ptables/revision
PUT /api/ptables/:id 更新分割表
DELETE /api/ptables/:id 刪除磁碟分割表
POST /api/ptables/:id/clone 複製範本
GET /api/ptables/:id/export Export a partition template to ERB

Puppet hosts

資源 描述
PUT /api/hosts/:id/puppetrun 強制 Puppet 代理程式在主機上執行

Puppetclasses

資源 描述
GET /api/puppetclasses 列出所有 Puppet 類別
GET /api/hosts/:host_id/puppetclasses 列出主機的所有 Puppet 類別
GET /api/hostgroups/:hostgroup_id/puppetclasses 列出主機的所有 Puppet 類別
GET /api/environments/:environment_id/puppetclasses 列出環境的所有 Puppet 類別
GET /api/puppetclasses/:id 顯示 Puppet 類別
GET /api/hosts/:host_id/puppetclasses/:id 顯示主機的 Puppet 類別
GET /api/hostgroups/:hostgroup_id/puppetclasses/:id 顯示主機群組的 Puppet 類別
GET /api/environments/:environment_id/puppetclasses/:id 顯示環境的 Puppet 類別
POST /api/puppetclasses 建立 Puppet 類別
PUT /api/puppetclasses/:id 更新 Puppet 類別
DELETE /api/puppetclasses/:id 刪除 Puppet 類別

Realms

資源 描述
GET /api/realms 領域清單
GET /api/realms/:id 顯示領域
POST /api/realms 建立領域
PUT /api/realms/:id 更新領域
DELETE /api/realms/:id 刪除領域

Reports

資源 描述
GET /api/reports 列出所有報告
GET /api/reports/:id 顯示報告
POST /api/reports 建立報表
DELETE /api/reports/:id 刪除報告
GET /api/hosts/:host_id/reports/last 顯示主機的最後報告

Roles

資源 描述
GET /api/roles 列出所有角色
GET /api/roles/:id 顯示角色
POST /api/roles 建立角色
PUT /api/roles/:id 更新角色
DELETE /api/roles/:id 刪除角色
POST /api/roles/:id/clone Clone a role

Settings

資源 描述
GET /api/settings 列出所有設定
GET /api/settings/:id 顯示設定
PUT /api/settings/:id 更新設定

Smart class parameters

資源 描述
GET /api/smart_class_parameters 列出所有智慧型類別參數
GET /api/hosts/:host_id/smart_class_parameters 特定主機的智慧型類別參數之清單
GET /api/hostgroups/:hostgroup_id/smart_class_parameters 特定主機群組的智慧型類別參數之清單
GET /api/puppetclasses/:puppetclass_id/smart_class_parameters 特定 Puppet 類別的智慧型類別參數之清單
GET /api/environments/:environment_id/smart_class_parameters 特定環境的智慧型類別參數之清單
GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters 特定環境/Puppet 類別組合的智慧型類別參數之清單
GET /api/smart_class_parameters/:id 顯示智慧類別參數
PUT /api/smart_class_parameters/:id 更新智慧類別參數

Smart proxies

資源 描述
POST /api/smart_proxies/:id/import_puppetclasses 由 puppet 代理伺服器匯入 puppet 類別。
POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses 為環境由 puppet 代理伺服器匯入 puppet 類別
POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses 為環境由 puppet 代理伺服器匯入 puppet 類別
GET /api/smart_proxies 列出所有智慧型代理伺服器
GET /api/smart_proxies/:id 顯示智慧型代理伺服器
POST /api/smart_proxies 建立智慧型代理伺服器
PUT /api/smart_proxies/:id 更新智慧型代理伺服器
DELETE /api/smart_proxies/:id 刪除智慧型代理伺服器
PUT /api/smart_proxies/:id/refresh 更新智慧型代理伺服器的功能

Smart variables

資源 描述
GET /api/smart_variables 列出所有智慧型變數
GET /api/hosts/:host_id/smart_variables 特定主機的智慧型變數之清單
GET /api/hostgroups/:hostgroup_id/smart_variables 特定主機群組的智慧型變數之清單
GET /api/puppetclasses/:puppetclass_id/smart_variables 特定 Puppet 類別的智慧型變數之清單
GET /api/smart_variables/:id 顯示智慧變數
POST /api/smart_variables 建立智慧型變數
PUT /api/smart_variables/:id 更新智慧變數
DELETE /api/smart_variables/:id 刪除智慧變數

Ssh keys

資源 描述
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

資源 描述
GET /api/statistics 取得數據

Subnets

資源 描述
GET /api/subnets 子網路清單
GET /api/domains/:domain_id/subnets 區域的子網路清單
GET /api/locations/:location_id/subnets 各個位置上的子網路之清單
GET /api/organizations/:organization_id/subnets 各個組織中的子網路之清單
GET /api/subnets/:id 顯示子網路
POST /api/subnets 建立子網路
PUT /api/subnets/:id 更新子網路
DELETE /api/subnets/:id 刪除子網路
GET /api/subnets/:id/freeip Provides an unused IP address in this subnet

Tasks

資源 描述
GET /api/orchestration/:id/tasks 列出某個協調流程事件的所有任務

Template combinations

資源 描述
GET /api/config_templates/:config_template_id/template_combinations DEPRECATED 列出範本組合
GET /api/provisioning_templates/:provisioning_template_id/template_combinations 列出範本組合
GET /api/hostgroups/:hostgroup_id/template_combinations 列出範本組合
GET /api/environments/:environment_id/template_combinations 列出範本組合
POST /api/config_templates/:config_template_id/template_combinations DEPRECATED 新增範本組合
POST /api/provisioning_templates/:provisioning_template_id/template_combinations 新增範本組合
POST /api/hostgroups/:hostgroup_id/template_combinations 新增範本組合
POST /api/environments/:environment_id/template_combinations 新增範本組合
GET /api/template_combinations/:id 顯示範本組合
GET /api/config_templates/:config_template_id/template_combinations/:id DEPRECATED 顯示範本組合
GET /api/provisioning_templates/:provisioning_template_id/template_combinations/:id 顯示範本組合
GET /api/hostgroups/:hostgroup_id/template_combinations/:id 顯示範本組合
GET /api/environments/:environment_id/template_combinations/:id 顯示範本組合
PUT /api/provisioning_templates/:provisioning_template_id/template_combinations/:id 更新範本組合
PUT /api/config_templates/:config_template_id/template_combinations/:id DEPRECATED 更新範本組合
PUT /api/hostgroups/:hostgroup_id/template_combinations/:id 更新範本組合
PUT /api/environments/:environment_id/template_combinations/:id 更新範本組合
DELETE /api/template_combinations/:id 刪除範本組合

Template kinds

資源 描述
GET /api/template_kinds 列出所有範本類型

Usergroups

資源 描述
GET /api/usergroups 列出所有使用者群組
GET /api/usergroups/:id 顯示使用者群組
POST /api/usergroups 建立使用者群組
PUT /api/usergroups/:id 更新使用者群組
DELETE /api/usergroups/:id 刪除使用者群組

Users

資源 描述
GET /api/users 列出所有使用者
GET /api/auth_source_ldaps/:auth_source_ldap_id/users 列出 LDAP 認證來源的所有使用者
GET /api/usergroups/:usergroup_id/users 列出使用者群組中的所有使用者
GET /api/roles/:role_id/users 列出角色的所有使用者
GET /api/locations/:location_id/users 列出位置中的所有使用者
GET /api/organizations/:organization_id/users 列出組織中的所有使用者
GET /api/users/:id 顯示使用者
POST /api/users 建立使用者
PUT /api/users/:id 更新使用者
DELETE /api/users/:id 刪除使用者