Skip to content

Instantly share code, notes, and snippets.

@fatmcgav

fatmcgav/1.9.2-v2.json

Last active January 15, 2016 15:56
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save fatmcgav/018a26acdf0aeb99b655 to your computer and use it in GitHub Desktop.
Save fatmcgav/018a26acdf0aeb99b655 to your computer and use it in GitHub Desktop.
Download ZIP
python-foreman Foreman 1.9
Raw
1.9.2-v2.json
This file has been truncated, but you can view the full file.
{
"docs": {
"info": "\n<p>Foreman API v2 is currently the default API version.</p>\n",
"name": "Foreman",
"copyright": "",
"link_extension": ".html",
"doc_url": "../apidoc/v2",
"resources": {
"tasks": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all tasks for a given orchestration event",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/orchestration/:id/tasks"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/tasks/index",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/tasks",
"name": "Tasks"
},
"common_parameters": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all global parameters.",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/common_parameters"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/common_parameters/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a global parameter",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/common_parameters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/common_parameters/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a global parameter",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/common_parameters"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "common_parameter",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "common_parameter[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "value",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "common_parameter[value]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "hidden_value",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: true, false.",
"full_name": "common_parameter[hidden_value]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "common_parameter",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/common_parameters/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a global parameter",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/common_parameters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "common_parameter",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "common_parameter[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "value",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "common_parameter[value]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "hidden_value",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: true, false.",
"full_name": "common_parameter[hidden_value]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "common_parameter",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/common_parameters/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a global parameter",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/common_parameters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/common_parameters/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/common_parameters",
"name": "Common parameters"
},
"hostgroups": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all host groups",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups"
},
{
"short_description": "List all host groups for a Puppet class",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/puppetclasses/:puppetclass_id/hostgroups"
},
{
"short_description": "List all host groups per location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/hostgroups"
},
{
"short_description": "List all host groups per organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/hostgroups"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "puppetclass_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "puppetclass_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of Puppet class</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hostgroups/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a host group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hostgroups/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a host group",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/hostgroups"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "hostgroup",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "parent_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[parent_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[environment_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[operatingsystem_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "architecture_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[architecture_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "medium_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[medium_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "ptable_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[ptable_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppet_ca_proxy_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[puppet_ca_proxy_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "subnet_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[subnet_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[domain_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "realm_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[realm_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppet_proxy_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[puppet_proxy_id]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "hostgroup",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hostgroups/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a host group",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/hostgroups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "hostgroup",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "parent_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[parent_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[environment_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[operatingsystem_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "architecture_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[architecture_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "medium_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[medium_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "ptable_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[ptable_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppet_ca_proxy_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[puppet_ca_proxy_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "subnet_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[subnet_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[domain_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "realm_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[realm_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppet_proxy_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "hostgroup[puppet_proxy_id]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "hostgroup",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hostgroups/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a host group",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/hostgroups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hostgroups/destroy",
"metadata": null
},
{
"errors": [],
"name": "clone",
"apis": [
{
"short_description": "Clone a host group",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/hostgroups/:id/clone"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "name",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hostgroups/clone",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/hostgroups",
"name": "Hostgroups"
},
"locations": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all locations",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/locations/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:id"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/locations/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a location",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/locations"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "location",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "location[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "location[description]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "user_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[user_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>User IDs</p>\n"
},
{
"name": "smart_proxy_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[smart_proxy_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Smart proxy IDs</p>\n"
},
{
"name": "compute_resource_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[compute_resource_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Compute resource IDs</p>\n"
},
{
"name": "media_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[media_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Media IDs</p>\n"
},
{
"name": "config_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[config_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Provisioning template IDs</p>\n"
},
{
"name": "ptable_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[ptable_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Partition template IDs</p>\n"
},
{
"name": "provisioning_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[provisioning_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Provisioning template IDs</p>\n"
},
{
"name": "domain_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[domain_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Domain IDs</p>\n"
},
{
"name": "realm_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[realm_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Realm IDs</p>\n"
},
{
"name": "hostgroup_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[hostgroup_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Host group IDs</p>\n"
},
{
"name": "environment_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[environment_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Environment IDs</p>\n"
},
{
"name": "subnet_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[subnet_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Subnet IDs</p>\n"
}
],
"full_name": "location",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/locations/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a location",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/locations/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "location",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "location[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "location[description]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "user_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[user_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>User IDs</p>\n"
},
{
"name": "smart_proxy_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[smart_proxy_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Smart proxy IDs</p>\n"
},
{
"name": "compute_resource_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[compute_resource_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Compute resource IDs</p>\n"
},
{
"name": "media_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[media_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Media IDs</p>\n"
},
{
"name": "config_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[config_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Provisioning template IDs</p>\n"
},
{
"name": "ptable_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[ptable_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Partition template IDs</p>\n"
},
{
"name": "provisioning_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[provisioning_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Provisioning template IDs</p>\n"
},
{
"name": "domain_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[domain_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Domain IDs</p>\n"
},
{
"name": "realm_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[realm_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Realm IDs</p>\n"
},
{
"name": "hostgroup_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[hostgroup_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Host group IDs</p>\n"
},
{
"name": "environment_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[environment_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Environment IDs</p>\n"
},
{
"name": "subnet_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "location[subnet_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Subnet IDs</p>\n"
}
],
"full_name": "location",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/locations/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a location",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/locations/:id"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/locations/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/locations",
"name": "Locations"
},
"override_values": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List of override values for a specific smart variable",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_variables/:smart_variable_id/override_values"
},
{
"short_description": "List of override values for a specific smart class parameter",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_class_parameters/:smart_class_parameter_id/override_values"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "smart_variable_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "smart_variable_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "smart_class_parameter_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "smart_class_parameter_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/override_values/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show an override value for a specific smart variable",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_variables/:smart_variable_id/override_values/:id"
},
{
"short_description": "Show an override value for a specific smart class parameter",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "smart_variable_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "smart_variable_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "smart_class_parameter_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "smart_class_parameter_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/override_values/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create an override value for a specific smart variable",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/smart_variables/:smart_variable_id/override_values"
},
{
"short_description": "Create an override value for a specific smart class parameter",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/smart_class_parameters/:smart_class_parameter_id/override_values"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "smart_variable_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "smart_variable_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "smart_class_parameter_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "smart_class_parameter_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "override_value",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "match",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "override_value[match]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Override match</p>\n"
},
{
"name": "value",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "override_value[value]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Override value</p>\n"
},
{
"name": "use_puppet_default",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "override_value[use_puppet_default]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "override_value",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/override_values/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update an override value for a specific smart variable",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/smart_variables/:smart_variable_id/override_values/:id"
},
{
"short_description": "Update an override value for a specific smart class parameter",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "smart_variable_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "smart_variable_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "smart_class_parameter_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "smart_class_parameter_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "override_value",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "match",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "override_value[match]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Override match</p>\n"
},
{
"name": "value",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "override_value[value]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Override value</p>\n"
},
{
"name": "use_puppet_default",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "override_value[use_puppet_default]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "override_value",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/override_values/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete an override value for a specific smart variable",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/smart_variables/:smart_variable_id/override_values/:id"
},
{
"short_description": "Delete an override value for a specific smart class parameter",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "smart_variable_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "smart_variable_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "smart_class_parameter_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "smart_class_parameter_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/override_values/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/override_values",
"name": "Override values"
},
"ptables": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all partition tables",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/ptables"
},
{
"short_description": "List all partition tables for an operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems/:operatingsystem_id/ptables"
},
{
"short_description": "List all partition tables per location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/ptables"
},
{
"short_description": "List all partition tables per organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/ptables"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/ptables/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a partition table",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/ptables/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/ptables/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a partition table",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/ptables"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "ptable",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "ptable[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "layout",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "ptable[layout]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "snippet",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "ptable[snippet]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "audit_comment",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "ptable[audit_comment]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "locked",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "ptable[locked]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Whether or not the template is locked for editing</p>\n"
},
{
"name": "os_family",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "ptable[os_family]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "operatingsystem_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "ptable[operatingsystem_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of operating system IDs to associate with the partition table</p>\n"
},
{
"name": "host_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "ptable[host_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of host IDs to associate with the partition table</p>\n"
},
{
"name": "hostgroup_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "ptable[hostgroup_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of host group IDs to associate with the partition table</p>\n"
}
],
"full_name": "ptable",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/ptables/create",
"metadata": null
},
{
"errors": [],
"name": "revision",
"apis": [
{
"short_description": null,
"deprecated": null,
"http_method": "GET",
"api_url": "/api/ptables/revision"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "version",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "version",
"expected_type": "string",
"metadata": null,
"description": "\n<p>template version</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/ptables/revision",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a partition table",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/ptables/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "ptable",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "ptable[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "layout",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "ptable[layout]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "snippet",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "ptable[snippet]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "audit_comment",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "ptable[audit_comment]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "locked",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "ptable[locked]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Whether or not the template is locked for editing</p>\n"
},
{
"name": "os_family",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "ptable[os_family]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "operatingsystem_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "ptable[operatingsystem_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of operating system IDs to associate with the partition table</p>\n"
},
{
"name": "host_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "ptable[host_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of host IDs to associate with the partition table</p>\n"
},
{
"name": "hostgroup_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "ptable[hostgroup_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of host group IDs to associate with the partition table</p>\n"
}
],
"full_name": "ptable",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/ptables/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a partition table",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/ptables/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/ptables/destroy",
"metadata": null
},
{
"errors": [],
"name": "clone",
"apis": [
{
"short_description": "Clone a template",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/ptables/:id/clone"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "ptable",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "ptable[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>template name</p>\n"
}
],
"full_name": "ptable",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/ptables/clone",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/ptables",
"name": "Ptables"
},
"images": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all images for a compute resource",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:compute_resource_id/images"
},
{
"short_description": "List all images for operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems/:operatingsystem_id/images"
},
{
"short_description": "List all images for architecture",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/architectures/:architecture_id/images"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "compute_resource_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "compute_resource_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of compute resource</p>\n"
},
{
"name": "architecture_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "architecture_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of architecture</p>\n"
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/images/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show an image",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:compute_resource_id/images/:id"
},
{
"short_description": "Show an image",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems/:operatingsystem_id/images/:id"
},
{
"short_description": "Show an image",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/architectures/:architecture_id/images/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_resource_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "compute_resource_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of compute resource</p>\n"
},
{
"name": "architecture_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "architecture_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of architecture</p>\n"
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/images/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create an image",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/compute_resources/:compute_resource_id/images"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "compute_resource_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "compute_resource_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "image",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "image[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "username",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "image[username]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "uuid",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "image[uuid]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_resource_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "image[compute_resource_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of compute resource</p>\n"
},
{
"name": "architecture_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "image[architecture_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of architecture</p>\n"
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "image[operatingsystem_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
}
],
"full_name": "image",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/images/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update an image",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/compute_resources/:compute_resource_id/images/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "compute_resource_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "compute_resource_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "image",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "image[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "username",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "image[username]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "uuid",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "image[uuid]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_resource_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "image[compute_resource_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of compute resource</p>\n"
},
{
"name": "architecture_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "image[architecture_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of architecture</p>\n"
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "image[operatingsystem_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
}
],
"full_name": "image",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/images/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete an image",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/compute_resources/:compute_resource_id/images/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "compute_resource_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "compute_resource_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/images/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/images",
"name": "Images"
},
"environments": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "import_puppetclasses",
"apis": [
{
"short_description": "Import puppet classes from puppet proxy.",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/smart_proxies/:id/import_puppetclasses"
},
{
"short_description": "Import puppet classes from puppet proxy for an environment",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses"
},
{
"short_description": "Import puppet classes from puppet proxy for an environment",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "smart_proxy_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_proxy_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "dryrun",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be 'true' or 'false'",
"full_name": "dryrun",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "except",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "except",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Optional comma-delimited string containing either 'new', 'updated', or\n'obsolete' that is used to limit the imported Puppet classes</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/environments/import_puppetclasses",
"metadata": null
},
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all environments",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/environments"
},
{
"short_description": "List environments of Puppet class",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/puppetclasses/:puppetclass_id/environments"
},
{
"short_description": "List environments per location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/environments"
},
{
"short_description": "List environments per organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/environments"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "puppetclass_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "puppetclass_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of Puppet class</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/environments/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show an environment",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/environments/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/environments/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create an environment",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/environments"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "environment",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment[name]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "environment",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/environments/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update an environment",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/environments/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "environment",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment[name]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "environment",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/environments/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete an environment",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/environments/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/environments/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/environments",
"name": "Environments"
},
"filters": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all filters",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/filters"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/filters/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a filter",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/filters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/filters/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a filter",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/filters"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "filter",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "role_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "filter[role_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "filter[search]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "permission_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "filter[permission_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "organization_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "filter[organization_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "location_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "filter[location_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
}
],
"full_name": "filter",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/filters/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a filter",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/filters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "filter",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "role_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "filter[role_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "filter[search]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "permission_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "filter[permission_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "organization_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "filter[organization_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "location_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "filter[location_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
}
],
"full_name": "filter",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/filters/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a filter",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/filters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/filters/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/filters",
"name": "Filters"
},
"plugins": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List installed plugins",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/plugins"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/plugins/index",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/plugins",
"name": "Plugins"
},
"compute_resources": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all compute resources",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a compute resource",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a compute resource",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/compute_resources"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "compute_resource",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "compute_resource[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "provider",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[provider]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Providers include Libvirt, Ovirt, Vmware, Openstack, Rackspace, GCE</p>\n"
},
{
"name": "url",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[url]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>URL for Libvirt, oVirt, and OpenStack</p>\n"
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[description]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "user",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[user]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2.</p>\n"
},
{
"name": "password",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[password]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Password for oVirt, EC2, VMware, OpenStack. Secret key for EC2</p>\n"
},
{
"name": "uuid",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[uuid]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>for oVirt, VMware Datacenter</p>\n"
},
{
"name": "region",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[region]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>for EC2 only</p>\n"
},
{
"name": "tenant",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[tenant]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>for OpenStack only</p>\n"
},
{
"name": "server",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[server]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>for VMware</p>\n"
},
{
"name": "set_console_password",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "compute_resource[set_console_password]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>for Libvirt and VMware only</p>\n"
}
],
"full_name": "compute_resource",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a compute resource",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/compute_resources/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_resource",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "compute_resource[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "provider",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[provider]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Providers include Libvirt, Ovirt, Vmware, Openstack, Rackspace, GCE</p>\n"
},
{
"name": "url",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[url]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>URL for Libvirt, oVirt, and OpenStack</p>\n"
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[description]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "user",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[user]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2.</p>\n"
},
{
"name": "password",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[password]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Password for oVirt, EC2, VMware, OpenStack. Secret key for EC2</p>\n"
},
{
"name": "uuid",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[uuid]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>for oVirt, VMware Datacenter</p>\n"
},
{
"name": "region",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[region]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>for EC2 only</p>\n"
},
{
"name": "tenant",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[tenant]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>for OpenStack only</p>\n"
},
{
"name": "server",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "compute_resource[server]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>for VMware</p>\n"
},
{
"name": "set_console_password",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "compute_resource[set_console_password]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>for Libvirt and VMware only</p>\n"
}
],
"full_name": "compute_resource",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a compute resource",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/compute_resources/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/destroy",
"metadata": null
},
{
"errors": [],
"name": "available_images",
"apis": [
{
"short_description": "List available images for a compute resource",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:id/available_images"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/available_images",
"metadata": null
},
{
"errors": [],
"name": "available_clusters",
"apis": [
{
"short_description": "List available clusters for a compute resource",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:id/available_clusters"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/available_clusters",
"metadata": null
},
{
"errors": [],
"name": "available_folders",
"apis": [
{
"short_description": "List available folders for a compute resource",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:id/available_folders"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/available_folders",
"metadata": null
},
{
"errors": [],
"name": "available_networks",
"apis": [
{
"short_description": "List available networks for a compute resource",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:id/available_networks"
},
{
"short_description": "List available networks for a compute resource cluster",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:id/available_clusters/:cluster_id/available_networks"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "cluster_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "cluster_id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/available_networks",
"metadata": null
},
{
"errors": [],
"name": "available_resource_pools",
"apis": [
{
"short_description": "List resource pools for a compute resource cluster",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "cluster_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "cluster_id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/available_resource_pools",
"metadata": null
},
{
"errors": [],
"name": "available_storage_domains",
"apis": [
{
"short_description": "List storage_domains for a compute resource",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:id/available_storage_domains"
},
{
"short_description": "List storage domains for a compute resource",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:id/available_storage_domains"
},
{
"short_description": "List attributes for a given storage domain",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_resources/:id/available_storage_domains/:storage_domain"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "storage_domain",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "storage_domain",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/available_storage_domains",
"metadata": null
},
{
"errors": [],
"name": "associate",
"apis": [
{
"short_description": "Associate VMs to Hosts",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/compute_resources/:id/associate"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_resources/associate",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/compute_resources",
"name": "Compute resources"
},
"home": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "Show available API links",
"deprecated": null,
"http_method": "GET",
"api_url": "/api"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/home/index",
"metadata": null
},
{
"errors": [],
"name": "status",
"apis": [
{
"short_description": "Show status",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/status"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/home/status",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/home",
"name": "Home"
},
"audits": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all audits",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/audits"
},
{
"short_description": "List all audits for a given host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/audits"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/audits/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show an audit",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/audits/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/audits/show",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/audits",
"name": "Audits"
},
"smart_class_parameters": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all smart class parameters",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_class_parameters"
},
{
"short_description": "List of smart class parameters for a specific host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/smart_class_parameters"
},
{
"short_description": "List of smart class parameters for a specific host group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:hostgroup_id/smart_class_parameters"
},
{
"short_description": "List of smart class parameters for a specific Puppet class",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/puppetclasses/:puppetclass_id/smart_class_parameters"
},
{
"short_description": "List of smart class parameters for a specific environment",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/environments/:environment_id/smart_class_parameters"
},
{
"short_description": "List of smart class parameters for a specific environment/Puppet class combination",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppetclass_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "puppetclass_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "environment_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_class_parameters/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a smart class parameter",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_class_parameters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_class_parameters/show",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a smart class parameter",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/smart_class_parameters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "smart_class_parameter",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "override",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be 'true' or 'false'",
"full_name": "smart_class_parameter[override]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Whether the smart class parameter value is managed by Foreman</p>\n"
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_class_parameter[description]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Description of smart class</p>\n"
},
{
"name": "default_value",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_class_parameter[default_value]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Value to use when there is no match</p>\n"
},
{
"name": "use_puppet_default",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be 'true' or 'false'",
"full_name": "smart_class_parameter[use_puppet_default]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Do not send this parameter via the ENC. Puppet will use the value defined\nin the Puppet manifest for this parameter</p>\n"
},
{
"name": "path",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_class_parameter[path]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>A orde na cual se resolven os valores</p>\n"
},
{
"name": "validator_type",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be one of: regexp, list.",
"full_name": "smart_class_parameter[validator_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Types of validation values</p>\n"
},
{
"name": "validator_rule",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_class_parameter[validator_rule]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Used to enforce certain values for the parameter values</p>\n"
},
{
"name": "override_value_order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_class_parameter[override_value_order]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>A orde na cual se resolven os valores</p>\n"
},
{
"name": "parameter_type",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.",
"full_name": "smart_class_parameter[parameter_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Types of variable values</p>\n"
},
{
"name": "required",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be 'true' or 'false'",
"full_name": "smart_class_parameter[required]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>If true, will raise an error if there is no default value and no matcher\nprovide a value</p>\n"
},
{
"name": "merge_overrides",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be 'true' or 'false'",
"full_name": "smart_class_parameter[merge_overrides]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Merge all matching values (only array/hash type)</p>\n"
},
{
"name": "avoid_duplicates",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be 'true' or 'false'",
"full_name": "smart_class_parameter[avoid_duplicates]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Remove duplicate values (only array type)</p>\n"
}
],
"full_name": "smart_class_parameter",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_class_parameters/update",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/smart_class_parameters",
"name": "Smart class parameters"
},
"bookmarks": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all bookmarks",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/bookmarks"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/bookmarks/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a bookmark",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/bookmarks/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/bookmarks/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a bookmark",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/bookmarks"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "bookmark",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "bookmark[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "controller",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "bookmark[controller]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "query",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "bookmark[query]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "public",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "bookmark[public]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "bookmark",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/bookmarks/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a bookmark",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/bookmarks/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "bookmark",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "bookmark[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "controller",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "bookmark[controller]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "query",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "bookmark[query]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "public",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "bookmark[public]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "bookmark",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/bookmarks/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a bookmark",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/bookmarks/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/bookmarks/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/bookmarks",
"name": "Bookmarks"
},
"auth_source_ldaps": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all LDAP authentication sources",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/auth_source_ldaps"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/auth_source_ldaps/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show an LDAP authentication source",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/auth_source_ldaps/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/auth_source_ldaps/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create an LDAP authentication source",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/auth_source_ldaps"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "auth_source_ldap",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "auth_source_ldap[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "host",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "auth_source_ldap[host]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "port",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "auth_source_ldap[port]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>defaults to 389</p>\n"
},
{
"name": "account",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[account]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "base_dn",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[base_dn]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "account_password",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[account_password]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if onthefly_register is true</p>\n"
},
{
"name": "attr_login",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[attr_login]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if onthefly_register is true</p>\n"
},
{
"name": "attr_firstname",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[attr_firstname]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if onthefly_register is true</p>\n"
},
{
"name": "attr_lastname",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[attr_lastname]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if onthefly_register is true</p>\n"
},
{
"name": "attr_mail",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[attr_mail]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if onthefly_register is true</p>\n"
},
{
"name": "attr_photo",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[attr_photo]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "onthefly_register",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "auth_source_ldap[onthefly_register]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "usergroup_sync",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "auth_source_ldap[usergroup_sync]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sync external user groups on login</p>\n"
},
{
"name": "tls",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "auth_source_ldap[tls]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "groups_base",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[groups_base]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>groups base DN</p>\n"
},
{
"name": "server_type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: free_ipa, active_directory, posix.",
"full_name": "auth_source_ldap[server_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>type of the LDAP server</p>\n"
},
{
"name": "ldap_filter",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[ldap_filter]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>LDAP filter</p>\n"
}
],
"full_name": "auth_source_ldap",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/auth_source_ldaps/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update an LDAP authentication source",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/auth_source_ldaps/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "auth_source_ldap",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "auth_source_ldap[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "host",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "auth_source_ldap[host]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "port",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "auth_source_ldap[port]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>defaults to 389</p>\n"
},
{
"name": "account",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[account]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "base_dn",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[base_dn]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "account_password",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[account_password]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if onthefly_register is true</p>\n"
},
{
"name": "attr_login",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[attr_login]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if onthefly_register is true</p>\n"
},
{
"name": "attr_firstname",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[attr_firstname]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if onthefly_register is true</p>\n"
},
{
"name": "attr_lastname",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[attr_lastname]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if onthefly_register is true</p>\n"
},
{
"name": "attr_mail",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[attr_mail]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if onthefly_register is true</p>\n"
},
{
"name": "attr_photo",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[attr_photo]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "onthefly_register",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "auth_source_ldap[onthefly_register]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "usergroup_sync",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "auth_source_ldap[usergroup_sync]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sync external user groups on login</p>\n"
},
{
"name": "tls",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "auth_source_ldap[tls]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "groups_base",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[groups_base]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>groups base DN</p>\n"
},
{
"name": "server_type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: free_ipa, active_directory, posix.",
"full_name": "auth_source_ldap[server_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>type of the LDAP server</p>\n"
},
{
"name": "ldap_filter",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "auth_source_ldap[ldap_filter]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>LDAP filter</p>\n"
}
],
"full_name": "auth_source_ldap",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/auth_source_ldaps/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete an LDAP authentication source",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/auth_source_ldaps/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/auth_source_ldaps/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/auth_source_ldaps",
"name": "Auth source ldaps"
},
"statistics": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "Get statistics",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/statistics"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/statistics/index",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/statistics",
"name": "Statistics"
},
"disks": {
"api_url": "/api",
"metadata": null,
"full_description": "",
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "Boot disks",
"deprecated": null,
"http_method": "GET",
"api_url": "/bootdisk/api"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/disks/index",
"metadata": null
},
{
"errors": [],
"name": "generic",
"apis": [
{
"short_description": "Download generic image",
"deprecated": null,
"http_method": "GET",
"api_url": "/bootdisk/api/generic"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/disks/generic",
"metadata": null
},
{
"errors": [],
"name": "host",
"apis": [
{
"short_description": "Download host image",
"deprecated": null,
"http_method": "GET",
"api_url": "/bootdisk/api/hosts/:host_id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "full",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be 'true' or 'false'",
"full_name": "full",
"expected_type": "string",
"metadata": null,
"description": "\n<p>True for full, false for basic reusable image</p>\n"
},
{
"name": "host_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/disks/host",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/disks",
"name": "Disks"
},
"parameters": {
"api_url": "/api",
"metadata": null,
"full_description": "\n<p>These API calls are related to <b>nested parameters for a host, domain,\nhost group, operating system</b>. If you are looking for &lt;a\nhref=\"common_parameters.html\"&gt;global parameters&lt;/a&gt;, go to &lt;a\nhref=\"common_parameters.html\"&gt;this link&lt;/a&gt;.</p>\n",
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all parameters for a host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/parameters"
},
{
"short_description": "List all parameters for a host group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:hostgroup_id/parameters"
},
{
"short_description": "List all parameters for a domain",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/domains/:domain_id/parameters"
},
{
"short_description": "List all parameters for an operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems/:operatingsystem_id/parameters"
},
{
"short_description": "List all parameters for a location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/parameters"
},
{
"short_description": "List all parameters for an organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/parameters"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "domain_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of domain</p>\n"
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "location_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "location_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of location</p>\n"
},
{
"name": "organization_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "organization_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of organization</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/parameters/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a nested parameter for a host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/parameters/:id"
},
{
"short_description": "Show a nested parameter for a host group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:hostgroup_id/parameters/:id"
},
{
"short_description": "Show a nested parameter for a domain",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/domains/:domain_id/parameters/:id"
},
{
"short_description": "Show a nested parameter for an operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems/:operatingsystem_id/parameters/:id"
},
{
"short_description": "Show a nested parameter for a location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/parameters/:id"
},
{
"short_description": "Show a nested parameter for an organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/parameters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "domain_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of domain</p>\n"
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "location_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "location_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of location</p>\n"
},
{
"name": "organization_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "organization_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of organization</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of parameter</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/parameters/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a nested parameter for a host",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/hosts/:host_id/parameters"
},
{
"short_description": "Create a nested parameter for a host group",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/hostgroups/:hostgroup_id/parameters"
},
{
"short_description": "Create a nested parameter for a domain",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/domains/:domain_id/parameters"
},
{
"short_description": "Create a nested parameter for an operating system",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/operatingsystems/:operatingsystem_id/parameters"
},
{
"short_description": "Create a nested parameter for a location",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/locations/:location_id/parameters"
},
{
"short_description": "Create a nested parameter for an organization",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/organizations/:organization_id/parameters"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "domain_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of domain</p>\n"
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "location_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "location_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of location</p>\n"
},
{
"name": "organization_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "organization_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of organization</p>\n"
},
{
"name": "parameter",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "parameter[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "value",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "parameter[value]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "parameter",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/parameters/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a nested parameter for a host",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/hosts/:host_id/parameters/:id"
},
{
"short_description": "Update a nested parameter for a host group",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/hostgroups/:hostgroup_id/parameters/:id"
},
{
"short_description": "Update a nested parameter for a domain",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/domains/:domain_id/parameters/:id"
},
{
"short_description": "Update a nested parameter for an operating system",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/operatingsystems/:operatingsystem_id/parameters/:id"
},
{
"short_description": "Update a nested parameter for a location",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/locations/:location_id/parameters/:id"
},
{
"short_description": "Update a nested parameter for an organization",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/organizations/:organization_id/parameters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "domain_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of domain</p>\n"
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "location_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "location_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of location</p>\n"
},
{
"name": "organization_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "organization_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of organization</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of parameter</p>\n"
},
{
"name": "parameter",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "parameter[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "value",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "parameter[value]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "parameter",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/parameters/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a nested parameter for a host",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/hosts/:host_id/parameters/:id"
},
{
"short_description": "Delete a nested parameter for a host group",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/hostgroups/:hostgroup_id/parameters/:id"
},
{
"short_description": "Delete a nested parameter for a domain",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/domains/:domain_id/parameters/:id"
},
{
"short_description": "Delete a nested parameter for an operating system",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/operatingsystems/:operatingsystem_id/parameters/:id"
},
{
"short_description": "Delete a nested parameter for a location",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/locations/:location_id/parameters/:id"
},
{
"short_description": "Delete a nested parameter for an organization",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/organizations/:organization_id/parameters/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "domain_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of domain</p>\n"
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "location_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "location_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of location</p>\n"
},
{
"name": "organization_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "organization_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of organization</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of parameter</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/parameters/destroy",
"metadata": null
},
{
"errors": [],
"name": "reset",
"apis": [
{
"short_description": "Delete all nested parameters for a host",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/hosts/:host_id/parameters"
},
{
"short_description": "Delete all nested parameters for a host group",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/hostgroups/:hostgroup_id/parameters"
},
{
"short_description": "Delete all nested parameters for a domain",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/domains/:domain_id/parameters"
},
{
"short_description": "Delete all nested parameters for an operating system",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/operatingsystems/:operatingsystem_id/parameters"
},
{
"short_description": "Delete all nested parameter for a location",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/locations/:location_id/parameters"
},
{
"short_description": "Delete all nested parameter for an organization",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/organizations/:organization_id/parameters"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "domain_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of domain</p>\n"
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "location_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "location_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of location</p>\n"
},
{
"name": "organization_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "organization_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of organization</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/parameters/reset",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/parameters",
"name": "Parameters"
},
"media": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all installation media",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/media"
},
{
"short_description": "List all media for an operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems/:operatingsystem_id/media"
},
{
"short_description": "List all media per location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/media"
},
{
"short_description": "List all media per organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/media"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/media/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a medium",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/media/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/media/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a medium",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/media"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "medium",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "medium[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Name of media</p>\n"
},
{
"name": "path",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "medium[path]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>The path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).</p>\n\n<p>for example <a\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\">mirror.centos.org/centos/$version/os/$arch</a>\nwhere $arch will be substituted for the host's actual OS architecture and\n$version, $major and $minor will be substituted for the version of the\noperating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>\n"
},
{
"name": "os_family",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "medium[os_family]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Operating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Redhat, Solaris, Suse,\nWindows</p>\n"
},
{
"name": "operatingsystem_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "medium[operatingsystem_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
}
],
"full_name": "medium",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/media/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a medium",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/media/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "medium",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "medium[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Name of media</p>\n"
},
{
"name": "path",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "medium[path]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>The path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).</p>\n\n<p>for example <a\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\">mirror.centos.org/centos/$version/os/$arch</a>\nwhere $arch will be substituted for the host's actual OS architecture and\n$version, $major and $minor will be substituted for the version of the\noperating system.</p>\n\n<p>Solaris and Debian media may also use $release.</p>\n"
},
{
"name": "os_family",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "medium[os_family]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Operating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Redhat, Solaris, Suse,\nWindows</p>\n"
},
{
"name": "operatingsystem_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "medium[operatingsystem_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
}
],
"full_name": "medium",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/media/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a medium",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/media/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/media/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/media",
"name": "Media"
},
"host_classes": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all Puppet class IDs for host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/puppetclass_ids"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/host_classes/index",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Add a Puppet class to host",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/hosts/:host_id/puppetclass_ids"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host</p>\n"
},
{
"name": "puppetclass_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "puppetclass_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of Puppet class</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/host_classes/create",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Remove a Puppet class from host",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/hosts/:host_id/puppetclass_ids/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of Puppet class</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/host_classes/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/host_classes",
"name": "Host classes"
},
"autosign": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all autosign entries",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_proxies/smart_proxy_id/autosign"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/autosign/index",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/autosign",
"name": "Autosign"
},
"fact_values": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all fact values",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/fact_values"
},
{
"short_description": "List all fact values of a given host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/facts"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/fact_values/index",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/fact_values",
"name": "Fact values"
},
"models": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all hardware models",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/models"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/models/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a hardware model",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/models/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/models/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a hardware model",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/models"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "model",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "model[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "info",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "model[info]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "vendor_class",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "model[vendor_class]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "hardware_model",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "model[hardware_model]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "model",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/models/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a hardware model",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/models/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "model",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "model[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "info",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "model[info]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "vendor_class",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "model[vendor_class]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "hardware_model",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "model[hardware_model]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "model",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/models/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a hardware model",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/models/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/models/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/models",
"name": "Models"
},
"subnets": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List of subnets",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/subnets"
},
{
"short_description": "List of subnets for a domain",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/domains/:domain_id/subnets"
},
{
"short_description": "List of subnets per location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/subnets"
},
{
"short_description": "List of subnets per organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/subnets"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "domain_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of domain</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/subnets/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a subnet",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/subnets/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/subnets/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a subnet",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/subnets"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "subnet",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "subnet[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Subnet name</p>\n"
},
{
"name": "network",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "subnet[network]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Subnet network</p>\n"
},
{
"name": "mask",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "subnet[mask]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>M\u00e1scara para esta subrede</p>\n"
},
{
"name": "gateway",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[gateway]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Primary DNS for this subnet</p>\n"
},
{
"name": "dns_primary",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[dns_primary]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Primary DNS for this subnet</p>\n"
},
{
"name": "dns_secondary",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[dns_secondary]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Secondary DNS for this subnet</p>\n"
},
{
"name": "ipam",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[ipam]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>IP Address auto suggestion mode for this subnet, valid values are \"DHCP\",\n\"Internal DB\", \"None\"</p>\n"
},
{
"name": "from",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[from]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Starting IP Address for IP auto suggestion</p>\n"
},
{
"name": "to",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[to]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Ending IP Address for IP auto suggestion</p>\n"
},
{
"name": "vlanid",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[vlanid]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>VLAN ID for this subnet</p>\n"
},
{
"name": "domain_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "subnet[domain_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Dominios aos que pertence esta subrede</p>\n"
},
{
"name": "dhcp_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "subnet[dhcp_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Proxy DHCP para usar con esta subrede</p>\n"
},
{
"name": "tftp_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "subnet[tftp_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Proxy TFTP para usar nesta subrede</p>\n"
},
{
"name": "dns_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "subnet[dns_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Proxy DNS para usar con esta subrede</p>\n"
},
{
"name": "boot_mode",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[boot_mode]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Default boot mode for interfaces assigned to this subnet, valid values are\n\"Static\", \"DHCP\"</p>\n"
}
],
"full_name": "subnet",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/subnets/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a subnet",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/subnets/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a number.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Subnet numeric identifier</p>\n"
},
{
"name": "subnet",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "subnet[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Subnet name</p>\n"
},
{
"name": "network",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "subnet[network]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Subnet network</p>\n"
},
{
"name": "mask",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "subnet[mask]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>M\u00e1scara para esta subrede</p>\n"
},
{
"name": "gateway",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[gateway]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Primary DNS for this subnet</p>\n"
},
{
"name": "dns_primary",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[dns_primary]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Primary DNS for this subnet</p>\n"
},
{
"name": "dns_secondary",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[dns_secondary]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Secondary DNS for this subnet</p>\n"
},
{
"name": "ipam",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[ipam]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>IP Address auto suggestion mode for this subnet, valid values are \"DHCP\",\n\"Internal DB\", \"None\"</p>\n"
},
{
"name": "from",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[from]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Starting IP Address for IP auto suggestion</p>\n"
},
{
"name": "to",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[to]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Ending IP Address for IP auto suggestion</p>\n"
},
{
"name": "vlanid",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[vlanid]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>VLAN ID for this subnet</p>\n"
},
{
"name": "domain_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "subnet[domain_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Dominios aos que pertence esta subrede</p>\n"
},
{
"name": "dhcp_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "subnet[dhcp_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Proxy DHCP para usar con esta subrede</p>\n"
},
{
"name": "tftp_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "subnet[tftp_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Proxy TFTP para usar nesta subrede</p>\n"
},
{
"name": "dns_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "subnet[dns_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Proxy DNS para usar con esta subrede</p>\n"
},
{
"name": "boot_mode",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "subnet[boot_mode]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Default boot mode for interfaces assigned to this subnet, valid values are\n\"Static\", \"DHCP\"</p>\n"
}
],
"full_name": "subnet",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/subnets/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a subnet",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/subnets/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a number.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Subnet numeric identifier</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/subnets/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/subnets",
"name": "Subnets"
},
"hostgroup_classes": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all Puppet class IDs for host group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:hostgroup_id/puppetclass_ids"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hostgroup_classes/index",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Add a Puppet class to host group",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/hostgroups/:hostgroup_id/puppetclass_ids"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "hostgroup_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "puppetclass_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "puppetclass_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of Puppet class</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hostgroup_classes/create",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Remove a Puppet class from host group",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/hostgroups/:hostgroup_id/puppetclass_ids/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "hostgroup_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of Puppet class</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hostgroup_classes/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/hostgroup_classes",
"name": "Hostgroup classes"
},
"config_groups": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List of config groups",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/config_groups"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_groups/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a config group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/config_groups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_groups/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a config group",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/config_groups"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "config_group",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_group[name]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "config_group",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_groups/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a config group",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/config_groups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "config_group",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_group[name]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "config_group",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_groups/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a config group",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/config_groups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_groups/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/config_groups",
"name": "Config groups"
},
"users": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all users",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/users"
},
{
"short_description": "List all users for LDAP authentication source",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/auth_source_ldaps/:auth_source_ldap_id/users"
},
{
"short_description": "List all users for user group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/usergroups/:usergroup_id/users"
},
{
"short_description": "List all users for role",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/roles/:role_id/users"
},
{
"short_description": "List all users for location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/users"
},
{
"short_description": "List all users for organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/users"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "auth_source_ldap_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "auth_source_ldap_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of LDAP authentication source</p>\n"
},
{
"name": "usergroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "usergroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of user group</p>\n"
},
{
"name": "role_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "role_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of role</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/users/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a user",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/users/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/users/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a user",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/users"
}
],
"full_description": "\n<p>Adds role 'Anonymous' to the user by default</p>\n",
"see": [],
"params": [
{
"name": "user",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "login",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "user[login]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "firstname",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "user[firstname]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "lastname",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "user[lastname]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "mail",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "user[mail]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "admin",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "user[admin]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>is an admin account</p>\n"
},
{
"name": "password",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "user[password]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "auth_source_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be Integer",
"full_name": "user[auth_source_id]",
"expected_type": "numeric",
"metadata": null,
"description": ""
},
{
"name": "timezone",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: UTC, International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Mountain Time (US & Canada), Arizona, Chihuahua, Mazatlan, Central Time (US & Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US & Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Georgetown, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Moscow, St. Petersburg, Volgograd, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Astana, Dhaka, Sri Jayawardenepura, Almaty, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Singapore, Taipei, Perth, Irkutsk, Ulaan Bataar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku'alofa, Tokelau Is., Samoa.",
"full_name": "user[timezone]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>User's timezone</p>\n"
},
{
"name": "locale",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: gl, it, ja, zh_TW, en, en_GB, ko, zh_CN, fr, es, sv_SE, pt_BR, ru, de.",
"full_name": "user[locale]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>User's preferred locale</p>\n"
}
],
"full_name": "user",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/users/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a user",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/users/:id"
}
],
"full_description": "\n<p>Adds role 'Anonymous' to the user if it is not already present. Only\nanother admin can change the admin account attribute.</p>\n",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "user",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "login",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "user[login]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "firstname",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "user[firstname]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "lastname",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "user[lastname]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "mail",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "user[mail]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "admin",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "user[admin]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>is an admin account</p>\n"
},
{
"name": "password",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "user[password]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "auth_source_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be Integer",
"full_name": "user[auth_source_id]",
"expected_type": "numeric",
"metadata": null,
"description": ""
},
{
"name": "timezone",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: UTC, International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Mountain Time (US & Canada), Arizona, Chihuahua, Mazatlan, Central Time (US & Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US & Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Georgetown, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Moscow, St. Petersburg, Volgograd, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Astana, Dhaka, Sri Jayawardenepura, Almaty, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Singapore, Taipei, Perth, Irkutsk, Ulaan Bataar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku'alofa, Tokelau Is., Samoa.",
"full_name": "user[timezone]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>User's timezone</p>\n"
},
{
"name": "locale",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: gl, it, ja, zh_TW, en, en_GB, ko, zh_CN, fr, es, sv_SE, pt_BR, ru, de.",
"full_name": "user[locale]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>User's preferred locale</p>\n"
}
],
"full_name": "user",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/users/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a user",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/users/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/users/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/users",
"name": "Users"
},
"template_kinds": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all template kinds",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/template_kinds"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/template_kinds/index",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/template_kinds",
"name": "Template kinds"
},
"interfaces": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all interfaces for host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/interfaces"
},
{
"short_description": "List all interfaces for domain",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/domains/:domain_id/interfaces"
},
{
"short_description": "List all interfaces for subnet",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/subnets/:subnet_id/interfaces"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of host</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "domain_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of domain</p>\n"
},
{
"name": "subnet_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "subnet_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of subnet</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/interfaces/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show an interface for host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/interfaces/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of host</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of interface</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/interfaces/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create an interface on a host",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/hosts/:host_id/interfaces"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of host</p>\n"
},
{
"name": "interface",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "mac",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[mac]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>MAC address of interface. Required for managed interfaces on bare metal.</p>\n"
},
{
"name": "ip",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[ip]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>IP address of interface</p>\n"
},
{
"name": "type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: interface, bmc, bond.",
"full_name": "interface[type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface type, e.g. bmc. Default is interface</p>\n"
},
{
"name": "name",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface's DNS name</p>\n"
},
{
"name": "subnet_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Fixnum",
"full_name": "interface[subnet_id]",
"expected_type": "numeric",
"metadata": null,
"description": "\n<p>Foreman subnet ID of interface</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Fixnum",
"full_name": "interface[domain_id]",
"expected_type": "numeric",
"metadata": null,
"description": "\n<p>Foreman domain ID of interface. Required for primary interfaces on managed\nhosts.</p>\n"
},
{
"name": "identifier",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[identifier]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Device identifier, e.g. eth0 or eth1.1</p>\n"
},
{
"name": "managed",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "interface[managed]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?</p>\n"
},
{
"name": "primary",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "interface[primary]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.</p>\n"
},
{
"name": "provision",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "interface[provision]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.</p>\n"
},
{
"name": "username",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[username]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Only for BMC interfaces.</p>\n"
},
{
"name": "password",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[password]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Only for BMC interfaces.</p>\n"
},
{
"name": "provider",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: IPMI.",
"full_name": "interface[provider]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface provider, e.g. IPMI. Only for BMC interfaces.</p>\n"
},
{
"name": "virtual",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "interface[virtual]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Alias or VLAN device</p>\n"
},
{
"name": "tag",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[tag]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.</p>\n"
},
{
"name": "attached_to",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[attached_to]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Identifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.</p>\n"
},
{
"name": "mode",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.",
"full_name": "interface[mode]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.</p>\n"
},
{
"name": "attached_devices",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "interface[attached_devices]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Identifiers of slave interfaces, e.g. `['eth1', 'eth2']`. Only for bond\ninterfaces.</p>\n"
},
{
"name": "bond_options",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[bond_options]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Space separated options, e.g. miimon=100. Only for bond interfaces.</p>\n"
},
{
"name": "compute_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Hash",
"full_name": "interface[compute_attributes]",
"expected_type": "hash",
"metadata": null,
"description": "\n<p>Additional compute resource specific attributes for the interface.</p>\n"
}
],
"full_name": "interface",
"expected_type": "hash",
"metadata": null,
"description": "\n<p>interface information</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/interfaces/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a host's interface",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/hosts/:host_id/interfaces/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of host</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of interface</p>\n"
},
{
"name": "interface",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "mac",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[mac]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>MAC address of interface. Required for managed interfaces on bare metal.</p>\n"
},
{
"name": "ip",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[ip]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>IP address of interface</p>\n"
},
{
"name": "type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: interface, bmc, bond.",
"full_name": "interface[type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface type, e.g. bmc. Default is interface</p>\n"
},
{
"name": "name",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface's DNS name</p>\n"
},
{
"name": "subnet_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Fixnum",
"full_name": "interface[subnet_id]",
"expected_type": "numeric",
"metadata": null,
"description": "\n<p>Foreman subnet ID of interface</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Fixnum",
"full_name": "interface[domain_id]",
"expected_type": "numeric",
"metadata": null,
"description": "\n<p>Foreman domain ID of interface. Required for primary interfaces on managed\nhosts.</p>\n"
},
{
"name": "identifier",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[identifier]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Device identifier, e.g. eth0 or eth1.1</p>\n"
},
{
"name": "managed",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "interface[managed]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?</p>\n"
},
{
"name": "primary",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "interface[primary]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.</p>\n"
},
{
"name": "provision",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "interface[provision]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.</p>\n"
},
{
"name": "username",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[username]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Only for BMC interfaces.</p>\n"
},
{
"name": "password",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[password]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Only for BMC interfaces.</p>\n"
},
{
"name": "provider",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: IPMI.",
"full_name": "interface[provider]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface provider, e.g. IPMI. Only for BMC interfaces.</p>\n"
},
{
"name": "virtual",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "interface[virtual]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Alias or VLAN device</p>\n"
},
{
"name": "tag",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[tag]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.</p>\n"
},
{
"name": "attached_to",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[attached_to]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Identifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.</p>\n"
},
{
"name": "mode",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.",
"full_name": "interface[mode]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.</p>\n"
},
{
"name": "attached_devices",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "interface[attached_devices]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Identifiers of slave interfaces, e.g. `['eth1', 'eth2']`. Only for bond\ninterfaces.</p>\n"
},
{
"name": "bond_options",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "interface[bond_options]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Space separated options, e.g. miimon=100. Only for bond interfaces.</p>\n"
},
{
"name": "compute_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Hash",
"full_name": "interface[compute_attributes]",
"expected_type": "hash",
"metadata": null,
"description": "\n<p>Additional compute resource specific attributes for the interface.</p>\n"
}
],
"full_name": "interface",
"expected_type": "hash",
"metadata": null,
"description": "\n<p>interface information</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/interfaces/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a host's interface",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/hosts/:host_id/interfaces/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of host</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of interface</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/interfaces/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/interfaces",
"name": "Interfaces"
},
"os_default_templates": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List default templates combinations for an operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems/:operatingsystem_id/os_default_templates"
},
{
"short_description": "List operating systems where this template is set as a default",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/config_templates/:config_template_id/os_default_templates"
},
{
"short_description": "List operating systems where this template is set as a default",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/provisioning_templates/:provisioning_template_id/os_default_templates"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "config_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of provisioning template</p>\n"
},
{
"name": "provisioning_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of provisioning template</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/os_default_templates/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a default template combination for an operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems/:operatingsystem_id/os_default_templates/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a number.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/os_default_templates/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a default template combination for an operating system",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/operatingsystems/:operatingsystem_id/os_default_templates"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "os_default_template",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "template_kind_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "os_default_template[template_kind_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "config_template_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "os_default_template[config_template_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of provisioning template</p>\n"
},
{
"name": "provisioning_template_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "os_default_template[provisioning_template_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of provisioning template</p>\n"
}
],
"full_name": "os_default_template",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/os_default_templates/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a default template combination for an operating system",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/operatingsystems/:operatingsystem_id/os_default_templates/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "os_default_template",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "template_kind_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "os_default_template[template_kind_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "config_template_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "os_default_template[config_template_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of provisioning template</p>\n"
},
{
"name": "provisioning_template_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "os_default_template[provisioning_template_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of provisioning template</p>\n"
}
],
"full_name": "os_default_template",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/os_default_templates/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a default template combination for an operating system",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/operatingsystems/:operatingsystem_id/os_default_templates/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/os_default_templates/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/os_default_templates",
"name": "Os default templates"
},
"template_combinations": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List template combination",
"deprecated": true,
"http_method": "GET",
"api_url": "/api/config_templates/:config_template_id/template_combinations"
},
{
"short_description": "List template combination",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/provisioning_templates/:provisioning_template_id/template_combinations"
},
{
"short_description": "List template combination",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:hostgroup_id/template_combinations"
},
{
"short_description": "List template combination",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/environments/:environment_id/template_combinations"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "config_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of config template</p>\n"
},
{
"name": "provisioning_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of config template</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of environment</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/template_combinations/index",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Add a template combination",
"deprecated": true,
"http_method": "POST",
"api_url": "/api/config_templates/:config_template_id/template_combinations"
},
{
"short_description": "Add a template combination",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/provisioning_templates/:provisioning_template_id/template_combinations"
},
{
"short_description": "Add a template combination",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/hostgroups/:hostgroup_id/template_combinations"
},
{
"short_description": "Add a template combination",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/environments/:environment_id/template_combinations"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "config_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of config template</p>\n"
},
{
"name": "provisioning_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of config template</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of environment</p>\n"
},
{
"name": "template_combination",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "template_combination[environment_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>environment id</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "template_combination[hostgroup_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>host group id</p>\n"
}
],
"full_name": "template_combination",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/template_combinations/create",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show template combination",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/template_combinations/:id"
},
{
"short_description": "Show template combination",
"deprecated": true,
"http_method": "GET",
"api_url": "/api/config_templates/:config_template_id/template_combinations/:id"
},
{
"short_description": "Show template combination",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/provisioning_templates/:provisioning_template_id/template_combinations/:id"
},
{
"short_description": "Show template combination",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:hostgroup_id/template_combinations/:id"
},
{
"short_description": "Show template combination",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/environments/:environment_id/template_combinations/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "config_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of config template</p>\n"
},
{
"name": "provisioning_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of config template</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of environment</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/template_combinations/show",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update template combination",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/provisioning_templates/:provisioning_template_id/template_combinations/:id"
},
{
"short_description": "Update template combination",
"deprecated": true,
"http_method": "PUT",
"api_url": "/api/config_templates/:config_template_id/template_combinations/:id"
},
{
"short_description": "Update template combination",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/hostgroups/:hostgroup_id/template_combinations/:id"
},
{
"short_description": "Update template combination",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/environments/:environment_id/template_combinations/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "config_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of config template</p>\n"
},
{
"name": "provisioning_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of config template</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of environment</p>\n"
},
{
"name": "template_combination",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "template_combination[environment_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>environment id</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "template_combination[hostgroup_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>host group id</p>\n"
}
],
"full_name": "template_combination",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/template_combinations/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a template combination",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/template_combinations/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/template_combinations/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/template_combinations",
"name": "Template combinations"
},
"config_templates": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List provisioning templates",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/config_templates"
},
{
"short_description": "List provisioning templates per operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystem/:operatingsystem_id/config_templates"
},
{
"short_description": "List provisioning templates per location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/config_templates"
},
{
"short_description": "List provisioning templates per organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/config_templates"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_templates/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show provisioning template details",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/config_templates/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_templates/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a provisioning template",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/config_templates"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "config_template",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>template name</p>\n"
},
{
"name": "template",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template[template]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "snippet",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "config_template[snippet]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "audit_comment",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "config_template[audit_comment]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "template_kind_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "config_template[template_kind_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>not relevant for snippet</p>\n"
},
{
"name": "template_combinations_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "config_template[template_combinations_attributes]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of template combinations (hostgroup_id, environment_id)</p>\n"
},
{
"name": "operatingsystem_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "config_template[operatingsystem_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of operating system IDs to associate with the template</p>\n"
},
{
"name": "locked",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "config_template[locked]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Whether or not the template is locked for editing</p>\n"
}
],
"full_name": "config_template",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_templates/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a provisioning template",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/config_templates/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "config_template",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>template name</p>\n"
},
{
"name": "template",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template[template]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "snippet",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "config_template[snippet]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "audit_comment",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "config_template[audit_comment]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "template_kind_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "config_template[template_kind_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>not relevant for snippet</p>\n"
},
{
"name": "template_combinations_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "config_template[template_combinations_attributes]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of template combinations (hostgroup_id, environment_id)</p>\n"
},
{
"name": "operatingsystem_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "config_template[operatingsystem_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of operating system IDs to associate with the template</p>\n"
},
{
"name": "locked",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "config_template[locked]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Whether or not the template is locked for editing</p>\n"
}
],
"full_name": "config_template",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_templates/update",
"metadata": null
},
{
"errors": [],
"name": "revision",
"apis": [
{
"short_description": null,
"deprecated": null,
"http_method": "GET",
"api_url": "/api/config_templates/revision"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "version",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "version",
"expected_type": "string",
"metadata": null,
"description": "\n<p>template version</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_templates/revision",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a provisioning template",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/config_templates/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_templates/destroy",
"metadata": null
},
{
"errors": [],
"name": "build_pxe_default",
"apis": [
{
"short_description": "Update the default PXE menu on all configured TFTP servers",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/config_templates/build_pxe_default"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_templates/build_pxe_default",
"metadata": null
},
{
"errors": [],
"name": "clone",
"apis": [
{
"short_description": "Clone a provision template",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/config_templates/:id/clone"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "config_template",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>template name</p>\n"
}
],
"full_name": "config_template",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/config_templates/clone",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/config_templates",
"name": "Config templates"
},
"usergroups": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all user groups",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/usergroups"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/usergroups/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a user group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/usergroups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/usergroups/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a user group",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/usergroups"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "usergroup",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "usergroup[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "user_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "usergroup[user_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "usergroup_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "usergroup[usergroup_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "role_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "usergroup[role_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
}
],
"full_name": "usergroup",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/usergroups/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a user group",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/usergroups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "usergroup",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "usergroup[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "user_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "usergroup[user_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "usergroup_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "usergroup[usergroup_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "role_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "usergroup[role_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
}
],
"full_name": "usergroup",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/usergroups/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a user group",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/usergroups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/usergroups/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/usergroups",
"name": "Usergroups"
},
"operatingsystems": {
"api_url": "/api",
"metadata": null,
"full_description": "",
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all operating systems",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems"
},
{
"short_description": "List all operating systems for nested architecture",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/architectures/:architecture_id/operatingsystems"
},
{
"short_description": "List all operating systems for nested medium",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/media/:medium_id/operatingsystems"
},
{
"short_description": "List all operating systems for nested partition table",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/ptables/:ptable_id/operatingsystems"
},
{
"short_description": "List all operating systems for nested provisioning template",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/config_templates/:config_template_id/operatingsystems"
},
{
"short_description": "List all operating systems for nested provisioning template",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/provisioning_templates/:provisioning_template_id/operatingsystems"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "architecture_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "architecture_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of architecture</p>\n"
},
{
"name": "medium_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "medium_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of medium</p>\n"
},
{
"name": "ptable_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "ptable_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of partition table</p>\n"
},
{
"name": "config_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "config_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of template</p>\n"
},
{
"name": "provisioning_template_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of template</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/operatingsystems/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show an operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/operatingsystems/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create an operating system",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/operatingsystems"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "operatingsystem",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must match regular expression /\\A(\\S+)\\Z/.",
"full_name": "operatingsystem[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "major",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem[major]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "minor",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "operatingsystem[minor]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "operatingsystem[description]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "family",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "operatingsystem[family]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "release_name",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "operatingsystem[release_name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "password_hash",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "operatingsystem[password_hash]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Root password hash function to use, one of MD5, SHA256, SHA512, Base64</p>\n"
},
{
"name": "architecture_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "operatingsystem[architecture_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>IDs of associated architectures</p>\n"
},
{
"name": "config_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "operatingsystem[config_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>IDs of associated provisioning templates</p>\n"
},
{
"name": "provisioning_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "operatingsystem[provisioning_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>IDs of associated provisioning templates</p>\n"
},
{
"name": "medium_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "operatingsystem[medium_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>IDs of associated media</p>\n"
},
{
"name": "ptable_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "operatingsystem[ptable_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>IDs of associated partition tables</p>\n"
}
],
"full_name": "operatingsystem",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/operatingsystems/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update an operating system",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/operatingsystems/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "operatingsystem",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must match regular expression /\\A(\\S+)\\Z/.",
"full_name": "operatingsystem[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "major",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem[major]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "minor",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "operatingsystem[minor]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "operatingsystem[description]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "family",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "operatingsystem[family]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "release_name",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "operatingsystem[release_name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "password_hash",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "operatingsystem[password_hash]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Root password hash function to use, one of MD5, SHA256, SHA512, Base64</p>\n"
},
{
"name": "architecture_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "operatingsystem[architecture_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>IDs of associated architectures</p>\n"
},
{
"name": "config_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "operatingsystem[config_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>IDs of associated provisioning templates</p>\n"
},
{
"name": "provisioning_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "operatingsystem[provisioning_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>IDs of associated provisioning templates</p>\n"
},
{
"name": "medium_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "operatingsystem[medium_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>IDs of associated media</p>\n"
},
{
"name": "ptable_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "operatingsystem[ptable_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>IDs of associated partition tables</p>\n"
}
],
"full_name": "operatingsystem",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/operatingsystems/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete an operating system",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/operatingsystems/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/operatingsystems/destroy",
"metadata": null
},
{
"errors": [],
"name": "bootfiles",
"apis": [
{
"short_description": "List boot files for an operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystems/:id/bootfiles"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "medium",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "medium",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "architecture",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "architecture",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/operatingsystems/bootfiles",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/operatingsystems",
"name": "Operating systems"
},
"realms": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List of realms",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/realms"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/realms/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a realm",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/realms/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Numerical ID or realm name</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/realms/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a realm",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/realms"
}
],
"full_description": "\n<p>The <b>name</b> field is used for the name of the realm.</p>\n",
"see": [],
"params": [
{
"name": "realm",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "realm[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>The realm name, e.g. EXAMPLE.COM</p>\n"
},
{
"name": "realm_proxy_id",
"show": true,
"required": true,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "realm[realm_proxy_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Proxy to use for this realm</p>\n"
},
{
"name": "realm_type",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "realm[realm_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Realm type, e.g. FreeIPA or Active Directory</p>\n"
}
],
"full_name": "realm",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/realms/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a realm",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/realms/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "realm",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "realm[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>The realm name, e.g. EXAMPLE.COM</p>\n"
},
{
"name": "realm_proxy_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "realm[realm_proxy_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Proxy to use for this realm</p>\n"
},
{
"name": "realm_type",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "realm[realm_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Realm type, e.g. FreeIPA or Active Directory</p>\n"
}
],
"full_name": "realm",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/realms/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a realm",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/realms/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/realms/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/realms",
"name": "Realms"
},
"puppetclasses": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all Puppet classes",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/puppetclasses"
},
{
"short_description": "List all Puppet classes for a host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/puppetclasses"
},
{
"short_description": "List all Puppet classes for a host group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:hostgroup_id/puppetclasses"
},
{
"short_description": "List all Puppet classes for an environment",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/environments/:environment_id/puppetclasses"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of environment</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/puppetclasses/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a Puppet class",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/puppetclasses/:id"
},
{
"short_description": "Show a Puppet class for host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/puppetclasses/:id"
},
{
"short_description": "Show a Puppet class for a host group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:hostgroup_id/puppetclasses/:id"
},
{
"short_description": "Show a Puppet class for an environment",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/environments/:environment_id/puppetclasses/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host</p>\n"
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of environment</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of Puppet class</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/puppetclasses/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a Puppet class",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/puppetclasses"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "puppetclass",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "puppetclass[name]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "puppetclass",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/puppetclasses/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a Puppet class",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/puppetclasses/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppetclass",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "puppetclass[name]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "puppetclass",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/puppetclasses/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a Puppet class",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/puppetclasses/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/puppetclasses/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/puppetclasses",
"name": "Puppetclasses"
},
"provisioning_templates": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List provisioning templates",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/provisioning_templates"
},
{
"short_description": "List provisioning templates per operating system",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/operatingsystem/:operatingsystem_id/provisioning_templates"
},
{
"short_description": "List provisioning templates per location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/provisioning_templates"
},
{
"short_description": "List provisioning templates per organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/provisioning_templates"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "operatingsystem_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of operating system</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/provisioning_templates/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show provisioning template details",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/provisioning_templates/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/provisioning_templates/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a provisioning template",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/provisioning_templates"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "provisioning_template",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>template name</p>\n"
},
{
"name": "template",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template[template]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "snippet",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "provisioning_template[snippet]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "audit_comment",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "provisioning_template[audit_comment]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "template_kind_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "provisioning_template[template_kind_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>not relevant for snippet</p>\n"
},
{
"name": "template_combinations_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "provisioning_template[template_combinations_attributes]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of template combinations (hostgroup_id, environment_id)</p>\n"
},
{
"name": "operatingsystem_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "provisioning_template[operatingsystem_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of operating system IDs to associate with the template</p>\n"
},
{
"name": "locked",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "provisioning_template[locked]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Whether or not the template is locked for editing</p>\n"
}
],
"full_name": "provisioning_template",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/provisioning_templates/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a provisioning template",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/provisioning_templates/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "provisioning_template",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>template name</p>\n"
},
{
"name": "template",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template[template]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "snippet",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "provisioning_template[snippet]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "audit_comment",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "provisioning_template[audit_comment]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "template_kind_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "provisioning_template[template_kind_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>not relevant for snippet</p>\n"
},
{
"name": "template_combinations_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "provisioning_template[template_combinations_attributes]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of template combinations (hostgroup_id, environment_id)</p>\n"
},
{
"name": "operatingsystem_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "provisioning_template[operatingsystem_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Array of operating system IDs to associate with the template</p>\n"
},
{
"name": "locked",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "provisioning_template[locked]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Whether or not the template is locked for editing</p>\n"
}
],
"full_name": "provisioning_template",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/provisioning_templates/update",
"metadata": null
},
{
"errors": [],
"name": "revision",
"apis": [
{
"short_description": null,
"deprecated": null,
"http_method": "GET",
"api_url": "/api/provisioning_templates/revision"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "version",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "version",
"expected_type": "string",
"metadata": null,
"description": "\n<p>template version</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/provisioning_templates/revision",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a provisioning template",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/provisioning_templates/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/provisioning_templates/destroy",
"metadata": null
},
{
"errors": [],
"name": "build_pxe_default",
"apis": [
{
"short_description": "Update the default PXE menu on all configured TFTP servers",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/provisioning_templates/build_pxe_default"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/provisioning_templates/build_pxe_default",
"metadata": null
},
{
"errors": [],
"name": "clone",
"apis": [
{
"short_description": "Clone a provision template",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/provisioning_templates/:id/clone"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "provisioning_template",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "provisioning_template[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>template name</p>\n"
}
],
"full_name": "provisioning_template",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/provisioning_templates/clone",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/provisioning_templates",
"name": "Provisioning templates"
},
"permissions": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all permissions",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/permissions"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
},
{
"name": "resource_type",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "resource_type",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "name",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/permissions/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a permission",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/permissions/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/permissions/show",
"metadata": null
},
{
"errors": [],
"name": "resource_types",
"apis": [
{
"short_description": "List available resource types.",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/permissions/resource_types"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/permissions/resource_types",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/permissions",
"name": "Permissions"
},
"organizations": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all organizations",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/organizations/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show an organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:id"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/organizations/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create an organization",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/organizations"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "organization",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "organization[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "organization[description]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "user_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[user_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>User IDs</p>\n"
},
{
"name": "smart_proxy_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[smart_proxy_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Smart proxy IDs</p>\n"
},
{
"name": "compute_resource_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[compute_resource_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Compute resource IDs</p>\n"
},
{
"name": "media_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[media_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Media IDs</p>\n"
},
{
"name": "config_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[config_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Provisioning template IDs</p>\n"
},
{
"name": "ptable_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[ptable_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Partition template IDs</p>\n"
},
{
"name": "provisioning_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[provisioning_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Provisioning template IDs</p>\n"
},
{
"name": "domain_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[domain_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Domain IDs</p>\n"
},
{
"name": "realm_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[realm_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Realm IDs</p>\n"
},
{
"name": "hostgroup_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[hostgroup_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Host group IDs</p>\n"
},
{
"name": "environment_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[environment_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Environment IDs</p>\n"
},
{
"name": "subnet_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[subnet_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Subnet IDs</p>\n"
}
],
"full_name": "organization",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/organizations/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update an organization",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/organizations/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "organization",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "organization[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "organization[description]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "user_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[user_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>User IDs</p>\n"
},
{
"name": "smart_proxy_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[smart_proxy_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Smart proxy IDs</p>\n"
},
{
"name": "compute_resource_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[compute_resource_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Compute resource IDs</p>\n"
},
{
"name": "media_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[media_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Media IDs</p>\n"
},
{
"name": "config_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[config_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Provisioning template IDs</p>\n"
},
{
"name": "ptable_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[ptable_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Partition template IDs</p>\n"
},
{
"name": "provisioning_template_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[provisioning_template_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Provisioning template IDs</p>\n"
},
{
"name": "domain_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[domain_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Domain IDs</p>\n"
},
{
"name": "realm_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[realm_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Realm IDs</p>\n"
},
{
"name": "hostgroup_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[hostgroup_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Host group IDs</p>\n"
},
{
"name": "environment_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[environment_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Environment IDs</p>\n"
},
{
"name": "subnet_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "organization[subnet_ids]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Subnet IDs</p>\n"
}
],
"full_name": "organization",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/organizations/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete an organization",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/organizations/:id"
}
],
"full_description": "",
"see": [],
"params": [],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/organizations/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/organizations",
"name": "Organizations"
},
"smart_variables": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all smart variables",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_variables"
},
{
"short_description": "List of smart variables for a specific host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/smart_variables"
},
{
"short_description": "List of smart variables for a specific host group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:hostgroup_id/smart_variables"
},
{
"short_description": "List of smart variables for a specific Puppet class",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/puppetclasses/:puppetclass_id/smart_variables"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "host_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppetclass_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "puppetclass_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_variables/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a smart variable",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_variables/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_variables/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a smart variable",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/smart_variables"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "smart_variable",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "variable",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_variable[variable]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Name of variable</p>\n"
},
{
"name": "puppetclass_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "smart_variable[puppetclass_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Puppet class ID</p>\n"
},
{
"name": "default_value",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "smart_variable[default_value]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Default value of variable</p>\n"
},
{
"name": "override_value_order",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "smart_variable[override_value_order]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>A orde na cual se resolven os valores</p>\n"
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "smart_variable[description]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Description of variable</p>\n"
},
{
"name": "validator_type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: regexp, list.",
"full_name": "smart_variable[validator_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Types of validation values</p>\n"
},
{
"name": "validator_rule",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "smart_variable[validator_rule]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Used to enforce certain values for the parameter values</p>\n"
},
{
"name": "variable_type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.",
"full_name": "smart_variable[variable_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Types of variable values</p>\n"
},
{
"name": "merge_overrides",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "smart_variable[merge_overrides]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Merge all matching values (only array/hash type)</p>\n"
},
{
"name": "avoid_duplicates",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "smart_variable[avoid_duplicates]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Remove duplicate values (only array type)</p>\n"
}
],
"full_name": "smart_variable",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_variables/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a smart variable",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/smart_variables/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "smart_variable",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "variable",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_variable[variable]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Name of variable</p>\n"
},
{
"name": "puppetclass_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "smart_variable[puppetclass_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Puppet class ID</p>\n"
},
{
"name": "default_value",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "smart_variable[default_value]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Default value of variable</p>\n"
},
{
"name": "override_value_order",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "smart_variable[override_value_order]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>A orde na cual se resolven os valores</p>\n"
},
{
"name": "description",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "smart_variable[description]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Description of variable</p>\n"
},
{
"name": "validator_type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: regexp, list.",
"full_name": "smart_variable[validator_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Types of validation values</p>\n"
},
{
"name": "validator_rule",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "smart_variable[validator_rule]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Used to enforce certain values for the parameter values</p>\n"
},
{
"name": "variable_type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: string, boolean, integer, real, array, hash, yaml, json.",
"full_name": "smart_variable[variable_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Types of variable values</p>\n"
},
{
"name": "merge_overrides",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "smart_variable[merge_overrides]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Merge all matching values (only array/hash type)</p>\n"
},
{
"name": "avoid_duplicates",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "smart_variable[avoid_duplicates]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Remove duplicate values (only array type)</p>\n"
}
],
"full_name": "smart_variable",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_variables/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a smart variable",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/smart_variables/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_variables/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/smart_variables",
"name": "Smart variables"
},
"roles": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all roles",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/roles"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/roles/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a role",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/roles/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/roles/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a role",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/roles"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "role",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "role[name]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "role",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/roles/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a role",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/roles/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "role",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "role[name]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "role",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/roles/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a role",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/roles/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/roles/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/roles",
"name": "Roles"
},
"smart_proxies": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "import_puppetclasses",
"apis": [
{
"short_description": "Import puppet classes from puppet proxy.",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/smart_proxies/:id/import_puppetclasses"
},
{
"short_description": "Import puppet classes from puppet proxy for an environment",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses"
},
{
"short_description": "Import puppet classes from puppet proxy for an environment",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "smart_proxy_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_proxy_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "dryrun",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be 'true' or 'false'",
"full_name": "dryrun",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "except",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "except",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Optional comma-delimited string containing either 'new', 'updated', or\n'obsolete' that is used to limit the imported Puppet classes</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_proxies/import_puppetclasses",
"metadata": null
},
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all smart proxies",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_proxies"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_proxies/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a smart proxy",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/smart_proxies/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_proxies/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a smart proxy",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/smart_proxies"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "smart_proxy",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_proxy[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "url",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_proxy[url]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "smart_proxy",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_proxies/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a smart proxy",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/smart_proxies/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "smart_proxy",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_proxy[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "url",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "smart_proxy[url]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "smart_proxy",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_proxies/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a smart proxy",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/smart_proxies/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_proxies/destroy",
"metadata": null
},
{
"errors": [],
"name": "refresh",
"apis": [
{
"short_description": "Refresh smart proxy features",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/smart_proxies/:id/refresh"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/smart_proxies/refresh",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/smart_proxies",
"name": "Smart proxies"
},
"settings": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all settings",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/settings"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/settings/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a setting",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/settings/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/settings/show",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a setting",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/settings/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "setting",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "value",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "setting[value]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "setting",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/settings/update",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/settings",
"name": "Settings"
},
"compute_profiles": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List of compute profiles",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_profiles"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_profiles/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a compute profile",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/compute_profiles/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_profiles/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a compute profile",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/compute_profiles"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "compute_profile",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "compute_profile[name]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "compute_profile",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_profiles/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a compute profile",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/compute_profiles/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_profile",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "compute_profile[name]",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"full_name": "compute_profile",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_profiles/update",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a compute profile",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/compute_profiles/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_profiles/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/compute_profiles",
"name": "Compute profiles"
},
"reports": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all reports",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/reports"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/reports/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a report",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/reports/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/reports/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a report",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/reports"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "report",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "host",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "report[host]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Hostname or certname</p>\n"
},
{
"name": "reported_at",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "report[reported_at]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>UTC time of report</p>\n"
},
{
"name": "status",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be Hash",
"full_name": "report[status]",
"expected_type": "hash",
"metadata": null,
"description": "\n<p>Hash of status type totals</p>\n"
},
{
"name": "metrics",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be Hash",
"full_name": "report[metrics]",
"expected_type": "hash",
"metadata": null,
"description": "\n<p>Hash of report metrics, can be just {}</p>\n"
},
{
"name": "logs",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "report[logs]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Optional array of log hashes</p>\n"
}
],
"full_name": "report",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/reports/create",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete a report",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/reports/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/reports/destroy",
"metadata": null
},
{
"errors": [],
"name": "last",
"apis": [
{
"short_description": "Show the last report for a host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:host_id/reports/last"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/reports/last",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/reports",
"name": "Reports"
},
"compute_attributes": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a compute attributes set",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes"
},
{
"short_description": "Create a compute attributes set",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes"
},
{
"short_description": "Create a compute attributes set",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/compute_resources/:compute_resource_id/compute_attributes"
},
{
"short_description": "Create a compute attributes set",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/compute_profiles/:compute_profile_id/compute_attributes"
},
{
"short_description": "Create a compute attributes set",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/compute_attributes"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "compute_profile_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "compute_profile_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_resource_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "compute_resource_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_attribute",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "vm_attrs",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be Hash",
"full_name": "compute_attribute[vm_attrs]",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"full_name": "compute_attribute",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_attributes/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a compute attributes set",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id"
},
{
"short_description": "Update a compute attributes set",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id"
},
{
"short_description": "Update a compute attributes set",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/compute_resources/:compute_resource_id/compute_attributes/:id"
},
{
"short_description": "Update a compute attributes set",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/compute_profiles/:compute_profile_id/compute_attributes/:id"
},
{
"short_description": "Update a compute attributes set",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/compute_attributes/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "compute_profile_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "compute_profile_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_resource_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "compute_resource_id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_attribute",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "vm_attrs",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be Hash",
"full_name": "compute_attribute[vm_attrs]",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"full_name": "compute_attribute",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/compute_attributes/update",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/compute_attributes",
"name": "Compute attributes"
},
"external_usergroups": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all external user groups for user group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/usergroups/:usergroup_id/external_usergroups"
},
{
"short_description": "List all external user groups for LDAP authentication source",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "usergroup_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "usergroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of user group</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/external_usergroups/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show an external user group for user group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/usergroups/:usergroup_id/external_usergroups/:id"
},
{
"short_description": "Show an external user group for LDAP authentication source",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "usergroup_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "usergroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of user group</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of external user group</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/external_usergroups/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create an external user group linked to a user group",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/usergroups/:usergroup_id/external_usergroups"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "usergroup_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "usergroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of user group</p>\n"
},
{
"name": "external_usergroup",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "external_usergroup[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>External user group name</p>\n"
},
{
"name": "auth_source_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be Fixnum",
"full_name": "external_usergroup[auth_source_id]",
"expected_type": "numeric",
"metadata": null,
"description": "\n<p>ID of linked authentication source</p>\n"
}
],
"full_name": "external_usergroup",
"expected_type": "hash",
"metadata": null,
"description": "\n<p>External user group information</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/external_usergroups/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update external user group",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/usergroups/:usergroup_id/external_usergroups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "usergroup_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "usergroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of user group</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of external user group</p>\n"
},
{
"name": "external_usergroup",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "external_usergroup[name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>External user group name</p>\n"
},
{
"name": "auth_source_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be Fixnum",
"full_name": "external_usergroup[auth_source_id]",
"expected_type": "numeric",
"metadata": null,
"description": "\n<p>ID of linked authentication source</p>\n"
}
],
"full_name": "external_usergroup",
"expected_type": "hash",
"metadata": null,
"description": "\n<p>External user group information</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/external_usergroups/update",
"metadata": null
},
{
"errors": [],
"name": "refresh",
"apis": [
{
"short_description": "Refresh external user group",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/usergroups/:usergroup_id/external_usergroups/:id/refresh"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "usergroup_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "usergroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of user group</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of external user group</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/external_usergroups/refresh",
"metadata": null
},
{
"errors": [],
"name": "destroy",
"apis": [
{
"short_description": "Delete an external user group",
"deprecated": null,
"http_method": "DELETE",
"api_url": "/api/usergroups/:usergroup_id/external_usergroups/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "usergroup_id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "usergroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name of user group</p>\n"
},
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID or name external user group</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/external_usergroups/destroy",
"metadata": null
}
],
"formats": null,
"short_description": null,
"doc_url": "../apidoc/v2/external_usergroups",
"name": "External usergroups"
},
"hosts": {
"api_url": "/api",
"metadata": null,
"full_description": null,
"version": "v2",
"methods": [
{
"errors": [],
"name": "index",
"apis": [
{
"short_description": "List all hosts",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts"
},
{
"short_description": "List all hosts for a host group",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hostgroups/:hostgroup_id/hosts"
},
{
"short_description": "List hosts per location",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/locations/:location_id/hosts"
},
{
"short_description": "List hosts per organization",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/organizations/:organization_id/hosts"
},
{
"short_description": "List hosts per environment",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/environments/:environment_id/hosts"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "hostgroup_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of host group</p>\n"
},
{
"name": "location_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "location_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of location</p>\n"
},
{
"name": "organization_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "organization_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of organization</p>\n"
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "environment_id",
"expected_type": "string",
"metadata": null,
"description": "\n<p>ID of environment</p>\n"
},
{
"name": "search",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "search",
"expected_type": "string",
"metadata": null,
"description": "\n<p>filter results</p>\n"
},
{
"name": "order",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "order",
"expected_type": "string",
"metadata": null,
"description": "\n<p>sort results</p>\n"
},
{
"name": "page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>paginate results</p>\n"
},
{
"name": "per_page",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "per_page",
"expected_type": "string",
"metadata": null,
"description": "\n<p>number of entries per request</p>\n"
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hosts/index",
"metadata": null
},
{
"errors": [],
"name": "show",
"apis": [
{
"short_description": "Show a host",
"deprecated": null,
"http_method": "GET",
"api_url": "/api/hosts/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hosts/show",
"metadata": null
},
{
"errors": [],
"name": "create",
"apis": [
{
"short_description": "Create a host",
"deprecated": null,
"http_method": "POST",
"api_url": "/api/hosts"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "host",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[environment_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group</p>\n"
},
{
"name": "ip",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[ip]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>not required if using a subnet with DHCP proxy</p>\n"
},
{
"name": "mac",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[mac]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required for managed host that is bare metal, not required if it's a\nvirtual machine</p>\n"
},
{
"name": "architecture_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[architecture_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[domain_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group</p>\n"
},
{
"name": "realm_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[realm_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppet_proxy_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[puppet_proxy_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppet_class_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "host[puppet_class_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[operatingsystem_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group</p>\n"
},
{
"name": "medium_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[medium_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if not imaged based provisioning and host is managed and value is\nnot inherited from host group</p>\n"
},
{
"name": "ptable_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[ptable_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and custom partition has not been defined</p>\n"
},
{
"name": "subnet_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[subnet_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group</p>\n"
},
{
"name": "compute_resource_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[compute_resource_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>nil means host is bare metal</p>\n"
},
{
"name": "root_pass",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[root_pass]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group or\ndefault password in settings</p>\n"
},
{
"name": "model_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[model_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[hostgroup_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "owner_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[owner_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "owner_type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: User, Usergroup.",
"full_name": "host[owner_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Host's owner type</p>\n"
},
{
"name": "puppet_ca_proxy_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[puppet_ca_proxy_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "image_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[image_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "host_parameters_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "host[host_parameters_attributes]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "build",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[build]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "enabled",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[enabled]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "provision_method",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[provision_method]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "managed",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[managed]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>True/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not</p>\n"
},
{
"name": "progress_report_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[progress_report_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>UUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks</p>\n"
},
{
"name": "comment",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[comment]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Informaci\u00f3n adicional deste equipo</p>\n"
},
{
"name": "capabilities",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[capabilities]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_profile_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[compute_profile_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "interfaces_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an Array of nested elements",
"params": [
{
"name": "mac",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][mac]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>MAC address of interface. Required for managed interfaces on bare metal.</p>\n"
},
{
"name": "ip",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][ip]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>IP address of interface</p>\n"
},
{
"name": "type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: interface, bmc, bond.",
"full_name": "host[interfaces_attributes][type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface type, e.g. bmc. Default is interface</p>\n"
},
{
"name": "name",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface's DNS name</p>\n"
},
{
"name": "subnet_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Fixnum",
"full_name": "host[interfaces_attributes][subnet_id]",
"expected_type": "numeric",
"metadata": null,
"description": "\n<p>Foreman subnet ID of interface</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Fixnum",
"full_name": "host[interfaces_attributes][domain_id]",
"expected_type": "numeric",
"metadata": null,
"description": "\n<p>Foreman domain ID of interface. Required for primary interfaces on managed\nhosts.</p>\n"
},
{
"name": "identifier",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][identifier]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Device identifier, e.g. eth0 or eth1.1</p>\n"
},
{
"name": "managed",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[interfaces_attributes][managed]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?</p>\n"
},
{
"name": "primary",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[interfaces_attributes][primary]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.</p>\n"
},
{
"name": "provision",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[interfaces_attributes][provision]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.</p>\n"
},
{
"name": "username",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][username]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Only for BMC interfaces.</p>\n"
},
{
"name": "password",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][password]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Only for BMC interfaces.</p>\n"
},
{
"name": "provider",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: IPMI.",
"full_name": "host[interfaces_attributes][provider]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface provider, e.g. IPMI. Only for BMC interfaces.</p>\n"
},
{
"name": "virtual",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[interfaces_attributes][virtual]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Alias or VLAN device</p>\n"
},
{
"name": "tag",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][tag]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.</p>\n"
},
{
"name": "attached_to",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][attached_to]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Identifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.</p>\n"
},
{
"name": "mode",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.",
"full_name": "host[interfaces_attributes][mode]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.</p>\n"
},
{
"name": "attached_devices",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "host[interfaces_attributes][attached_devices]",
"expected_type": "array",
"metadata": null,
"description": "\n<p>Identifiers of slave interfaces, e.g. `['eth1', 'eth2']`. Only for bond\ninterfaces.</p>\n"
},
{
"name": "bond_options",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][bond_options]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Space separated options, e.g. miimon=100. Only for bond interfaces.</p>\n"
},
{
"name": "compute_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Hash",
"full_name": "host[interfaces_attributes][compute_attributes]",
"expected_type": "hash",
"metadata": null,
"description": "\n<p>Additional compute resource specific attributes for the interface.</p>\n"
}
],
"full_name": "host[interfaces_attributes]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Host's network interfaces.</p>\n"
},
{
"name": "compute_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Hash",
"full_name": "host[compute_attributes]",
"expected_type": "hash",
"metadata": null,
"description": "\n<p>Additional compute resource specific attributes.</p>\n"
}
],
"full_name": "host",
"expected_type": "hash",
"metadata": null,
"description": ""
}
],
"examples": [],
"formats": null,
"doc_url": "../apidoc/v2/hosts/create",
"metadata": null
},
{
"errors": [],
"name": "update",
"apis": [
{
"short_description": "Update a host",
"deprecated": null,
"http_method": "PUT",
"api_url": "/api/hosts/:id"
}
],
"full_description": "",
"see": [],
"params": [
{
"name": "id",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.",
"full_name": "id",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "host",
"show": true,
"required": true,
"allow_nil": false,
"validator": "Must be a Hash",
"params": [
{
"name": "name",
"show": true,
"required": false,
"allow_nil": false,
"validator": "Must be String",
"full_name": "host[name]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "environment_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[environment_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group</p>\n"
},
{
"name": "ip",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[ip]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>not required if using a subnet with DHCP proxy</p>\n"
},
{
"name": "mac",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[mac]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required for managed host that is bare metal, not required if it's a\nvirtual machine</p>\n"
},
{
"name": "architecture_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[architecture_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[domain_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group</p>\n"
},
{
"name": "realm_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[realm_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppet_proxy_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[puppet_proxy_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "puppet_class_ids",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "host[puppet_class_ids]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "operatingsystem_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[operatingsystem_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group</p>\n"
},
{
"name": "medium_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[medium_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if not imaged based provisioning and host is managed and value is\nnot inherited from host group</p>\n"
},
{
"name": "ptable_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[ptable_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and custom partition has not been defined</p>\n"
},
{
"name": "subnet_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[subnet_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group</p>\n"
},
{
"name": "compute_resource_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[compute_resource_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>nil means host is bare metal</p>\n"
},
{
"name": "root_pass",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[root_pass]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>required if host is managed and value is not inherited from host group or\ndefault password in settings</p>\n"
},
{
"name": "model_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[model_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "hostgroup_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[hostgroup_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "owner_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[owner_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "owner_type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: User, Usergroup.",
"full_name": "host[owner_type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Host's owner type</p>\n"
},
{
"name": "puppet_ca_proxy_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[puppet_ca_proxy_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "image_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[image_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "host_parameters_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an array of any type",
"full_name": "host[host_parameters_attributes]",
"expected_type": "array",
"metadata": null,
"description": ""
},
{
"name": "build",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[build]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "enabled",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[enabled]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "provision_method",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[provision_method]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "managed",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[managed]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>True/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not</p>\n"
},
{
"name": "progress_report_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[progress_report_id]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>UUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks</p>\n"
},
{
"name": "comment",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[comment]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Informaci\u00f3n adicional deste equipo</p>\n"
},
{
"name": "capabilities",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[capabilities]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "compute_profile_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be a number.",
"full_name": "host[compute_profile_id]",
"expected_type": "string",
"metadata": null,
"description": ""
},
{
"name": "interfaces_attributes",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be an Array of nested elements",
"params": [
{
"name": "mac",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][mac]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>MAC address of interface. Required for managed interfaces on bare metal.</p>\n"
},
{
"name": "ip",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][ip]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>IP address of interface</p>\n"
},
{
"name": "type",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: interface, bmc, bond.",
"full_name": "host[interfaces_attributes][type]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface type, e.g. bmc. Default is interface</p>\n"
},
{
"name": "name",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][name]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface's DNS name</p>\n"
},
{
"name": "subnet_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Fixnum",
"full_name": "host[interfaces_attributes][subnet_id]",
"expected_type": "numeric",
"metadata": null,
"description": "\n<p>Foreman subnet ID of interface</p>\n"
},
{
"name": "domain_id",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be Fixnum",
"full_name": "host[interfaces_attributes][domain_id]",
"expected_type": "numeric",
"metadata": null,
"description": "\n<p>Foreman domain ID of interface. Required for primary interfaces on managed\nhosts.</p>\n"
},
{
"name": "identifier",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][identifier]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Device identifier, e.g. eth0 or eth1.1</p>\n"
},
{
"name": "managed",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[interfaces_attributes][managed]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?</p>\n"
},
{
"name": "primary",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[interfaces_attributes][primary]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.</p>\n"
},
{
"name": "provision",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[interfaces_attributes][provision]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Should this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.</p>\n"
},
{
"name": "username",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][username]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Only for BMC interfaces.</p>\n"
},
{
"name": "password",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][password]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Only for BMC interfaces.</p>\n"
},
{
"name": "provider",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: IPMI.",
"full_name": "host[interfaces_attributes][provider]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Interface provider, e.g. IPMI. Only for BMC interfaces.</p>\n"
},
{
"name": "virtual",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be 'true' or 'false'",
"full_name": "host[interfaces_attributes][virtual]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Alias or VLAN device</p>\n"
},
{
"name": "tag",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][tag]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.</p>\n"
},
{
"name": "attached_to",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be String",
"full_name": "host[interfaces_attributes][attached_to]",
"expected_type": "string",
"metadata": null,
"description": "\n<p>Identifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.</p>\n"
},
{
"name": "mode",
"show": true,
"required": false,
"allow_nil": true,
"validator": "Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.",
"full_name": "host[interfaces_attributes][mode]",
Raw
foreman-production.log
View raw

(Sorry about that, but we can’t show files that are this big right now.)

Raw
script-output.log
View raw

(Sorry about that, but we can’t show files that are this big right now.)

Raw
test-script.py
View raw

(Sorry about that, but we can’t show files that are this big right now.)

@david-caro
Copy link

Yep, there's a duplication there, I'll try opening a foreman bug:

                            {
                                "short_description": "List storage_domains for a compute resource",
                                "deprecated": null,
                                "http_method": "GET",
                                "api_url": "/api/compute_resources/:id/available_storage_domains"
                            },
                            {
                                "short_description": "List storage domains for a compute resource",
                                "deprecated": null,
                                "http_method": "GET",
                                "api_url": "/api/compute_resources/:id/available_storage_domains"
                            },

But I see that the code worked anyhow, it called the get hosts in foreman:

 | Started GET "/api/hosts" for 10.106.81.15 at 2016-01-15 15:27:46 +0000
2016-01-15 15:27:46 [app] [I] Processing by Api::V2::HostsController#index as JSON
2016-01-15 15:27:46 [app] [I]   Parameters: {"apiv"=>"v2", :host=>{}}
2016-01-15 15:27:46 [app] [I] Authorized user provisioner(Provisioning Account)
2016-01-15 15:27:46 [app] [I]   Rendered api/v2/hosts/index.json.rabl within api/v2/layouts/index_layout (327.2ms)
2016-01-15 15:27:46 [app] [I] Completed 200 OK in 353ms (Views: 310.9ms | ActiveRecord: 23.9ms)

And it did show the log message at the end:

Got a list of hosts

To turn off the warnings, you can add this to the top of your script:

import logging

logging.basicConfig(level=logging.ERROR)

@david-caro
Copy link

Opened this, let's see http://projects.theforeman.org/issues/13245

I'll create the pull request adding the json to the code and then will do a release :) thanks a lot!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment