Jump to

• Request
• Response

Bulk Host Create

get

/api/v2/bulk/host_create/

This endpoint allows the client to create multiple hosts and associate them with an inventory. They may do this by providing the inventory ID and a list of json that would normally be provided to create hosts.

Request

Supported Media Types

• application/json

Query Parameters

• page: integer
  A page number within the paginated result set.
• page_size: integer
  Number of results to return per page.
• search: string
  A search term.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/BulkHostCreate"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

• Array of: object BulkHostCreate

{
    "items":{
        "$ref":"#/definitions/BulkHostCreate"
    },
    "type":"array"
}

Nested Schema : BulkHostCreate

Type: object

Show Source

• hosts(required): array hosts
  Maximum Number of Items: 100000

  List of hosts to be created, JSON. e.g. [{"name": "example.com"}, {"name": "127.0.0.1"}]
• inventory(required): integer
  Title: Inventory

  Primary Key ID of inventory to add hosts to.

{
    "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"
}

Nested Schema : hosts

Type: array

Maximum Number of Items: 100000

List of hosts to be created, JSON. e.g. [{"name": "example.com"}, {"name": "127.0.0.1"}]

Show Source

• Array of: object 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"
}

Nested Schema : BulkHost

Type: object

Show Source

• description: string
  Title: Description
• enabled: boolean
  Title: Enabled

  Default Value: true

  Is this host online and available for running jobs?
• instance_id: string
  Title: Instance id

  Maximum Length: 1024

  The value used by the remote inventory source to uniquely identify the host
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• variables: string
  Title: Variables

  Host variables in JSON or YAML format.

{
    "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"
}

Back to Top