Jump to

• Request
• Response

Bulk Host Delete

get

/api/v2/bulk/host_delete/

This endpoint allows the client to delete multiple hosts from inventories. They may do this by providing a list of hosts ID's to be deleted.

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/BulkHostDelete"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

• Array of: object BulkHostDelete

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

Nested Schema : BulkHostDelete

Type: object

Show Source

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

  List of hosts ids to be deleted, e.g. [105, 130, 131, 200]

{
    "properties":{
        "hosts":{
            "description":"List of hosts ids to be deleted, e.g. [105, 130, 131, 200]",
            "items":{
                "type":"string",
                "x-nullable":true
            },
            "maxItems":"100000",
            "type":"array"
        }
    },
    "required":[
        "hosts"
    ],
    "type":"object"
}

Nested Schema : hosts

Type: array

Maximum Number of Items: 100000

List of hosts ids to be deleted, e.g. [105, 130, 131, 200]

Show Source

• Array of: string

{
    "description":"List of hosts ids to be deleted, e.g. [105, 130, 131, 200]",
    "items":{
        "type":"string",
        "x-nullable":true
    },
    "maxItems":"100000",
    "type":"array"
}

Back to Top