移動先

• リクエスト
• レスポンス

バルク・ホストの作成

post

/api/v2/bulk/host_create/

このエンドポイントを使用すると、クライアントは複数のホストを作成し、それらをインベントリに関連付けられるようになります。この操作を行うには、インベントリIDと、一般的にホストの作成時に提供されるJSONリストを提供します。

リクエスト

サポートされているメディア・タイプ

• application/json

本文()

ルート・スキーマ : BulkHostCreate

型: object

ソースを表示

• hosts(必須): 配列 hosts
  最大アイテム数: 100000

  作成するホストのリスト、JSON。例: [{"name": "example.com"}, {"name": "127.0.0.1"}]
• inventory(必須): 整数
  タイトル: Inventory

  ホストを追加するインベントリの主キーID。

{
    "properties":{
        "hosts":{
            "description":"List of hosts to be created, JSON. e.g. [{\"name\": \"example.com\"}, {\"name\": \"127.0.0.1\"}]",
            "items":{
                "$ref":"#/definitions/BulkHost"
            },
            "maxItems":"100000",
            "type":"array"
        },
        "inventory":{
            "description":"Primary Key ID of inventory to add hosts to.",
            "title":"Inventory",
            "type":"integer"
        }
    },
    "required":[
        "inventory",
        "hosts"
    ],
    "type":"object"
}

ネストされたスキーマ : hosts

型: array

最大アイテム数: 100000

作成するホストのリスト、JSON。例: [{"name": "example.com"}, {"name": "127.0.0.1"}]

ソースを表示

• 配列: オブジェクト BulkHost

{
    "description":"List of hosts to be created, JSON. e.g. [{\"name\": \"example.com\"}, {\"name\": \"127.0.0.1\"}]",
    "items":{
        "$ref":"#/definitions/BulkHost"
    },
    "maxItems":"100000",
    "type":"array"
}

ネストされたスキーマ : BulkHost

型: object

ソースを表示

• description: 文字列
  タイトル: Description
• enabled: ブール
  タイトル: Enabled

  デフォルト値: true

  このホストはオンラインであり、ジョブの実行に使用できますか。
• instance_id: 文字列
  タイトル: Instance id

  最大長: 1024

  ホストを一意に識別するためにリモート・インベントリ・ソースによって使用される値
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• variables: 文字列
  タイトル: Variables

  JSONまたはYAML形式のホスト変数。

{
    "properties":{
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "enabled":{
            "default":true,
            "description":"Is this host online and available for running jobs?",
            "title":"Enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "instance_id":{
            "description":"The value used by the remote inventory source to uniquely identify the host",
            "maxLength":"1024",
            "title":"Instance id",
            "type":"string",
            "x-nullable":true
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "variables":{
            "description":"Host variables in JSON or YAML format.",
            "title":"Variables",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

201レスポンス

本文()

ルート・スキーマ : BulkHostCreate

型: object

ソースを表示

• hosts(必須): 配列 hosts
  最大アイテム数: 100000

  作成するホストのリスト、JSON。例: [{"name": "example.com"}, {"name": "127.0.0.1"}]
• inventory(必須): 整数
  タイトル: Inventory

  ホストを追加するインベントリの主キーID。

{
    "properties":{
        "hosts":{
            "description":"List of hosts to be created, JSON. e.g. [{\"name\": \"example.com\"}, {\"name\": \"127.0.0.1\"}]",
            "items":{
                "$ref":"#/definitions/BulkHost"
            },
            "maxItems":"100000",
            "type":"array"
        },
        "inventory":{
            "description":"Primary Key ID of inventory to add hosts to.",
            "title":"Inventory",
            "type":"integer"
        }
    },
    "required":[
        "inventory",
        "hosts"
    ],
    "type":"object"
}

ネストされたスキーマ : hosts

型: array

最大アイテム数: 100000

作成するホストのリスト、JSON。例: [{"name": "example.com"}, {"name": "127.0.0.1"}]

ソースを表示

• 配列: オブジェクト BulkHost

{
    "description":"List of hosts to be created, JSON. e.g. [{\"name\": \"example.com\"}, {\"name\": \"127.0.0.1\"}]",
    "items":{
        "$ref":"#/definitions/BulkHost"
    },
    "maxItems":"100000",
    "type":"array"
}

ネストされたスキーマ : BulkHost

型: object

ソースを表示

• description: 文字列
  タイトル: Description
• enabled: ブール
  タイトル: Enabled

  デフォルト値: true

  このホストはオンラインであり、ジョブの実行に使用できますか。
• instance_id: 文字列
  タイトル: Instance id

  最大長: 1024

  ホストを一意に識別するためにリモート・インベントリ・ソースによって使用される値
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• variables: 文字列
  タイトル: Variables

  JSONまたはYAML形式のホスト変数。

{
    "properties":{
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "enabled":{
            "default":true,
            "description":"Is this host online and available for running jobs?",
            "title":"Enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "instance_id":{
            "description":"The value used by the remote inventory source to uniquely identify the host",
            "maxLength":"1024",
            "title":"Instance id",
            "type":"string",
            "x-nullable":true
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "variables":{
            "description":"Host variables in JSON or YAML format.",
            "title":"Variables",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

先頭に戻る