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
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": {
    "class82": [
      {
        "id": 1018350796,
        "name": "class82",
        "created_at": "2019-09-11T14:53:24.240Z",
        "updated_at": "2019-09-11T14:53:24.240Z"
      }
    ]
  }
}

パラメーター

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

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

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

host_id
任意

ホストの ID

Validations:

  • Must be a String

hostgroup_id
任意

ホストグループの ID

Validations:

  • Must be a String

environment_id
任意

環境の ID

Validations:

  • Must be a String

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.

検索フィールド

フィールド名 タイプ 設定可能な値
config_group string
environment string
host string
hostgroup string
key string
location string
name string
organization string

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 クラスの表示

GET /api/environments/production/puppetclasses/980190962
200
{
  "created_at": "2019-09-11 14:57:07 UTC",
  "updated_at": "2019-09-11 14:57:07 UTC",
  "id": 980190962,
  "name": "base",
  "module_name": "base",
  "environments": [
    {
      "name": "production",
      "id": 334344675
    }
  ],
  "hostgroups": [
    {
      "id": 636252244,
      "name": "Common",
      "title": "Common",
      "description": null
    }
  ],
  "smart_variables": [
    {
      "variable": "bool_test",
      "id": 638205575
    },
    {
      "variable": "ssl_port",
      "id": 298486374
    }
  ],
  "smart_class_parameters": [
    {
      "parameter": "cluster",
      "id": 328495940
    }
  ]
}

パラメーター

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

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

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

host_id
任意

ホストの ID

Validations:

  • Must be a String

hostgroup_id
任意

ホストグループの ID

Validations:

  • Must be a String

environment_id
任意

環境の ID

Validations:

  • Must be a String

id
必須

Puppet クラスの ID

Validations:

  • Must be a String


POST /api/puppetclasses
Puppet クラスの作成

POST /api/puppetclasses
{
  "puppetclass": {
    "name": "test_puppetclass",
    "lookup_keys_attributes": [
      {
        "key": "smart_variable1"
      }
    ]
  }
}
201
{
  "created_at": "2019-09-11 14:57:13 UTC",
  "updated_at": "2019-09-11 14:57:13 UTC",
  "id": 1018350800,
  "name": "test_puppetclass",
  "module_name": "test_puppetclass",
  "environments": [],
  "hostgroups": [],
  "smart_variables": [
    {
      "variable": "smart_variable1",
      "id": 1018350797
    }
  ],
  "smart_class_parameters": []
}

パラメーター

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

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

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

puppetclass
必須

Validations:

  • Must be a Hash

puppetclass[name]
必須

Validations:

  • Must be a String


PUT /api/puppetclasses/:id
Puppet クラスの更新

PUT /api/puppetclasses/1018350797
{
  "smart_class_parameter_ids": [],
  "puppetclass": {}
}
200
{
  "created_at": "2019-09-11 14:57:13 UTC",
  "updated_at": "2019-09-11 14:57:13 UTC",
  "id": 1018350797,
  "name": "class376",
  "module_name": "class376",
  "environments": [
    {
      "name": "environment350",
      "id": 687036944
    }
  ],
  "hostgroups": [],
  "smart_variables": [],
  "smart_class_parameters": [
    {
      "parameter": "param335",
      "id": 1018350796
    }
  ]
}

パラメーター

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

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

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String

puppetclass
必須

Validations:

  • Must be a Hash

puppetclass[name]
任意

Validations:

  • Must be a String


DELETE /api/puppetclasses/:id
Puppet クラスの削除

DELETE /api/puppetclasses/980190962-base
{
  "puppetclass": {}
}
200
{
  "id": 980190962,
  "name": "base",
  "created_at": "2019-09-11T14:57:07.101Z",
  "updated_at": "2019-09-11T14:57:07.101Z"
}

パラメーター

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

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

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String