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 クラスをインポート

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

smart_proxy_id
任意

Validations:

  • Must be a String

environment_id
任意

Validations:

  • Must be a String

dryrun
任意

Validations:

  • Must be one of: true, false, 1, 0.

except
任意

インポートされた Puppe クラスを制限するために使用される ‘新規’、‘更新済み’、または ‘旧版’ のいずれかが含まれる、オプションのコンマ区切りの文字列 

Validations:

  • Must be a String


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
200
{
  "total": 3,
  "subtotal": 3,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2019-09-11 14:51:40 UTC",
      "updated_at": "2019-09-11 14:51:40 UTC",
      "name": "global_puppetmaster",
      "id": 153855663
    },
    {
      "created_at": "2019-09-11 14:51:40 UTC",
      "updated_at": "2019-09-11 14:51:40 UTC",
      "name": "production",
      "id": 334344675
    },
    {
      "created_at": "2019-09-11 14:51:40 UTC",
      "updated_at": "2019-09-11 14:51:40 UTC",
      "name": "testing",
      "id": 687036937
    }
  ]
}

パラメーター

パラメーター名 記述
puppetclass_id
任意

Puppet クラスの ID

Validations:

  • Must be a String

location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
location string
location_id integer
name string
organization string
organization_id integer

GET /api/environments/:id
環境の表示

GET /api/environments/334344675
200
{
  "created_at": "2019-09-11 14:51:40 UTC",
  "updated_at": "2019-09-11 14:51:40 UTC",
  "name": "production",
  "id": 334344675,
  "template_combinations": [
    {
      "id": 980190962,
      "provisioning_template_id": 943779058,
      "provisioning_template_name": "MyString",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common",
      "environment_id": 334344675,
      "environment_name": "production",
      "config_template_id": 943779058,
      "config_template_name": "MyString"
    },
    {
      "id": 113629430,
      "provisioning_template_id": 104314179,
      "provisioning_template_name": "MyFinish",
      "hostgroup_id": null,
      "hostgroup_name": null,
      "environment_id": 334344675,
      "environment_name": "production",
      "config_template_id": 104314179,
      "config_template_name": "MyFinish"
    },
    {
      "id": 281110143,
      "provisioning_template_id": 269958254,
      "provisioning_template_name": "MyString2",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common",
      "environment_id": 334344675,
      "environment_name": "production",
      "config_template_id": 269958254,
      "config_template_name": "MyString2"
    },
    {
      "id": 1018350795,
      "provisioning_template_id": 981457253,
      "provisioning_template_name": "MyScript",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common",
      "environment_id": 334344675,
      "environment_name": "production",
      "config_template_id": 981457253,
      "config_template_name": "MyScript"
    }
  ],
  "puppetclasses": [
    {
      "id": 298486374,
      "name": "apache",
      "module_name": "apache"
    },
    {
      "id": 638205575,
      "name": "auth",
      "module_name": "auth"
    },
    {
      "id": 980190962,
      "name": "base",
      "module_name": "base"
    },
    {
      "id": 51848956,
      "name": "chkmk",
      "module_name": "chkmk"
    },
    {
      "id": 1018350795,
      "name": "nagios",
      "module_name": "nagios"
    },
    {
      "id": 374648174,
      "name": "pam",
      "module_name": "pam"
    },
    {
      "id": 281110143,
      "name": "vim",
      "module_name": "vim"
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/environments
環境の作成

POST /api/environments
{
  "environment": {
    "name": "some_environment",
    "organization_ids": [
      114267492
    ]
  }
}
201
{
  "created_at": "2019-09-11 14:51:49 UTC",
  "updated_at": "2019-09-11 14:51:49 UTC",
  "name": "some_environment",
  "id": 687036947,
  "template_combinations": [],
  "puppetclasses": [],
  "locations": [],
  "organizations": [
    {
      "id": 114267492,
      "name": "Empty Organization",
      "title": "Empty Organization",
      "description": null
    }
  ]
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

environment
必須

Validations:

  • Must be a Hash

environment[name]
必須

Validations:

  • Must be a String

environment[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

environment[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


PUT /api/environments/:id
環境の更新

PUT /api/environments/687036948
{
  "environment": {
    "location_ids": [
      255093256
    ]
  }
}
200
{
  "created_at": "2019-09-11 14:51:49 UTC",
  "updated_at": "2019-09-11 14:51:49 UTC",
  "name": "environment258",
  "id": 687036948,
  "template_combinations": [],
  "puppetclasses": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

environment
必須

Validations:

  • Must be a Hash

environment[name]
任意

Validations:

  • Must be a String

environment[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

environment[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


DELETE /api/environments/:id
環境の削除

DELETE /api/environments/testing
{
  "environment": {}
}
200
{
  "id": 687036937,
  "name": "testing",
  "created_at": "2019-09-11T14:51:40.512Z",
  "updated_at": "2019-09-11T14:51:40.512Z"
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.