Config groups

>>>

GET /api/config_groups
設定グループの一覧

パラメーター

パラメーター名 記述
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.

検索フィールド

フィールド名 タイプ 設定可能な値
class string
name string
>>>

GET /api/config_groups/:id
設定グループの表示

パラメーター

パラメーター名 記述
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/config_groups
設定グループの作成

例

POST /api/config_groups
{
  "config_group": {
    "name": "config-group",
    "puppetclass_ids": [
      980190962,
      281110143
    ]
  }
}
201
{
  "created_at": "2019-09-11 14:38:32 UTC",
  "updated_at": "2019-09-11 14:38:32 UTC",
  "id": 980190963,
  "name": "config-group",
  "puppetclasses": [
    {
      "id": 980190962,
      "name": "base",
      "module_name": "base"
    },
    {
      "id": 281110143,
      "name": "vim",
      "module_name": "vim"
    }
  ]
}

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
config_group
必須

Validations:

  • Must be a Hash
config_group[name]
必須

Validations:

  • Must be a String
config_group[puppetclass_ids]
任意 , nil可

Validations:

  • Must be an array of any type
>>>

PUT /api/config_groups/:id
設定グループの更新

例

PUT /api/config_groups/980190962-Monitoring
{
  "config_group": {
    "name": "new name",
    "puppetclass_ids": [
      980190962,
      281110143
    ]
  }
}
200
{
  "created_at": "2019-09-11 14:38:12 UTC",
  "updated_at": "2019-09-11 14:38:32 UTC",
  "id": 980190962,
  "name": "new name",
  "puppetclasses": [
    {
      "id": 980190962,
      "name": "base",
      "module_name": "base"
    },
    {
      "id": 281110143,
      "name": "vim",
      "module_name": "vim"
    }
  ]
}

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
id
必須

Validations:

  • Must be a String
config_group
必須

Validations:

  • Must be a Hash
config_group[name]
任意

Validations:

  • Must be a String
config_group[puppetclass_ids]
任意 , nil可

Validations:

  • Must be an array of any type
>>>

DELETE /api/config_groups/:id
設定グループの削除

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
id
必須

Validations:

  • Must be a String