Update a Host
patch
/api/v2/hosts/{id}/
Make a PUT or PATCH request to this resource to update this host. The following fields may be modified:
name
: Name of this host. (string, required)description
: Optional description of this host. (string, default=""
)inventory
: (id, required)enabled
: Is this host online and available for running jobs? (boolean, default=True
)instance_id
: The value used by the remote inventory source to uniquely identify the host (string, default=""
)variables
: Host variables in JSON or YAML format. (json, default=``)
For a PATCH request, include only the fields that are being modified.
Request
Supported Media Types
- application/json
Path Parameters
Query Parameters
-
search(optional): string
A search term.
Root Schema : schema
Type:
Show Source
object
-
description(optional):
string
-
enabled(optional):
boolean
Is this host online and available for running jobs?
-
instance_id(optional):
string
The value used by the remote inventory source to uniquely identify the host
-
inventory(optional):
integer
-
name(optional):
string
-
variables(optional):
string
Host variables in JSON or YAML format.