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 場所ごとの LDAP 認証ソースを一覧表示します
GET /api/organizations/:organization_id/auth_source_ldaps 組織ごとの LDAP 認証ソースを一覧表示します
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 すべての自動署名エントリーを一覧表示
POST /api/smart_proxies/:smart_proxy_id/autosign 自動署名エントリーの作成
DELETE /api/smart_proxies/:smart_proxy_id/autosign/:id 自動署名エントリーの削除

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 コンピュートリソースキャッシュの更新

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 ホストの ENC 値の取得
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 サブネットのすべてのパラメーターを一覧表示
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 サブネットのネストされたパラメーターを表示
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 サブネットのネストされたパラメーターを作成
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 サブネットのネストされたパラメーターを更新
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 /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 サブネットのネストされたすべてのパラメーターを削除

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 プロビジョニングテンプレート 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 パーティションテンプレートを 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 ロールのクローン作成

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 ユーザーのすべての SSH 鍵を一覧表示
GET /api/users/:user_id/ssh_keys/:id ユーザーの SSH 鍵の表示
POST /api/users/:user_id/ssh_keys Add an SSH key for a user
DELETE /api/users/:user_id/ssh_keys/:id ユーザーの SSH 鍵の削除

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 このサブネットの未使用の IP アドレスを提供

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 ユーザーの削除