Skip to content

Instantly share code, notes, and snippets.

@lhw

lhw/schema_swagger.json

Last active November 21, 2019 15:39
Show Gist options
  • Save lhw/5d000428a314f300c78445fcc4e4ec61 to your computer and use it in GitHub Desktop.
Save lhw/5d000428a314f300c78445fcc4e4ec61 to your computer and use it in GitHub Desktop.
Download ZIP
Foreman 1.20 swagger api export
Raw
schema_swagger.json
{
"swagger": "2.0",
"info": {
"title": "Foreman (params in:body)",
"description": "\n<p>Foreman API v2 is currently the default API version.</p>\n",
"version": "v2",
"x-copyright": ""
},
"basePath": "/api",
"consumes": [
"application/json"
],
"paths": {
"/hosts": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts",
"summary": "List all hosts",
"parameters": [
{
"name": "thin",
"type": "boolean",
"in": "query",
"description": "Only list ID and name of hosts"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
},
{
"name": "include",
"type": "string",
"enum": [
"parameters",
"all_parameters"
],
"in": "query",
"description": "Array of extra information types to include"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "post_hosts",
"summary": "Create a host",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"environment_id": {
"type": "string",
"description": "required if host is managed and value is not inherited from host group"
},
"ip": {
"type": "string",
"description": "not required if using a subnet with DHCP proxy"
},
"mac": {
"type": "string",
"description": "required for managed host that is bare metal, not required if it's a virtual machine"
},
"architecture_id": {
"type": "number",
"description": "required if host is managed and value is not inherited from host group"
},
"domain_id": {
"type": "number",
"description": "required if host is managed and value is not inherited from host group"
},
"realm_id": {
"type": "number"
},
"puppet_proxy_id": {
"type": "number",
"description": "Puppet proxy ID"
},
"puppet_ca_proxy_id": {
"type": "number",
"description": "Puppet CA proxy ID"
},
"puppetclass_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"config_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated config groups"
},
"operatingsystem_id": {
"type": "string",
"description": "required if host is managed and value is not inherited from host group"
},
"medium_id": {
"type": "string",
"description": "required if not imaged based provisioning and host is managed and value is not inherited from host group"
},
"pxe_loader": {
"type": "string",
"enum": [
"None",
"PXELinux BIOS",
"PXELinux UEFI",
"Grub UEFI",
"Grub2 UEFI",
"Grub2 UEFI SecureBoot",
"Grub2 UEFI HTTP",
"Grub2 UEFI HTTPS",
"Grub2 UEFI HTTPS SecureBoot",
"iPXE Embedded",
"iPXE UEFI HTTP",
"iPXE Chain BIOS",
"iPXE Chain UEFI"
],
"description": "DHCP filename option (Grub2/PXELinux by default)"
},
"ptable_id": {
"type": "number",
"description": "required if host is managed and custom partition has not been defined"
},
"subnet_id": {
"type": "number",
"description": "required if host is managed and value is not inherited from host group"
},
"compute_resource_id": {
"type": "number",
"description": "nil means host is bare metal"
},
"root_pass": {
"type": "string",
"description": "required if host is managed and value is not inherited from host group or default password in settings"
},
"model_id": {
"type": "number"
},
"hostgroup_id": {
"type": "number"
},
"owner_id": {
"type": "number"
},
"owner_type": {
"type": "string",
"enum": [
"User",
"Usergroup"
],
"description": "Host's owner type"
},
"image_id": {
"type": "number"
},
"host_parameters_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Host's parameters (array or indexed hash)"
},
"build": {
"type": "boolean"
},
"enabled": {
"type": "boolean",
"description": "Include this host within Foreman reporting"
},
"provision_method": {
"type": "string",
"enum": [
"build",
"image"
],
"description": "The method used to provision the host."
},
"managed": {
"type": "boolean",
"description": "True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not"
},
"progress_report_id": {
"type": "string",
"description": "UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks"
},
"comment": {
"type": "string",
"description": "Additional information about this host"
},
"capabilities": {
"type": "string"
},
"compute_profile_id": {
"type": "number"
},
"interfaces_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Host's network interfaces."
},
"compute_attributes": {
"type": "object",
"additionalProperties": true,
"description": "Additional compute resource specific attributes."
},
"ansible_role_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated ansible roles"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"host"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/hosts": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_hostgroup_id_hosts",
"summary": "List all hosts for a host group",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "thin",
"type": "boolean",
"in": "query",
"description": "Only list ID and name of hosts"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
},
{
"name": "include",
"type": "string",
"enum": [
"parameters",
"all_parameters"
],
"in": "query",
"description": "Array of extra information types to include"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/hosts": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_hosts",
"summary": "List hosts per location",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "location_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of location"
},
{
"name": "thin",
"type": "boolean",
"in": "query",
"description": "Only list ID and name of hosts"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
},
{
"name": "include",
"type": "string",
"enum": [
"parameters",
"all_parameters"
],
"in": "query",
"description": "Array of extra information types to include"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/hosts": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_hosts",
"summary": "List hosts per organization",
"parameters": [
{
"name": "location_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of location"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "organization_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of organization"
},
{
"name": "thin",
"type": "boolean",
"in": "query",
"description": "Only list ID and name of hosts"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
},
{
"name": "include",
"type": "string",
"enum": [
"parameters",
"all_parameters"
],
"in": "query",
"description": "Array of extra information types to include"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/environments/{environment_id}/hosts": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_environments_environment_id_hosts",
"summary": "List hosts per environment",
"parameters": [
{
"name": "organization_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of organization"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of location"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of environment"
},
{
"name": "thin",
"type": "boolean",
"in": "query",
"description": "Only list ID and name of hosts"
},
{
"name": "include",
"type": "string",
"enum": [
"parameters",
"all_parameters"
],
"in": "query",
"description": "Array of extra information types to include"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{id}": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_id",
"summary": "Show a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden_parameters",
"type": "boolean",
"in": "query",
"description": "Display hidden parameter values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "put_hosts_id",
"summary": "Update a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"environment_id": {
"type": "string",
"description": "required if host is managed and value is not inherited from host group"
},
"ip": {
"type": "string",
"description": "not required if using a subnet with DHCP proxy"
},
"mac": {
"type": "string",
"description": "required for managed host that is bare metal, not required if it's a virtual machine"
},
"architecture_id": {
"type": "number",
"description": "required if host is managed and value is not inherited from host group"
},
"domain_id": {
"type": "number",
"description": "required if host is managed and value is not inherited from host group"
},
"realm_id": {
"type": "number"
},
"puppet_proxy_id": {
"type": "number",
"description": "Puppet proxy ID"
},
"puppet_ca_proxy_id": {
"type": "number",
"description": "Puppet CA proxy ID"
},
"puppetclass_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"config_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated config groups"
},
"operatingsystem_id": {
"type": "string",
"description": "required if host is managed and value is not inherited from host group"
},
"medium_id": {
"type": "string",
"description": "required if not imaged based provisioning and host is managed and value is not inherited from host group"
},
"pxe_loader": {
"type": "string",
"enum": [
"None",
"PXELinux BIOS",
"PXELinux UEFI",
"Grub UEFI",
"Grub2 UEFI",
"Grub2 UEFI SecureBoot",
"Grub2 UEFI HTTP",
"Grub2 UEFI HTTPS",
"Grub2 UEFI HTTPS SecureBoot",
"iPXE Embedded",
"iPXE UEFI HTTP",
"iPXE Chain BIOS",
"iPXE Chain UEFI"
],
"description": "DHCP filename option (Grub2/PXELinux by default)"
},
"ptable_id": {
"type": "number",
"description": "required if host is managed and custom partition has not been defined"
},
"subnet_id": {
"type": "number",
"description": "required if host is managed and value is not inherited from host group"
},
"compute_resource_id": {
"type": "number",
"description": "nil means host is bare metal"
},
"root_pass": {
"type": "string",
"description": "required if host is managed and value is not inherited from host group or default password in settings"
},
"model_id": {
"type": "number"
},
"hostgroup_id": {
"type": "number"
},
"owner_id": {
"type": "number"
},
"owner_type": {
"type": "string",
"enum": [
"User",
"Usergroup"
],
"description": "Host's owner type"
},
"image_id": {
"type": "number"
},
"host_parameters_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Host's parameters (array or indexed hash)"
},
"build": {
"type": "boolean"
},
"enabled": {
"type": "boolean",
"description": "Include this host within Foreman reporting"
},
"provision_method": {
"type": "string",
"enum": [
"build",
"image"
],
"description": "The method used to provision the host."
},
"managed": {
"type": "boolean",
"description": "True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not"
},
"progress_report_id": {
"type": "string",
"description": "UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks"
},
"comment": {
"type": "string",
"description": "Additional information about this host"
},
"capabilities": {
"type": "string"
},
"compute_profile_id": {
"type": "number"
},
"interfaces_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Host's network interfaces."
},
"compute_attributes": {
"type": "object",
"additionalProperties": true,
"description": "Additional compute resource specific attributes."
},
"ansible_role_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated ansible roles"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"host"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "delete_hosts_id",
"summary": "Delete a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{id}/enc": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_id_enc",
"summary": "Get ENC values of host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{id}/status": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_id_status",
"summary": "Get configuration status of host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": "\n<p>Return value may either be one of the following:</p>\n<ul><li>\n<p>Alerts disabled</p>\n</li><li>\n<p>No reports</p>\n</li><li>\n<p>Error</p>\n</li><li>\n<p>Out of sync</p>\n</li><li>\n<p>Active</p>\n</li><li>\n<p>Pending</p>\n</li><li>\n<p>No changes</p>\n</li></ul>\n"
}
},
"/hosts/{id}/status/{type}": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_id_status_type",
"summary": "Get status of host",
"parameters": [
{
"name": "type",
"type": "string",
"in": "path",
"required": true,
"description": "status type, can be one of\n* global\n* configuration\n* build\n"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": "\n<p>Returns string representing a host status of a given type</p>\n"
}
},
"/hosts/{id}/vm_compute_attributes": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_id_vm_compute_attributes",
"summary": "Get vm attributes of host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": "\n<p>Return the host&#39;s compute attributes that can be used to create a clone\nof this VM</p>\n"
}
},
"/hosts/{id}/disassociate": {
"put": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "put_hosts_id_disassociate",
"summary": "Disassociate the host from a VM",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{id}/power": {
"put": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "put_hosts_id_power",
"summary": "Run a power operation on host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"power_action": {
"type": "string",
"description": "power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)"
}
},
"additionalProperties": false,
"required": [
"power_action"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{id}/boot": {
"put": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "put_hosts_id_boot",
"summary": "Boot host from specified device",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"device": {
"type": "string",
"description": "boot device, valid devices are disk, cdrom, pxe, bios"
}
},
"additionalProperties": false,
"required": [
"device"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/facts": {
"post": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "post_hosts_facts",
"summary": "Upload facts for a host, creating the host if required",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "hostname of the host"
},
"facts": {
"type": "object",
"additionalProperties": true,
"description": "hash containing the facts for the host"
},
"certname": {
"type": "string",
"description": "optional: certname of the host"
},
"type": {
"type": "string",
"description": "optional: the STI type of host to create"
}
},
"additionalProperties": false,
"required": [
"name",
"facts"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{id}/rebuild_config": {
"put": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "put_hosts_id_rebuild_config",
"summary": "Rebuild orchestration config",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"only": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit rebuild steps, valid steps are DHCP, DNS, TFTP"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{id}/template/{kind}": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_id_template_kind",
"summary": "Preview rendered provisioning template content",
"parameters": [
{
"name": "kind",
"type": "string",
"in": "path",
"required": true,
"description": "Template kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{id}/play_roles": {
"post": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "post_hosts_id_play_roles",
"summary": "Plays Ansible roles on a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/multiple_play_roles": {
"post": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "post_hosts_multiple_play_roles",
"summary": "Plays Ansible roles on hosts",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of hosts to play roles on"
}
},
"additionalProperties": false,
"required": [
"host_ids"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{id}/ansible_roles": {
"get": {
"tags": [
"hosts"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_id_ansible_roles",
"summary": "List all Ansible roles for a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/interfaces": {
"get": {
"tags": [
"interfaces"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_interfaces",
"summary": "List all interfaces for host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of host"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"description": "ID or name of domain"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID or name of subnet"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"interfaces"
],
"consumes": [
"application/json"
],
"operationId": "post_hosts_host_id_interfaces",
"summary": "Create an interface on a host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of host"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"interface": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "MAC address of interface. Required for managed interfaces on bare metal."
},
"ip": {
"type": "string",
"description": "IPv4 address of interface"
},
"ip6": {
"type": "string",
"description": "IPv6 address of interface"
},
"type": {
"type": "string",
"enum": [
"interface",
"bmc",
"bond",
"bridge"
],
"description": "Interface type, e.g. bmc. Default is interface"
},
"name": {
"type": "string",
"description": "Interface's DNS name"
},
"subnet_id": {
"type": "number",
"description": "Foreman subnet ID of IPv4 interface"
},
"subnet6_id": {
"type": "number",
"description": "Foreman subnet ID of IPv6 interface"
},
"domain_id": {
"type": "number",
"description": "Foreman domain ID of interface. Required for primary interfaces on managed hosts."
},
"identifier": {
"type": "string",
"description": "Device identifier, e.g. eth0 or eth1.1"
},
"managed": {
"type": "boolean",
"description": "Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?"
},
"primary": {
"type": "boolean",
"description": "Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface."
},
"provision": {
"type": "boolean",
"description": "Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface."
},
"username": {
"type": "string",
"description": "Only for BMC interfaces."
},
"password": {
"type": "string",
"description": "Only for BMC interfaces."
},
"provider": {
"type": "string",
"enum": [
"IPMI",
"SSH"
],
"description": "Interface provider, e.g. IPMI. Only for BMC interfaces."
},
"virtual": {
"type": "boolean",
"description": "Alias or VLAN device"
},
"tag": {
"type": "string",
"description": "VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces."
},
"mtu": {
"type": "number",
"description": "MTU, this attribute has precedence over the subnet MTU."
},
"attached_to": {
"type": "string",
"description": "Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces."
},
"mode": {
"type": "string",
"enum": [
"balance-rr",
"active-backup",
"balance-xor",
"broadcast",
"802.3ad",
"balance-tlb",
"balance-alb"
],
"description": "Bond mode of the interface, e.g. balance-rr. Only for bond interfaces."
},
"attached_devices": {
"type": "array",
"items": {
"type": "string"
},
"description": "Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces."
},
"bond_options": {
"type": "string",
"description": "Space separated options, e.g. miimon=100. Only for bond interfaces."
},
"compute_attributes": {
"type": "object",
"additionalProperties": true,
"description": "Additional compute resource specific attributes for the interface."
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"interface"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/domains/{domain_id}/interfaces": {
"get": {
"tags": [
"interfaces"
],
"consumes": [
"application/json"
],
"operationId": "get_domains_domain_id_interfaces",
"summary": "List all interfaces for domain",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID or name of host"
},
{
"name": "domain_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of domain"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID or name of subnet"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/subnets/{subnet_id}/interfaces": {
"get": {
"tags": [
"interfaces"
],
"consumes": [
"application/json"
],
"operationId": "get_subnets_subnet_id_interfaces",
"summary": "List all interfaces for subnet",
"parameters": [
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID or name of domain"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID or name of host"
},
{
"name": "subnet_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of subnet"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/interfaces/{id}": {
"get": {
"tags": [
"interfaces"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_interfaces_id",
"summary": "Show an interface for host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of interface"
},
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of host"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"interfaces"
],
"consumes": [
"application/json"
],
"operationId": "put_hosts_host_id_interfaces_id",
"summary": "Update a host's interface",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of interface"
},
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of host"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"interface": {
"type": "object",
"properties": {
"mac": {
"type": "string",
"description": "MAC address of interface. Required for managed interfaces on bare metal."
},
"ip": {
"type": "string",
"description": "IPv4 address of interface"
},
"ip6": {
"type": "string",
"description": "IPv6 address of interface"
},
"type": {
"type": "string",
"enum": [
"interface",
"bmc",
"bond",
"bridge"
],
"description": "Interface type, e.g. bmc. Default is interface"
},
"name": {
"type": "string",
"description": "Interface's DNS name"
},
"subnet_id": {
"type": "number",
"description": "Foreman subnet ID of IPv4 interface"
},
"subnet6_id": {
"type": "number",
"description": "Foreman subnet ID of IPv6 interface"
},
"domain_id": {
"type": "number",
"description": "Foreman domain ID of interface. Required for primary interfaces on managed hosts."
},
"identifier": {
"type": "string",
"description": "Device identifier, e.g. eth0 or eth1.1"
},
"managed": {
"type": "boolean",
"description": "Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?"
},
"primary": {
"type": "boolean",
"description": "Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface."
},
"provision": {
"type": "boolean",
"description": "Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface."
},
"username": {
"type": "string",
"description": "Only for BMC interfaces."
},
"password": {
"type": "string",
"description": "Only for BMC interfaces."
},
"provider": {
"type": "string",
"enum": [
"IPMI",
"SSH"
],
"description": "Interface provider, e.g. IPMI. Only for BMC interfaces."
},
"virtual": {
"type": "boolean",
"description": "Alias or VLAN device"
},
"tag": {
"type": "string",
"description": "VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces."
},
"mtu": {
"type": "number",
"description": "MTU, this attribute has precedence over the subnet MTU."
},
"attached_to": {
"type": "string",
"description": "Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces."
},
"mode": {
"type": "string",
"enum": [
"balance-rr",
"active-backup",
"balance-xor",
"broadcast",
"802.3ad",
"balance-tlb",
"balance-alb"
],
"description": "Bond mode of the interface, e.g. balance-rr. Only for bond interfaces."
},
"attached_devices": {
"type": "array",
"items": {
"type": "string"
},
"description": "Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces."
},
"bond_options": {
"type": "string",
"description": "Space separated options, e.g. miimon=100. Only for bond interfaces."
},
"compute_attributes": {
"type": "object",
"additionalProperties": true,
"description": "Additional compute resource specific attributes for the interface."
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"interface"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"interfaces"
],
"consumes": [
"application/json"
],
"operationId": "delete_hosts_host_id_interfaces_id",
"summary": "Delete a host's interface",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of interface"
},
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of host"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups": {
"get": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups",
"summary": "List all host groups",
"parameters": [
{
"name": "puppetclass_id",
"type": "string",
"in": "query",
"description": "ID of Puppet class"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
},
{
"name": "include",
"type": "array",
"items": {
"type": "string"
},
"in": [
"parameters"
],
"description": "Array of extra information types to include"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "post_hostgroups",
"summary": "Create a host group",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"hostgroup": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the host group"
},
"description": {
"type": "string",
"description": "Host group description"
},
"parent_id": {
"type": "number",
"description": "Parent ID of the host group"
},
"environment_id": {
"type": "number",
"description": "Environment ID"
},
"compute_profile_id": {
"type": "number",
"description": "Compute profile ID"
},
"compute_resource_id": {
"type": "number",
"description": "Compute resource ID"
},
"operatingsystem_id": {
"type": "number",
"description": "Operating system ID"
},
"architecture_id": {
"type": "number",
"description": "Architecture ID"
},
"pxe_loader": {
"type": "string",
"enum": [
"None",
"PXELinux BIOS",
"PXELinux UEFI",
"Grub UEFI",
"Grub2 UEFI",
"Grub2 UEFI SecureBoot",
"Grub2 UEFI HTTP",
"Grub2 UEFI HTTPS",
"Grub2 UEFI HTTPS SecureBoot",
"iPXE Embedded",
"iPXE UEFI HTTP",
"iPXE Chain BIOS",
"iPXE Chain UEFI"
],
"description": "DHCP filename option (Grub2/PXELinux by default)"
},
"medium_id": {
"type": "number",
"description": "Media ID"
},
"ptable_id": {
"type": "number",
"description": "Partition table ID"
},
"subnet_id": {
"type": "number",
"description": "Subnet ID"
},
"domain_id": {
"type": "number",
"description": "Domain ID"
},
"realm_id": {
"type": "number",
"description": "Realm ID"
},
"config_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated config groups"
},
"group_parameters_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of parameters"
},
"puppet_proxy_id": {
"type": "number",
"description": "Puppet proxy ID"
},
"puppet_ca_proxy_id": {
"type": "number",
"description": "Puppet CA proxy ID"
},
"root_pass": {
"type": "string",
"description": "Root password on provisioned hosts"
},
"ansible_role_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated ansible roles"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"hostgroup"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/puppetclasses/{puppetclass_id}/hostgroups": {
"get": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "get_puppetclasses_puppetclass_id_hostgroups",
"summary": "List all host groups for a Puppet class",
"parameters": [
{
"name": "puppetclass_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
},
{
"name": "include",
"type": "array",
"items": {
"type": "string"
},
"in": [
"parameters"
],
"description": "Array of extra information types to include"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/hostgroups": {
"get": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_hostgroups",
"summary": "List all host groups per location",
"parameters": [
{
"name": "puppetclass_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
},
{
"name": "include",
"type": "array",
"items": {
"type": "string"
},
"in": [
"parameters"
],
"description": "Array of extra information types to include"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/hostgroups": {
"get": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_hostgroups",
"summary": "List all host groups per organization",
"parameters": [
{
"name": "puppetclass_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
},
{
"name": "include",
"type": "array",
"items": {
"type": "string"
},
"in": [
"parameters"
],
"description": "Array of extra information types to include"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{id}": {
"get": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_id",
"summary": "Show a host group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden_parameters",
"type": "boolean",
"in": "query",
"description": "Display hidden parameter values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "put_hostgroups_id",
"summary": "Update a host group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"hostgroup": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the host group"
},
"description": {
"type": "string",
"description": "Host group description"
},
"parent_id": {
"type": "number",
"description": "Parent ID of the host group"
},
"environment_id": {
"type": "number",
"description": "Environment ID"
},
"compute_profile_id": {
"type": "number",
"description": "Compute profile ID"
},
"compute_resource_id": {
"type": "number",
"description": "Compute resource ID"
},
"operatingsystem_id": {
"type": "number",
"description": "Operating system ID"
},
"architecture_id": {
"type": "number",
"description": "Architecture ID"
},
"pxe_loader": {
"type": "string",
"enum": [
"None",
"PXELinux BIOS",
"PXELinux UEFI",
"Grub UEFI",
"Grub2 UEFI",
"Grub2 UEFI SecureBoot",
"Grub2 UEFI HTTP",
"Grub2 UEFI HTTPS",
"Grub2 UEFI HTTPS SecureBoot",
"iPXE Embedded",
"iPXE UEFI HTTP",
"iPXE Chain BIOS",
"iPXE Chain UEFI"
],
"description": "DHCP filename option (Grub2/PXELinux by default)"
},
"medium_id": {
"type": "number",
"description": "Media ID"
},
"ptable_id": {
"type": "number",
"description": "Partition table ID"
},
"subnet_id": {
"type": "number",
"description": "Subnet ID"
},
"domain_id": {
"type": "number",
"description": "Domain ID"
},
"realm_id": {
"type": "number",
"description": "Realm ID"
},
"config_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated config groups"
},
"group_parameters_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of parameters"
},
"puppet_proxy_id": {
"type": "number",
"description": "Puppet proxy ID"
},
"puppet_ca_proxy_id": {
"type": "number",
"description": "Puppet CA proxy ID"
},
"root_pass": {
"type": "string",
"description": "Root password on provisioned hosts"
},
"ansible_role_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated ansible roles"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"hostgroup"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "delete_hostgroups_id",
"summary": "Delete a host group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{id}/clone": {
"post": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "post_hostgroups_id_clone",
"summary": "Clone a host group",
"parameters": [
{
"name": "id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{id}/rebuild_config": {
"put": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "put_hostgroups_id_rebuild_config",
"summary": "Rebuild orchestration config",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"only": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit rebuild steps, valid steps are DHCP, DNS, TFTP"
},
"children_hosts": {
"type": "boolean",
"description": "Operate on child hostgroup hosts"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{id}/play_roles": {
"post": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "post_hostgroups_id_play_roles",
"summary": "Plays Ansible roles on a hostgroup",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/multiple_play_roles": {
"post": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "post_hostgroups_multiple_play_roles",
"summary": "Plays Ansible roles on hostgroups",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"hostgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of hostgroups to play roles on"
}
},
"additionalProperties": false,
"required": [
"hostgroup_ids"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{id}/ansible_roles": {
"get": {
"tags": [
"hostgroups"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_id_ansible_roles",
"summary": "List all Ansible roles for a hostgroup",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/usergroups/{usergroup_id}/external_usergroups": {
"get": {
"tags": [
"external_usergroups"
],
"consumes": [
"application/json"
],
"operationId": "get_usergroups_usergroup_id_external_usergroups",
"summary": "List all external user groups for user group",
"parameters": [
{
"name": "usergroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of user group"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"external_usergroups"
],
"consumes": [
"application/json"
],
"operationId": "post_usergroups_usergroup_id_external_usergroups",
"summary": "Create an external user group linked to a user group",
"parameters": [
{
"name": "usergroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of user group"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"external_usergroup": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "External user group name"
},
"auth_source_id": {
"type": "number",
"description": "ID of linked authentication source"
}
},
"additionalProperties": false,
"required": [
"name",
"auth_source_id"
]
}
},
"additionalProperties": false,
"required": [
"external_usergroup"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_source_ldaps/{auth_source_ldap_id}/external_usergroups": {
"get": {
"tags": [
"external_usergroups"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_source_ldaps_auth_source_ldap_id_external_usergroups",
"summary": "List all external user groups for LDAP authentication source",
"parameters": [
{
"name": "usergroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID or name of user group"
},
{
"name": "auth_source_ldap_id",
"type": "number",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/usergroups/{usergroup_id}/external_usergroups/{id}": {
"get": {
"tags": [
"external_usergroups"
],
"consumes": [
"application/json"
],
"operationId": "get_usergroups_usergroup_id_external_usergroups_id",
"summary": "Show an external user group for user group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of external user group"
},
{
"name": "usergroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of user group"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"external_usergroups"
],
"consumes": [
"application/json"
],
"operationId": "put_usergroups_usergroup_id_external_usergroups_id",
"summary": "Update external user group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of external user group"
},
{
"name": "usergroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of user group"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"external_usergroup": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "External user group name"
},
"auth_source_id": {
"type": "number",
"description": "ID of linked authentication source"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"external_usergroup"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"external_usergroups"
],
"consumes": [
"application/json"
],
"operationId": "delete_usergroups_usergroup_id_external_usergroups_id",
"summary": "Delete an external user group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name external user group"
},
{
"name": "usergroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of user group"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_source_ldaps/{auth_source_ldap_id}/external_usergroups/{id}": {
"get": {
"tags": [
"external_usergroups"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_source_ldaps_auth_source_ldap_id_external_usergroups_id",
"summary": "Show an external user group for LDAP authentication source",
"parameters": [
{
"name": "usergroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID or name of user group"
},
{
"name": "auth_source_ldap_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of external user group"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/usergroups/{usergroup_id}/external_usergroups/{id}/refresh": {
"put": {
"tags": [
"external_usergroups"
],
"consumes": [
"application/json"
],
"operationId": "put_usergroups_usergroup_id_external_usergroups_id_refresh",
"summary": "Refresh external user group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of external user group"
},
{
"name": "usergroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID or name of user group"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/http_proxies": {
"get": {
"tags": [
"http_proxies"
],
"consumes": [
"application/json"
],
"operationId": "get_http_proxies",
"summary": "List of HTTP Proxies",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"http_proxies"
],
"consumes": [
"application/json"
],
"operationId": "post_http_proxies",
"summary": "Create an HTTP Proxy",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"http_proxy": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The HTTP Proxy name"
},
"url": {
"type": "string",
"description": "URL of the HTTP Proxy"
},
"username": {
"type": "string",
"description": "Username used to authenticate with the HTTP Proxy"
},
"password": {
"type": "string",
"description": "Password used to authenticate with the HTTP Proxy"
}
},
"additionalProperties": false,
"required": [
"name",
"url"
]
}
},
"additionalProperties": false,
"required": [
"http_proxy"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/http_proxies/{id}": {
"get": {
"tags": [
"http_proxies"
],
"consumes": [
"application/json"
],
"operationId": "get_http_proxies_id",
"summary": "Show an HTTP Proxy",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "Numerical ID or HTTP Proxy name"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"http_proxies"
],
"consumes": [
"application/json"
],
"operationId": "put_http_proxies_id",
"summary": "Update an HTTP Proxy",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"http_proxy": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The HTTP Proxy name"
},
"url": {
"type": "string",
"description": "URL of the HTTP Proxy"
},
"username": {
"type": "string",
"description": "Username used to authenticate with the HTTP Proxy"
},
"password": {
"type": "string",
"description": "Password used to authenticate with the HTTP Proxy"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"http_proxy"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"http_proxies"
],
"consumes": [
"application/json"
],
"operationId": "delete_http_proxies_id",
"summary": "Delete an HTTP Proxy",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/os_default_templates": {
"get": {
"tags": [
"os_default_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_os_default_templates",
"summary": "List default templates combinations for an operating system",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "config_template_id",
"type": "string",
"in": "query",
"description": "ID of provisioning template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"description": "ID of provisioning template"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"os_default_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_operatingsystems_operatingsystem_id_os_default_templates",
"summary": "Create a default template combination for an operating system",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"os_default_template": {
"type": "object",
"properties": {
"template_kind_id": {
"type": "number"
},
"config_template_id": {
"type": "number",
"description": "ID of provisioning template"
},
"provisioning_template_id": {
"type": "number",
"description": "ID of provisioning template"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"os_default_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_templates/{config_template_id}/os_default_templates": {
"get": {
"tags": [
"os_default_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_config_templates_config_template_id_os_default_templates",
"summary": "List operating systems where this template is set as a default",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "config_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of provisioning template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"description": "ID of provisioning template"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates/{provisioning_template_id}/os_default_templates": {
"get": {
"tags": [
"os_default_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_provisioning_templates_provisioning_template_id_os_default_templates",
"summary": "List operating systems where this template is set as a default",
"parameters": [
{
"name": "config_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of provisioning template"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of provisioning template"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/os_default_templates/{id}": {
"get": {
"tags": [
"os_default_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_os_default_templates_id",
"summary": "Show a default template combination for an operating system",
"parameters": [
{
"name": "id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"os_default_templates"
],
"consumes": [
"application/json"
],
"operationId": "put_operatingsystems_operatingsystem_id_os_default_templates_id",
"summary": "Update a default template combination for an operating system",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"os_default_template": {
"type": "object",
"properties": {
"template_kind_id": {
"type": "number"
},
"config_template_id": {
"type": "number",
"description": "ID of provisioning template"
},
"provisioning_template_id": {
"type": "number",
"description": "ID of provisioning template"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"os_default_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"os_default_templates"
],
"consumes": [
"application/json"
],
"operationId": "delete_operatingsystems_operatingsystem_id_os_default_templates_id",
"summary": "Delete a default template combination for an operating system",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{id}/puppetrun": {
"put": {
"tags": [
"puppet_hosts"
],
"consumes": [
"application/json"
],
"operationId": "put_hosts_id_puppetrun",
"summary": "Force a Puppet agent run on the host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/fact_values": {
"get": {
"tags": [
"fact_values"
],
"consumes": [
"application/json"
],
"operationId": "get_fact_values",
"summary": "List all fact values",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/facts": {
"get": {
"tags": [
"fact_values"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_facts",
"summary": "List all fact values of a given host",
"parameters": [
{
"name": "host_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/dashboard": {
"get": {
"tags": [
"dashboard"
],
"consumes": [
"application/json"
],
"operationId": "get_dashboard",
"summary": "Get dashboard details",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_variables": {
"get": {
"tags": [
"smart_variables"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_variables",
"summary": "List all smart variables",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "query"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query"
},
{
"name": "puppetclass_id",
"type": "string",
"in": "query"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"smart_variables"
],
"consumes": [
"application/json"
],
"operationId": "post_smart_variables",
"summary": "Create a smart variable",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_variable": {
"type": "object",
"properties": {
"variable": {
"type": "string",
"description": "Name of variable"
},
"puppetclass_id": {
"type": "number",
"description": "Puppet class ID"
},
"default_value": {
"type": "any_type",
"description": "Default value of variable"
},
"hidden_value": {
"type": "boolean",
"description": "When enabled the parameter is hidden in the UI"
},
"override_value_order": {
"type": "string",
"description": "The order in which values are resolved"
},
"description": {
"type": "string",
"description": "Description of variable"
},
"validator_type": {
"type": "string",
"enum": [
"regexp",
"list"
],
"description": "Types of validation values"
},
"validator_rule": {
"type": "string",
"description": "Used to enforce certain values for the parameter values"
},
"variable_type": {
"type": "string",
"enum": [
"string",
"boolean",
"integer",
"real",
"array",
"hash",
"yaml",
"json"
],
"description": "Types of variable values"
},
"merge_overrides": {
"type": "boolean",
"description": "Merge all matching values (only array/hash type)"
},
"merge_default": {
"type": "boolean",
"description": "Include default value when merging all matching values"
},
"avoid_duplicates": {
"type": "boolean",
"description": "Remove duplicate values (only array type)"
}
},
"additionalProperties": false,
"required": [
"variable"
]
}
},
"additionalProperties": false,
"required": [
"smart_variable"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/smart_variables": {
"get": {
"tags": [
"smart_variables"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_smart_variables",
"summary": "List of smart variables for a specific host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query"
},
{
"name": "puppetclass_id",
"type": "string",
"in": "query"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/smart_variables": {
"get": {
"tags": [
"smart_variables"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_hostgroup_id_smart_variables",
"summary": "List of smart variables for a specific host group",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "puppetclass_id",
"type": "string",
"in": "query"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/puppetclasses/{puppetclass_id}/smart_variables": {
"get": {
"tags": [
"smart_variables"
],
"consumes": [
"application/json"
],
"operationId": "get_puppetclasses_puppetclass_id_smart_variables",
"summary": "List of smart variables for a specific Puppet class",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "puppetclass_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_variables/{id}": {
"get": {
"tags": [
"smart_variables"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_variables_id",
"summary": "Show a smart variable",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"smart_variables"
],
"consumes": [
"application/json"
],
"operationId": "put_smart_variables_id",
"summary": "Update a smart variable",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_variable": {
"type": "object",
"properties": {
"variable": {
"type": "string",
"description": "Name of variable"
},
"puppetclass_id": {
"type": "number",
"description": "Puppet class ID"
},
"default_value": {
"type": "any_type",
"description": "Default value of variable"
},
"hidden_value": {
"type": "boolean",
"description": "When enabled the parameter is hidden in the UI"
},
"override_value_order": {
"type": "string",
"description": "The order in which values are resolved"
},
"description": {
"type": "string",
"description": "Description of variable"
},
"validator_type": {
"type": "string",
"enum": [
"regexp",
"list"
],
"description": "Types of validation values"
},
"validator_rule": {
"type": "string",
"description": "Used to enforce certain values for the parameter values"
},
"variable_type": {
"type": "string",
"enum": [
"string",
"boolean",
"integer",
"real",
"array",
"hash",
"yaml",
"json"
],
"description": "Types of variable values"
},
"merge_overrides": {
"type": "boolean",
"description": "Merge all matching values (only array/hash type)"
},
"merge_default": {
"type": "boolean",
"description": "Include default value when merging all matching values"
},
"avoid_duplicates": {
"type": "boolean",
"description": "Remove duplicate values (only array type)"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"smart_variable"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"smart_variables"
],
"consumes": [
"application/json"
],
"operationId": "delete_smart_variables_id",
"summary": "Delete a smart variable",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates": {
"get": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_provisioning_templates",
"summary": "List provisioning templates",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_provisioning_templates",
"summary": "Create a provisioning template",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"provisioning_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
},
"template": {
"type": "string"
},
"snippet": {
"type": "boolean"
},
"audit_comment": {
"type": "string"
},
"template_kind_id": {
"type": "number",
"description": "not relevant for snippet"
},
"template_combinations_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of template combinations (hostgroup_id, environment_id)"
},
"operatingsystem_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of operating system IDs to associate with the template"
},
"locked": {
"type": "boolean",
"description": "Whether or not the template is locked for editing"
}
},
"additionalProperties": false,
"required": [
"name",
"template"
]
}
},
"additionalProperties": false,
"required": [
"provisioning_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/provisioning_templates": {
"get": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_provisioning_templates",
"summary": "List provisioning templates per operating system",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/provisioning_templates": {
"get": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_provisioning_templates",
"summary": "List provisioning templates per location",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/provisioning_templates": {
"get": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_provisioning_templates",
"summary": "List provisioning templates per organization",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates/{id}": {
"get": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_provisioning_templates_id",
"summary": "Show provisioning template details",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "put_provisioning_templates_id",
"summary": "Update a provisioning template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"provisioning_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
},
"template": {
"type": "string"
},
"snippet": {
"type": "boolean"
},
"audit_comment": {
"type": "string"
},
"template_kind_id": {
"type": "number",
"description": "not relevant for snippet"
},
"template_combinations_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of template combinations (hostgroup_id, environment_id)"
},
"operatingsystem_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of operating system IDs to associate with the template"
},
"locked": {
"type": "boolean",
"description": "Whether or not the template is locked for editing"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"provisioning_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "delete_provisioning_templates_id",
"summary": "Delete a provisioning template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates/import": {
"post": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_provisioning_templates_import",
"summary": "Import a provisioning template",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"provisioning_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
},
"template": {
"type": "string",
"description": "template contents including metadata"
}
},
"additionalProperties": false
},
"options": {
"type": "object",
"properties": {
"force": {
"type": "boolean",
"description": "use if you want update locked templates"
},
"associate": {
"type": "string",
"enum": [
"new",
"always",
"never"
],
"description": "determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata"
},
"lock": {
"type": "boolean",
"description": "lock imported templates (false by default)"
},
"default": {
"type": "boolean",
"description": "makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"provisioning_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates/revision": {
"get": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_provisioning_templates_revision",
"parameters": [
{
"name": "version",
"type": "string",
"in": "query",
"description": "template version"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates/build_pxe_default": {
"post": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_provisioning_templates_build_pxe_default",
"summary": "Update the default PXE menu on all configured TFTP servers",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates/{id}/clone": {
"post": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_provisioning_templates_id_clone",
"summary": "Clone a provision template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"provisioning_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"provisioning_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates/{id}/export": {
"get": {
"tags": [
"provisioning_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_provisioning_templates_id_export",
"summary": "Export a provisioning template to ERB",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_proxies/{id}/import_puppetclasses": {
"post": {
"tags": [
"smart_proxies"
],
"consumes": [
"application/json"
],
"operationId": "post_smart_proxies_id_import_puppetclasses",
"summary": "Import puppet classes from puppet proxy",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_proxy_id": {
"type": "string"
},
"environment_id": {
"type": "string"
},
"dryrun": {
"type": "boolean"
},
"except": {
"type": "string",
"description": "Optional comma-delimited string containing either 'new', 'updated', or 'obsolete' that is used to limit the imported Puppet classes"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_proxies/{smart_proxy_id}/environments/{id}/import_puppetclasses": {
"post": {
"tags": [
"smart_proxies"
],
"consumes": [
"application/json"
],
"operationId": "post_smart_proxies_smart_proxy_id_environments_id_import_puppetclasses",
"summary": "Import puppet classes from puppet proxy for an environment",
"parameters": [
{
"name": "smart_proxy_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"environment_id": {
"type": "string"
},
"dryrun": {
"type": "boolean"
},
"except": {
"type": "string",
"description": "Optional comma-delimited string containing either 'new', 'updated', or 'obsolete' that is used to limit the imported Puppet classes"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/environments/{environment_id}/smart_proxies/{id}/import_puppetclasses": {
"post": {
"tags": [
"smart_proxies"
],
"consumes": [
"application/json"
],
"operationId": "post_environments_environment_id_smart_proxies_id_import_puppetclasses",
"summary": "Import puppet classes from puppet proxy for an environment",
"parameters": [
{
"name": "environment_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_proxy_id": {
"type": "string"
},
"dryrun": {
"type": "boolean"
},
"except": {
"type": "string",
"description": "Optional comma-delimited string containing either 'new', 'updated', or 'obsolete' that is used to limit the imported Puppet classes"
}
},
"additionalProperties": false,
"required": [
"smart_proxy_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/environments": {
"get": {
"tags": [
"environments"
],
"consumes": [
"application/json"
],
"operationId": "get_environments",
"summary": "List all environments",
"parameters": [
{
"name": "puppetclass_id",
"type": "string",
"in": "query",
"description": "ID of Puppet class"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"environments"
],
"consumes": [
"application/json"
],
"operationId": "post_environments",
"summary": "Create an environment",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"environment": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"environment"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/puppetclasses/{puppetclass_id}/environments": {
"get": {
"tags": [
"environments"
],
"consumes": [
"application/json"
],
"operationId": "get_puppetclasses_puppetclass_id_environments",
"summary": "List environments of Puppet class",
"parameters": [
{
"name": "puppetclass_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/environments": {
"get": {
"tags": [
"environments"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_environments",
"summary": "List environments per location",
"parameters": [
{
"name": "puppetclass_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/environments": {
"get": {
"tags": [
"environments"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_environments",
"summary": "List environments per organization",
"parameters": [
{
"name": "puppetclass_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/environments/{id}": {
"get": {
"tags": [
"environments"
],
"consumes": [
"application/json"
],
"operationId": "get_environments_id",
"summary": "Show an environment",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"environments"
],
"consumes": [
"application/json"
],
"operationId": "put_environments_id",
"summary": "Update an environment",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"environment": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"environment"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"environments"
],
"consumes": [
"application/json"
],
"operationId": "delete_environments_id",
"summary": "Delete an environment",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/template_kinds": {
"get": {
"tags": [
"template_kinds"
],
"consumes": [
"application/json"
],
"operationId": "get_template_kinds",
"summary": "List all template kinds",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/puppetclass_ids": {
"get": {
"tags": [
"host_classes"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_puppetclass_ids",
"summary": "List all Puppet class IDs for host",
"parameters": [
{
"name": "host_id",
"type": "number",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"host_classes"
],
"consumes": [
"application/json"
],
"operationId": "post_hosts_host_id_puppetclass_ids",
"summary": "Add a Puppet class to host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"puppetclass_id": {
"type": "string",
"description": "ID of Puppet class"
}
},
"additionalProperties": false,
"required": [
"puppetclass_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/puppetclass_ids/{id}": {
"delete": {
"tags": [
"host_classes"
],
"consumes": [
"application/json"
],
"operationId": "delete_hosts_host_id_puppetclass_ids_id",
"summary": "Remove a Puppet class from host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/orchestration/{id}/tasks": {
"get": {
"tags": [
"tasks"
],
"consumes": [
"application/json"
],
"operationId": "get_orchestration_id_tasks",
"summary": "List all tasks for a given orchestration event",
"parameters": [
{
"name": "id",
"type": "number",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/puppetclasses": {
"get": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "get_puppetclasses",
"summary": "List all Puppet classes",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "query",
"description": "ID of host"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "post_puppetclasses",
"summary": "Create a Puppet class",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"puppetclass": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"puppetclass"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/puppetclasses": {
"get": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_puppetclasses",
"summary": "List all Puppet classes for a host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/puppetclasses": {
"get": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_hostgroup_id_puppetclasses",
"summary": "List all Puppet classes for a host group",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/environments/{environment_id}/puppetclasses": {
"get": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "get_environments_environment_id_puppetclasses",
"summary": "List all Puppet classes for an environment",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "environment_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of environment"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/puppetclasses/{id}": {
"get": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "get_puppetclasses_id",
"summary": "Show a Puppet class",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"description": "ID of host"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "put_puppetclasses_id",
"summary": "Update a Puppet class",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"puppetclass": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"puppetclass"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "delete_puppetclasses_id",
"summary": "Delete a Puppet class",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/puppetclasses/{id}": {
"get": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_puppetclasses_id",
"summary": "Show a Puppet class for host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/puppetclasses/{id}": {
"get": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_hostgroup_id_puppetclasses_id",
"summary": "Show a Puppet class for a host group",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/environments/{environment_id}/puppetclasses/{id}": {
"get": {
"tags": [
"puppetclasses"
],
"consumes": [
"application/json"
],
"operationId": "get_environments_environment_id_puppetclasses_id",
"summary": "Show a Puppet class for an environment",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "environment_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/filters": {
"get": {
"tags": [
"filters"
],
"consumes": [
"application/json"
],
"operationId": "get_filters",
"summary": "List all filters",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"filters"
],
"consumes": [
"application/json"
],
"operationId": "post_filters",
"summary": "Create a filter",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"role_id": {
"type": "string"
},
"search": {
"type": "string"
},
"override": {
"type": "boolean"
},
"permission_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"organization_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"location_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"role_id"
]
}
},
"additionalProperties": false,
"required": [
"filter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/filters/{id}": {
"get": {
"tags": [
"filters"
],
"consumes": [
"application/json"
],
"operationId": "get_filters_id",
"summary": "Show a filter",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"filters"
],
"consumes": [
"application/json"
],
"operationId": "put_filters_id",
"summary": "Update a filter",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"role_id": {
"type": "string"
},
"search": {
"type": "string"
},
"override": {
"type": "boolean"
},
"permission_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"organization_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"location_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"filter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"filters"
],
"consumes": [
"application/json"
],
"operationId": "delete_filters_id",
"summary": "Delete a filter",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/users": {
"get": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "get_users",
"summary": "List all users",
"parameters": [
{
"name": "auth_source_ldap_id",
"type": "string",
"in": "query",
"description": "ID of LDAP authentication source"
},
{
"name": "usergroup_id",
"type": "string",
"in": "query",
"description": "ID of user group"
},
{
"name": "role_id",
"type": "string",
"in": "query",
"description": "ID of role"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "post_users",
"summary": "Create a user",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"mail": {
"type": "string"
},
"description": {
"type": "string"
},
"admin": {
"type": "boolean",
"description": "is an admin account"
},
"password": {
"type": "string",
"description": "Required unless user is in an external authentication source"
},
"auth_source_id": {
"type": "number"
},
"timezone": {
"type": "string",
"enum": [
"International Date Line West",
"American Samoa",
"Midway Island",
"Hawaii",
"Alaska",
"Pacific Time (US & Canada)",
"Tijuana",
"Arizona",
"Chihuahua",
"Mazatlan",
"Mountain Time (US & Canada)",
"Central America",
"Central Time (US & Canada)",
"Guadalajara",
"Mexico City",
"Monterrey",
"Saskatchewan",
"Bogota",
"Eastern Time (US & Canada)",
"Indiana (East)",
"Lima",
"Quito",
"Atlantic Time (Canada)",
"Caracas",
"Georgetown",
"La Paz",
"Puerto Rico",
"Santiago",
"Newfoundland",
"Brasilia",
"Buenos Aires",
"Greenland",
"Montevideo",
"Mid-Atlantic",
"Azores",
"Cape Verde Is.",
"Edinburgh",
"Lisbon",
"London",
"Monrovia",
"UTC",
"Amsterdam",
"Belgrade",
"Berlin",
"Bern",
"Bratislava",
"Brussels",
"Budapest",
"Casablanca",
"Copenhagen",
"Dublin",
"Ljubljana",
"Madrid",
"Paris",
"Prague",
"Rome",
"Sarajevo",
"Skopje",
"Stockholm",
"Vienna",
"Warsaw",
"West Central Africa",
"Zagreb",
"Zurich",
"Athens",
"Bucharest",
"Cairo",
"Harare",
"Helsinki",
"Jerusalem",
"Kaliningrad",
"Kyiv",
"Pretoria",
"Riga",
"Sofia",
"Tallinn",
"Vilnius",
"Baghdad",
"Istanbul",
"Kuwait",
"Minsk",
"Moscow",
"Nairobi",
"Riyadh",
"St. Petersburg",
"Tehran",
"Abu Dhabi",
"Baku",
"Muscat",
"Samara",
"Tbilisi",
"Volgograd",
"Yerevan",
"Kabul",
"Ekaterinburg",
"Islamabad",
"Karachi",
"Tashkent",
"Chennai",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Kathmandu",
"Almaty",
"Astana",
"Dhaka",
"Urumqi",
"Rangoon",
"Bangkok",
"Hanoi",
"Jakarta",
"Krasnoyarsk",
"Novosibirsk",
"Beijing",
"Chongqing",
"Hong Kong",
"Irkutsk",
"Kuala Lumpur",
"Perth",
"Singapore",
"Taipei",
"Ulaanbaatar",
"Osaka",
"Sapporo",
"Seoul",
"Tokyo",
"Yakutsk",
"Adelaide",
"Darwin",
"Brisbane",
"Canberra",
"Guam",
"Hobart",
"Melbourne",
"Port Moresby",
"Sydney",
"Vladivostok",
"Magadan",
"New Caledonia",
"Solomon Is.",
"Srednekolymsk",
"Auckland",
"Fiji",
"Kamchatka",
"Marshall Is.",
"Wellington",
"Chatham Is.",
"Nuku'alofa",
"Samoa",
"Tokelau Is."
],
"description": "User's timezone"
},
"locale": {
"type": "string",
"enum": [
"de",
"pt_BR",
"es",
"sv_SE",
"fr",
"nl_NL",
"ja",
"gl",
"pl",
"en_GB",
"zh_TW",
"zh_CN",
"ko",
"ru",
"it",
"en",
"ca"
],
"description": "User's preferred locale"
},
"role_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"login",
"mail",
"auth_source_id"
]
}
},
"additionalProperties": false,
"required": [
"user"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": "\n<p>Adds role &#39;Default role&#39; to the user by default</p>\n"
}
},
"/auth_source_ldaps/{auth_source_ldap_id}/users": {
"get": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_source_ldaps_auth_source_ldap_id_users",
"summary": "List all users for LDAP authentication source",
"parameters": [
{
"name": "auth_source_ldap_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of LDAP authentication source"
},
{
"name": "usergroup_id",
"type": "string",
"in": "query",
"description": "ID of user group"
},
{
"name": "role_id",
"type": "string",
"in": "query",
"description": "ID of role"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_source_externals/{auth_source_external_id}/users": {
"get": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_source_externals_auth_source_external_id_users",
"summary": "List all users for external authentication source",
"parameters": [
{
"name": "auth_source_ldap_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of LDAP authentication source"
},
{
"name": "auth_source_external_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "usergroup_id",
"type": "string",
"in": "query",
"description": "ID of user group"
},
{
"name": "role_id",
"type": "string",
"in": "query",
"description": "ID of role"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/usergroups/{usergroup_id}/users": {
"get": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "get_usergroups_usergroup_id_users",
"summary": "List all users for user group",
"parameters": [
{
"name": "auth_source_ldap_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of LDAP authentication source"
},
{
"name": "usergroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of user group"
},
{
"name": "role_id",
"type": "string",
"in": "query",
"description": "ID of role"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/roles/{role_id}/users": {
"get": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "get_roles_role_id_users",
"summary": "List all users for role",
"parameters": [
{
"name": "usergroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of user group"
},
{
"name": "auth_source_ldap_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of LDAP authentication source"
},
{
"name": "role_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of role"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/users": {
"get": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_users",
"summary": "List all users for location",
"parameters": [
{
"name": "role_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of role"
},
{
"name": "usergroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of user group"
},
{
"name": "auth_source_ldap_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of LDAP authentication source"
},
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/users": {
"get": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_users",
"summary": "List all users for organization",
"parameters": [
{
"name": "role_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of role"
},
{
"name": "usergroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of user group"
},
{
"name": "auth_source_ldap_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of LDAP authentication source"
},
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/users/{id}": {
"get": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "get_users_id",
"summary": "Show a user",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "put_users_id",
"summary": "Update a user",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"mail": {
"type": "string"
},
"description": {
"type": "string"
},
"admin": {
"type": "boolean",
"description": "is an admin account"
},
"password": {
"type": "string",
"description": "Required unless user is in an external authentication source"
},
"auth_source_id": {
"type": "number"
},
"timezone": {
"type": "string",
"enum": [
"International Date Line West",
"American Samoa",
"Midway Island",
"Hawaii",
"Alaska",
"Pacific Time (US & Canada)",
"Tijuana",
"Arizona",
"Chihuahua",
"Mazatlan",
"Mountain Time (US & Canada)",
"Central America",
"Central Time (US & Canada)",
"Guadalajara",
"Mexico City",
"Monterrey",
"Saskatchewan",
"Bogota",
"Eastern Time (US & Canada)",
"Indiana (East)",
"Lima",
"Quito",
"Atlantic Time (Canada)",
"Caracas",
"Georgetown",
"La Paz",
"Puerto Rico",
"Santiago",
"Newfoundland",
"Brasilia",
"Buenos Aires",
"Greenland",
"Montevideo",
"Mid-Atlantic",
"Azores",
"Cape Verde Is.",
"Edinburgh",
"Lisbon",
"London",
"Monrovia",
"UTC",
"Amsterdam",
"Belgrade",
"Berlin",
"Bern",
"Bratislava",
"Brussels",
"Budapest",
"Casablanca",
"Copenhagen",
"Dublin",
"Ljubljana",
"Madrid",
"Paris",
"Prague",
"Rome",
"Sarajevo",
"Skopje",
"Stockholm",
"Vienna",
"Warsaw",
"West Central Africa",
"Zagreb",
"Zurich",
"Athens",
"Bucharest",
"Cairo",
"Harare",
"Helsinki",
"Jerusalem",
"Kaliningrad",
"Kyiv",
"Pretoria",
"Riga",
"Sofia",
"Tallinn",
"Vilnius",
"Baghdad",
"Istanbul",
"Kuwait",
"Minsk",
"Moscow",
"Nairobi",
"Riyadh",
"St. Petersburg",
"Tehran",
"Abu Dhabi",
"Baku",
"Muscat",
"Samara",
"Tbilisi",
"Volgograd",
"Yerevan",
"Kabul",
"Ekaterinburg",
"Islamabad",
"Karachi",
"Tashkent",
"Chennai",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Kathmandu",
"Almaty",
"Astana",
"Dhaka",
"Urumqi",
"Rangoon",
"Bangkok",
"Hanoi",
"Jakarta",
"Krasnoyarsk",
"Novosibirsk",
"Beijing",
"Chongqing",
"Hong Kong",
"Irkutsk",
"Kuala Lumpur",
"Perth",
"Singapore",
"Taipei",
"Ulaanbaatar",
"Osaka",
"Sapporo",
"Seoul",
"Tokyo",
"Yakutsk",
"Adelaide",
"Darwin",
"Brisbane",
"Canberra",
"Guam",
"Hobart",
"Melbourne",
"Port Moresby",
"Sydney",
"Vladivostok",
"Magadan",
"New Caledonia",
"Solomon Is.",
"Srednekolymsk",
"Auckland",
"Fiji",
"Kamchatka",
"Marshall Is.",
"Wellington",
"Chatham Is.",
"Nuku'alofa",
"Samoa",
"Tokelau Is."
],
"description": "User's timezone"
},
"locale": {
"type": "string",
"enum": [
"de",
"pt_BR",
"es",
"sv_SE",
"fr",
"nl_NL",
"ja",
"gl",
"pl",
"en_GB",
"zh_TW",
"zh_CN",
"ko",
"ru",
"it",
"en",
"ca"
],
"description": "User's preferred locale"
},
"role_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"current_password": {
"type": "string",
"description": "Required when user want to change own password"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"user"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": "\n<p>Adds role &#39;Default role&#39; to the user if it is not already present.\nOnly another admin can change the admin account attribute.</p>\n"
},
"delete": {
"tags": [
"users"
],
"consumes": [
"application/json"
],
"operationId": "delete_users_id",
"summary": "Delete a user",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/": {
"get": {
"tags": [
"home"
],
"consumes": [
"application/json"
],
"operationId": "get",
"summary": "Show available API links",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/status": {
"get": {
"tags": [
"home"
],
"consumes": [
"application/json"
],
"operationId": "get_status",
"summary": "Show status",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/common_parameters": {
"get": {
"tags": [
"common_parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_common_parameters",
"summary": "List all global parameters",
"parameters": [
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"common_parameters"
],
"consumes": [
"application/json"
],
"operationId": "post_common_parameters",
"summary": "Create a global parameter",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"common_parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"hidden_value": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"name",
"value"
]
}
},
"additionalProperties": false,
"required": [
"common_parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/common_parameters/{id}": {
"get": {
"tags": [
"common_parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_common_parameters_id",
"summary": "Show a global parameter",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"common_parameters"
],
"consumes": [
"application/json"
],
"operationId": "put_common_parameters_id",
"summary": "Update a global parameter",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"common_parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"hidden_value": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"common_parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"common_parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_common_parameters_id",
"summary": "Delete a global parameter",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/plugins": {
"get": {
"tags": [
"plugins"
],
"consumes": [
"application/json"
],
"operationId": "get_plugins",
"summary": "List installed plugins",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/usergroups": {
"get": {
"tags": [
"usergroups"
],
"consumes": [
"application/json"
],
"operationId": "get_usergroups",
"summary": "List all user groups",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"usergroups"
],
"consumes": [
"application/json"
],
"operationId": "post_usergroups",
"summary": "Create a user group",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"usergroup": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"admin": {
"type": "boolean",
"description": "is an admin user group"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"usergroup_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"role_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"usergroup"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/usergroups/{id}": {
"get": {
"tags": [
"usergroups"
],
"consumes": [
"application/json"
],
"operationId": "get_usergroups_id",
"summary": "Show a user group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"usergroups"
],
"consumes": [
"application/json"
],
"operationId": "put_usergroups_id",
"summary": "Update a user group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"usergroup": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"admin": {
"type": "boolean",
"description": "is an admin user group"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"usergroup_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"role_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"usergroup"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": "\n<p>User groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the Foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.</p>\n"
},
"delete": {
"tags": [
"usergroups"
],
"consumes": [
"application/json"
],
"operationId": "delete_usergroups_id",
"summary": "Delete a user group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_class_parameters": {
"get": {
"tags": [
"smart_class_parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_class_parameters",
"summary": "List all smart class parameters",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "query"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query"
},
{
"name": "puppetclass_id",
"type": "string",
"in": "query"
},
{
"name": "environment_id",
"type": "string",
"in": "query"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/smart_class_parameters": {
"get": {
"tags": [
"smart_class_parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_smart_class_parameters",
"summary": "List of smart class parameters for a specific host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query"
},
{
"name": "puppetclass_id",
"type": "string",
"in": "query"
},
{
"name": "environment_id",
"type": "string",
"in": "query"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/smart_class_parameters": {
"get": {
"tags": [
"smart_class_parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_hostgroup_id_smart_class_parameters",
"summary": "List of smart class parameters for a specific host group",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "puppetclass_id",
"type": "string",
"in": "query"
},
{
"name": "environment_id",
"type": "string",
"in": "query"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/puppetclasses/{puppetclass_id}/smart_class_parameters": {
"get": {
"tags": [
"smart_class_parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_puppetclasses_puppetclass_id_smart_class_parameters",
"summary": "List of smart class parameters for a specific Puppet class",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "puppetclass_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "environment_id",
"type": "string",
"in": "query"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/environments/{environment_id}/smart_class_parameters": {
"get": {
"tags": [
"smart_class_parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_environments_environment_id_smart_class_parameters",
"summary": "List of smart class parameters for a specific environment",
"parameters": [
{
"name": "puppetclass_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "environment_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/environments/{environment_id}/puppetclasses/{puppetclass_id}/smart_class_parameters": {
"get": {
"tags": [
"smart_class_parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_environments_environment_id_puppetclasses_puppetclass_id_smart_class_parameters",
"summary": "List of smart class parameters for a specific environment/Puppet class combination",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "environment_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "puppetclass_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_class_parameters/{id}": {
"get": {
"tags": [
"smart_class_parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_class_parameters_id",
"summary": "Show a smart class parameter",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"smart_class_parameters"
],
"consumes": [
"application/json"
],
"operationId": "put_smart_class_parameters_id",
"summary": "Update a smart class parameter",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_class_parameter": {
"type": "object",
"properties": {
"override": {
"type": "boolean",
"description": "Whether the smart class parameter value is managed by Foreman"
},
"description": {
"type": "string",
"description": "Description of smart class"
},
"default_value": {
"type": "any_type",
"description": "Value to use when there is no match"
},
"hidden_value": {
"type": "boolean",
"description": "When enabled the parameter is hidden in the UI"
},
"use_puppet_default": {
"type": "boolean",
"description": "Deprecated, please use omit"
},
"omit": {
"type": "boolean",
"description": "Foreman will not send this parameter in classification output. Puppet will use the value defined in the Puppet manifest for this parameter"
},
"path": {
"type": "string",
"description": "The order in which values are resolved"
},
"validator_type": {
"type": "string",
"enum": [
"regexp",
"list"
],
"description": "Types of validation values"
},
"validator_rule": {
"type": "string",
"description": "Used to enforce certain values for the parameter values"
},
"override_value_order": {
"type": "string",
"description": "The order in which values are resolved"
},
"parameter_type": {
"type": "string",
"enum": [
"string",
"boolean",
"integer",
"real",
"array",
"hash",
"yaml",
"json"
],
"description": "Types of variable values"
},
"required": {
"type": "boolean",
"description": "If true, will raise an error if there is no default value and no matcher provide a value"
},
"merge_overrides": {
"type": "boolean",
"description": "Merge all matching values (only array/hash type)"
},
"merge_default": {
"type": "boolean",
"description": "Include default value when merging all matching values"
},
"avoid_duplicates": {
"type": "boolean",
"description": "Remove duplicate values (only array type)"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"smart_class_parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/architectures": {
"get": {
"tags": [
"architectures"
],
"consumes": [
"application/json"
],
"operationId": "get_architectures",
"summary": "List all architectures",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"architectures"
],
"consumes": [
"application/json"
],
"operationId": "post_architectures",
"summary": "Create an architecture",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"architecture": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"operatingsystem_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Operating system IDs"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"architecture"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/architectures": {
"get": {
"tags": [
"architectures"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_architectures",
"summary": "List all architectures for operating system",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/architectures/{id}": {
"get": {
"tags": [
"architectures"
],
"consumes": [
"application/json"
],
"operationId": "get_architectures_id",
"summary": "Show an architecture",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"architectures"
],
"consumes": [
"application/json"
],
"operationId": "put_architectures_id",
"summary": "Update an architecture",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"architecture": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"operatingsystem_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Operating system IDs"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"architecture"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"architectures"
],
"consumes": [
"application/json"
],
"operationId": "delete_architectures_id",
"summary": "Delete an architecture",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/subnets": {
"get": {
"tags": [
"subnets"
],
"consumes": [
"application/json"
],
"operationId": "get_subnets",
"summary": "List of subnets",
"parameters": [
{
"name": "domain_id",
"type": "string",
"in": "query",
"description": "ID of domain"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"subnets"
],
"consumes": [
"application/json"
],
"operationId": "post_subnets",
"summary": "Create a subnet",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"subnet": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Subnet name"
},
"description": {
"type": "string",
"description": "Subnet description"
},
"network_type": {
"type": "string",
"enum": [
"IPv4",
"IPv6"
],
"description": "Type or protocol, IPv4 or IPv6, defaults to IPv4"
},
"network": {
"type": "string",
"description": "Subnet network"
},
"mask": {
"type": "string",
"description": "Netmask for this subnet"
},
"gateway": {
"type": "string",
"description": "Subnet gateway"
},
"dns_primary": {
"type": "string",
"description": "Primary DNS for this subnet"
},
"dns_secondary": {
"type": "string",
"description": "Secondary DNS for this subnet"
},
"ipam": {
"type": "string",
"description": "IP Address auto suggestion mode for this subnet, valid values are \"DHCP\", \"Internal DB\", \"None\""
},
"from": {
"type": "string",
"description": "Starting IP Address for IP auto suggestion"
},
"to": {
"type": "string",
"description": "Ending IP Address for IP auto suggestion"
},
"vlanid": {
"type": "string",
"description": "VLAN ID for this subnet"
},
"mtu": {
"type": "number",
"description": "MTU for this subnet"
},
"domain_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Domains in which this subnet is part"
},
"dhcp_id": {
"type": "number",
"description": "DHCP Proxy ID to use within this subnet"
},
"tftp_id": {
"type": "number",
"description": "TFTP Proxy ID to use within this subnet"
},
"httpboot_id": {
"type": "number",
"description": "HTTPBoot Proxy ID to use within this subnet"
},
"dns_id": {
"type": "number",
"description": "DNS Proxy ID to use within this subnet"
},
"template_id": {
"type": "number",
"description": "Template HTTP(S) Proxy ID to use within this subnet"
},
"boot_mode": {
"type": "string",
"description": "Default boot mode for interfaces assigned to this subnet, valid values are \"Static\", \"DHCP\""
},
"subnet_parameters_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of parameters (name, value)"
}
},
"additionalProperties": false,
"required": [
"name",
"network",
"mask"
]
}
},
"additionalProperties": false,
"required": [
"subnet"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/domains/{domain_id}/subnets": {
"get": {
"tags": [
"subnets"
],
"consumes": [
"application/json"
],
"operationId": "get_domains_domain_id_subnets",
"summary": "List of subnets for a domain",
"parameters": [
{
"name": "domain_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of domain"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/subnets": {
"get": {
"tags": [
"subnets"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_subnets",
"summary": "List of subnets per location",
"parameters": [
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of domain"
},
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/subnets": {
"get": {
"tags": [
"subnets"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_subnets",
"summary": "List of subnets per organization",
"parameters": [
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of domain"
},
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/subnets/{id}": {
"get": {
"tags": [
"subnets"
],
"consumes": [
"application/json"
],
"operationId": "get_subnets_id",
"summary": "Show a subnet",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden_parameters",
"type": "boolean",
"in": "query",
"description": "Display hidden parameter values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"subnets"
],
"consumes": [
"application/json"
],
"operationId": "put_subnets_id",
"summary": "Update a subnet",
"parameters": [
{
"name": "id",
"type": "number",
"in": "path",
"required": true,
"description": "Subnet numeric identifier"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"subnet": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Subnet name"
},
"description": {
"type": "string",
"description": "Subnet description"
},
"network_type": {
"type": "string",
"enum": [
"IPv4",
"IPv6"
],
"description": "Type or protocol, IPv4 or IPv6, defaults to IPv4"
},
"network": {
"type": "string",
"description": "Subnet network"
},
"mask": {
"type": "string",
"description": "Netmask for this subnet"
},
"gateway": {
"type": "string",
"description": "Subnet gateway"
},
"dns_primary": {
"type": "string",
"description": "Primary DNS for this subnet"
},
"dns_secondary": {
"type": "string",
"description": "Secondary DNS for this subnet"
},
"ipam": {
"type": "string",
"description": "IP Address auto suggestion mode for this subnet, valid values are \"DHCP\", \"Internal DB\", \"None\""
},
"from": {
"type": "string",
"description": "Starting IP Address for IP auto suggestion"
},
"to": {
"type": "string",
"description": "Ending IP Address for IP auto suggestion"
},
"vlanid": {
"type": "string",
"description": "VLAN ID for this subnet"
},
"mtu": {
"type": "number",
"description": "MTU for this subnet"
},
"domain_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Domains in which this subnet is part"
},
"dhcp_id": {
"type": "number",
"description": "DHCP Proxy ID to use within this subnet"
},
"tftp_id": {
"type": "number",
"description": "TFTP Proxy ID to use within this subnet"
},
"httpboot_id": {
"type": "number",
"description": "HTTPBoot Proxy ID to use within this subnet"
},
"dns_id": {
"type": "number",
"description": "DNS Proxy ID to use within this subnet"
},
"template_id": {
"type": "number",
"description": "Template HTTP(S) Proxy ID to use within this subnet"
},
"boot_mode": {
"type": "string",
"description": "Default boot mode for interfaces assigned to this subnet, valid values are \"Static\", \"DHCP\""
},
"subnet_parameters_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of parameters (name, value)"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"subnet"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"subnets"
],
"consumes": [
"application/json"
],
"operationId": "delete_subnets_id",
"summary": "Delete a subnet",
"parameters": [
{
"name": "id",
"type": "number",
"in": "path",
"required": true,
"description": "Subnet numeric identifier"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/subnets/{id}/freeip": {
"get": {
"tags": [
"subnets"
],
"consumes": [
"application/json"
],
"operationId": "get_subnets_id_freeip",
"summary": "Provides an unused IP address in this subnet",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "mac",
"type": "string",
"in": "query",
"description": "MAC address to reuse the IP for this host"
},
{
"name": "excluded_ips",
"type": "array",
"items": {
"type": "string"
},
"in": "query",
"description": "IP addresses that should be excluded from suggestion"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/settings": {
"get": {
"tags": [
"settings"
],
"consumes": [
"application/json"
],
"operationId": "get_settings",
"summary": "List all settings",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/settings/{id}": {
"get": {
"tags": [
"settings"
],
"consumes": [
"application/json"
],
"operationId": "get_settings_id",
"summary": "Show a setting",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"settings"
],
"consumes": [
"application/json"
],
"operationId": "put_settings_id",
"summary": "Update a setting",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"setting": {
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"setting"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_sources": {
"get": {
"tags": [
"auth_sources"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_sources",
"summary": "List all authentication sources",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/auth_sources": {
"get": {
"tags": [
"auth_sources"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_auth_sources",
"summary": "List all authentication sources per location",
"parameters": [
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/auth_sources": {
"get": {
"tags": [
"auth_sources"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_auth_sources",
"summary": "List all authentication sources per organization",
"parameters": [
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/models": {
"get": {
"tags": [
"models"
],
"consumes": [
"application/json"
],
"operationId": "get_models",
"summary": "List all hardware models",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"models"
],
"consumes": [
"application/json"
],
"operationId": "post_models",
"summary": "Create a hardware model",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"model": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"info": {
"type": "string"
},
"vendor_class": {
"type": "string"
},
"hardware_model": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"model"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/models/{id}": {
"get": {
"tags": [
"models"
],
"consumes": [
"application/json"
],
"operationId": "get_models_id",
"summary": "Show a hardware model",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"models"
],
"consumes": [
"application/json"
],
"operationId": "put_models_id",
"summary": "Update a hardware model",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"model": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"info": {
"type": "string"
},
"vendor_class": {
"type": "string"
},
"hardware_model": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"model"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"models"
],
"consumes": [
"application/json"
],
"operationId": "delete_models_id",
"summary": "Delete a hardware model",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/media": {
"get": {
"tags": [
"media"
],
"consumes": [
"application/json"
],
"operationId": "get_media",
"summary": "List all installation media",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"media"
],
"consumes": [
"application/json"
],
"operationId": "post_media",
"summary": "Create a medium",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"medium": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of media"
},
"path": {
"type": "string",
"description": "The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\n\nfor example http://mirror.centos.org/centos/$version/os/$arch\nwhere $arch will be substituted for the host's actual OS architecture and $version, $major and $minor\nwill be substituted for the version of the operating system.\n\nSolaris and Debian media may also use $release.\n"
},
"os_family": {
"type": "string",
"description": "Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris, Suse, Windows, Xenserver"
},
"operatingsystem_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"name",
"path"
]
}
},
"additionalProperties": false,
"required": [
"medium"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/media": {
"get": {
"tags": [
"media"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_media",
"summary": "List all media for an operating system",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/media": {
"get": {
"tags": [
"media"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_media",
"summary": "List all media per location",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/media": {
"get": {
"tags": [
"media"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_media",
"summary": "List all media per organization",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/media/{id}": {
"get": {
"tags": [
"media"
],
"consumes": [
"application/json"
],
"operationId": "get_media_id",
"summary": "Show a medium",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"media"
],
"consumes": [
"application/json"
],
"operationId": "put_media_id",
"summary": "Update a medium",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"medium": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of media"
},
"path": {
"type": "string",
"description": "The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).\n\nfor example http://mirror.centos.org/centos/$version/os/$arch\nwhere $arch will be substituted for the host's actual OS architecture and $version, $major and $minor\nwill be substituted for the version of the operating system.\n\nSolaris and Debian media may also use $release.\n"
},
"os_family": {
"type": "string",
"description": "Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris, Suse, Windows, Xenserver"
},
"operatingsystem_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"medium"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"media"
],
"consumes": [
"application/json"
],
"operationId": "delete_media_id",
"summary": "Delete a medium",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_templates/{config_template_id}/template_combinations": {
"get": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "get_config_templates_config_template_id_template_combinations",
"summary": "List template combination",
"parameters": [
{
"name": "config_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of config template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"description": "ID of config template"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "post_config_templates_config_template_id_template_combinations",
"summary": "Add a template combination",
"parameters": [
{
"name": "config_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of config template"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"provisioning_template_id": {
"type": "string",
"description": "ID of config template"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"environment_id": {
"type": "string",
"description": "ID of environment"
},
"template_combination": {
"type": "object",
"properties": {
"environment_id": {
"type": "number",
"description": "environment id"
},
"hostgroup_id": {
"type": "number",
"description": "host group id"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"template_combination"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates/{provisioning_template_id}/template_combinations": {
"get": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "get_provisioning_templates_provisioning_template_id_template_combinations",
"summary": "List template combination",
"parameters": [
{
"name": "config_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of config template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of config template"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "post_provisioning_templates_provisioning_template_id_template_combinations",
"summary": "Add a template combination",
"parameters": [
{
"name": "provisioning_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of config template"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_template_id": {
"type": "string",
"description": "ID of config template"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"environment_id": {
"type": "string",
"description": "ID of environment"
},
"template_combination": {
"type": "object",
"properties": {
"environment_id": {
"type": "number",
"description": "environment id"
},
"hostgroup_id": {
"type": "number",
"description": "host group id"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"config_template_id",
"template_combination"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/template_combinations": {
"get": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_hostgroup_id_template_combinations",
"summary": "List template combination",
"parameters": [
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of config template"
},
{
"name": "config_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of config template"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "post_hostgroups_hostgroup_id_template_combinations",
"summary": "Add a template combination",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_template_id": {
"type": "string",
"description": "ID of config template"
},
"provisioning_template_id": {
"type": "string",
"description": "ID of config template"
},
"environment_id": {
"type": "string",
"description": "ID of environment"
},
"template_combination": {
"type": "object",
"properties": {
"environment_id": {
"type": "number",
"description": "environment id"
},
"hostgroup_id": {
"type": "number",
"description": "host group id"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"config_template_id",
"provisioning_template_id",
"template_combination"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/environments/{environment_id}/template_combinations": {
"get": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "get_environments_environment_id_template_combinations",
"summary": "List template combination",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of config template"
},
{
"name": "config_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of config template"
},
{
"name": "environment_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "post_environments_environment_id_template_combinations",
"summary": "Add a template combination",
"parameters": [
{
"name": "environment_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of environment"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_template_id": {
"type": "string",
"description": "ID of config template"
},
"provisioning_template_id": {
"type": "string",
"description": "ID of config template"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"template_combination": {
"type": "object",
"properties": {
"environment_id": {
"type": "number",
"description": "environment id"
},
"hostgroup_id": {
"type": "number",
"description": "host group id"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"config_template_id",
"provisioning_template_id",
"hostgroup_id",
"template_combination"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/template_combinations/{id}": {
"get": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "get_template_combinations_id",
"summary": "Show template combination",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "config_template_id",
"type": "string",
"in": "query",
"description": "ID of config template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"description": "ID of config template"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "delete_template_combinations_id",
"summary": "Delete a template combination",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_templates/{config_template_id}/template_combinations/{id}": {
"get": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "get_config_templates_config_template_id_template_combinations_id",
"summary": "Show template combination",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "config_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of config template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"description": "ID of config template"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "put_config_templates_config_template_id_template_combinations_id",
"summary": "Update template combination",
"parameters": [
{
"name": "config_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of config template"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"provisioning_template_id": {
"type": "string",
"description": "ID of config template"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"environment_id": {
"type": "string",
"description": "ID of environment"
},
"template_combination": {
"type": "object",
"properties": {
"environment_id": {
"type": "number",
"description": "environment id"
},
"hostgroup_id": {
"type": "number",
"description": "host group id"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"provisioning_template_id",
"template_combination"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates/{provisioning_template_id}/template_combinations/{id}": {
"get": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "get_provisioning_templates_provisioning_template_id_template_combinations_id",
"summary": "Show template combination",
"parameters": [
{
"name": "config_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of config template"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of config template"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "put_provisioning_templates_provisioning_template_id_template_combinations_id",
"summary": "Update template combination",
"parameters": [
{
"name": "provisioning_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of config template"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_template_id": {
"type": "string",
"description": "ID of config template"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"environment_id": {
"type": "string",
"description": "ID of environment"
},
"template_combination": {
"type": "object",
"properties": {
"environment_id": {
"type": "number",
"description": "environment id"
},
"hostgroup_id": {
"type": "number",
"description": "host group id"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"template_combination"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/template_combinations/{id}": {
"get": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_hostgroup_id_template_combinations_id",
"summary": "Show template combination",
"parameters": [
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of config template"
},
{
"name": "config_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of config template"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "environment_id",
"type": "string",
"in": "query",
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "put_hostgroups_hostgroup_id_template_combinations_id",
"summary": "Update template combination",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_template_id": {
"type": "string",
"description": "ID of config template"
},
"provisioning_template_id": {
"type": "string",
"description": "ID of config template"
},
"environment_id": {
"type": "string",
"description": "ID of environment"
},
"template_combination": {
"type": "object",
"properties": {
"environment_id": {
"type": "number",
"description": "environment id"
},
"hostgroup_id": {
"type": "number",
"description": "host group id"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"config_template_id",
"provisioning_template_id",
"template_combination"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/environments/{environment_id}/template_combinations/{id}": {
"get": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "get_environments_environment_id_template_combinations_id",
"summary": "Show template combination",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of config template"
},
{
"name": "config_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of config template"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "environment_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of environment"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"template_combinations"
],
"consumes": [
"application/json"
],
"operationId": "put_environments_environment_id_template_combinations_id",
"summary": "Update template combination",
"parameters": [
{
"name": "environment_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of environment"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_template_id": {
"type": "string",
"description": "ID of config template"
},
"provisioning_template_id": {
"type": "string",
"description": "ID of config template"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"template_combination": {
"type": "object",
"properties": {
"environment_id": {
"type": "number",
"description": "environment id"
},
"hostgroup_id": {
"type": "number",
"description": "host group id"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"config_template_id",
"provisioning_template_id",
"hostgroup_id",
"template_combination"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_templates": {
"get": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_config_templates",
"summary": "List provisioning templates",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_config_templates",
"summary": "Create a provisioning template",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
},
"template": {
"type": "string"
},
"snippet": {
"type": "boolean"
},
"audit_comment": {
"type": "string"
},
"template_kind_id": {
"type": "number",
"description": "not relevant for snippet"
},
"template_combinations_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of template combinations (hostgroup_id, environment_id)"
},
"operatingsystem_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of operating system IDs to associate with the template"
},
"locked": {
"type": "boolean",
"description": "Whether or not the template is locked for editing"
}
},
"additionalProperties": false,
"required": [
"name",
"template"
]
}
},
"additionalProperties": false,
"required": [
"config_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/config_templates": {
"get": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_config_templates",
"summary": "List provisioning templates per operating system",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/config_templates": {
"get": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_config_templates",
"summary": "List provisioning templates per location",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/config_templates": {
"get": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_config_templates",
"summary": "List provisioning templates per organization",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_templates/{id}": {
"get": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_config_templates_id",
"summary": "Show provisioning template details",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "put_config_templates_id",
"summary": "Update a provisioning template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
},
"template": {
"type": "string"
},
"snippet": {
"type": "boolean"
},
"audit_comment": {
"type": "string"
},
"template_kind_id": {
"type": "number",
"description": "not relevant for snippet"
},
"template_combinations_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of template combinations (hostgroup_id, environment_id)"
},
"operatingsystem_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of operating system IDs to associate with the template"
},
"locked": {
"type": "boolean",
"description": "Whether or not the template is locked for editing"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"config_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "delete_config_templates_id",
"summary": "Delete a provisioning template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_templates/revision": {
"get": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_config_templates_revision",
"parameters": [
{
"name": "version",
"type": "string",
"in": "query",
"description": "template version"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_templates/build_pxe_default": {
"post": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_config_templates_build_pxe_default",
"summary": "Update the default PXE menu on all configured TFTP servers",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_templates/{id}/clone": {
"post": {
"tags": [
"config_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_config_templates_id_clone",
"summary": "Clone a provision template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"config_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/users/{user_id}/personal_access_tokens": {
"get": {
"tags": [
"personal_access_tokens"
],
"consumes": [
"application/json"
],
"operationId": "get_users_user_id_personal_access_tokens",
"summary": "List all Personal Access Tokens for a user",
"parameters": [
{
"name": "user_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the user"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"personal_access_tokens"
],
"consumes": [
"application/json"
],
"operationId": "post_users_user_id_personal_access_tokens",
"summary": "Create a Personal Access Token for a user",
"parameters": [
{
"name": "user_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the user"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"personal_access_token": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"expires_at": {
"type": "string",
"description": "Expiry Date"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"personal_access_token"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/users/{user_id}/personal_access_tokens/{id}": {
"get": {
"tags": [
"personal_access_tokens"
],
"consumes": [
"application/json"
],
"operationId": "get_users_user_id_personal_access_tokens_id",
"summary": "Show a Personal Access Token for a user",
"parameters": [
{
"name": "user_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the user"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"personal_access_tokens"
],
"consumes": [
"application/json"
],
"operationId": "delete_users_user_id_personal_access_tokens_id",
"summary": "Revoke a Personal Access Token for a user",
"parameters": [
{
"name": "user_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the user"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/roles": {
"get": {
"tags": [
"roles"
],
"consumes": [
"application/json"
],
"operationId": "get_roles",
"summary": "List all roles",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"roles"
],
"consumes": [
"application/json"
],
"operationId": "post_roles",
"summary": "Create a role",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"role": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"description": "Role description"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"role"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/roles/{id}": {
"get": {
"tags": [
"roles"
],
"consumes": [
"application/json"
],
"operationId": "get_roles_id",
"summary": "Show a role",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "description",
"type": "string",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"roles"
],
"consumes": [
"application/json"
],
"operationId": "put_roles_id",
"summary": "Update a role",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"role": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"description": "Role description"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"role"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"roles"
],
"consumes": [
"application/json"
],
"operationId": "delete_roles_id",
"summary": "Delete a role",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/roles/{id}/clone": {
"post": {
"tags": [
"roles"
],
"consumes": [
"application/json"
],
"operationId": "post_roles_id_clone",
"summary": "Clone a role",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"role": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"description": "Role description"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"role"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_proxies": {
"get": {
"tags": [
"smart_proxies"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_proxies",
"summary": "List all smart proxies",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"smart_proxies"
],
"consumes": [
"application/json"
],
"operationId": "post_smart_proxies",
"summary": "Create a smart proxy",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_proxy": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"url"
]
}
},
"additionalProperties": false,
"required": [
"smart_proxy"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_proxies/{id}": {
"get": {
"tags": [
"smart_proxies"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_proxies_id",
"summary": "Show a smart proxy",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"smart_proxies"
],
"consumes": [
"application/json"
],
"operationId": "put_smart_proxies_id",
"summary": "Update a smart proxy",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_proxy": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"smart_proxy"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"smart_proxies"
],
"consumes": [
"application/json"
],
"operationId": "delete_smart_proxies_id",
"summary": "Delete a smart proxy",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_proxies/{id}/refresh": {
"put": {
"tags": [
"smart_proxies"
],
"consumes": [
"application/json"
],
"operationId": "put_smart_proxies_id_refresh",
"summary": "Refresh smart proxy features",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_groups": {
"get": {
"tags": [
"config_groups"
],
"consumes": [
"application/json"
],
"operationId": "get_config_groups",
"summary": "List of config groups",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"config_groups"
],
"consumes": [
"application/json"
],
"operationId": "post_config_groups",
"summary": "Create a config group",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_group": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"puppetclass_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"config_group"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_groups/{id}": {
"get": {
"tags": [
"config_groups"
],
"consumes": [
"application/json"
],
"operationId": "get_config_groups_id",
"summary": "Show a config group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"config_groups"
],
"consumes": [
"application/json"
],
"operationId": "put_config_groups_id",
"summary": "Update a config group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_group": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"puppetclass_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"config_group"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"config_groups"
],
"consumes": [
"application/json"
],
"operationId": "delete_config_groups_id",
"summary": "Delete a config group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ptables": {
"get": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "get_ptables",
"summary": "List all partition tables",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "post_ptables",
"summary": "Create a partition table",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"ptable": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"layout": {
"type": "string"
},
"snippet": {
"type": "boolean"
},
"audit_comment": {
"type": "string"
},
"locked": {
"type": "boolean",
"description": "Whether or not the template is locked for editing"
},
"os_family": {
"type": "string"
},
"operatingsystem_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of operating system IDs to associate with the partition table"
},
"host_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of host IDs to associate with the partition table"
},
"hostgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of host group IDs to associate with the partition table"
}
},
"additionalProperties": false,
"required": [
"name",
"layout"
]
}
},
"additionalProperties": false,
"required": [
"ptable"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/ptables": {
"get": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_ptables",
"summary": "List all partition tables for an operating system",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/ptables": {
"get": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_ptables",
"summary": "List all partition tables per location",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/ptables": {
"get": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_ptables",
"summary": "List all partition tables per organization",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ptables/{id}": {
"get": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "get_ptables_id",
"summary": "Show a partition table",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "put_ptables_id",
"summary": "Update a partition table",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"ptable": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"layout": {
"type": "string"
},
"snippet": {
"type": "boolean"
},
"audit_comment": {
"type": "string"
},
"locked": {
"type": "boolean",
"description": "Whether or not the template is locked for editing"
},
"os_family": {
"type": "string"
},
"operatingsystem_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of operating system IDs to associate with the partition table"
},
"host_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of host IDs to associate with the partition table"
},
"hostgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of host group IDs to associate with the partition table"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"ptable"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "delete_ptables_id",
"summary": "Delete a partition table",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ptables/import": {
"post": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "post_ptables_import",
"summary": "Import a provisioning template",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"ptable": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
},
"template": {
"type": "string",
"description": "template contents including metadata"
}
},
"additionalProperties": false
},
"options": {
"type": "object",
"properties": {
"force": {
"type": "boolean",
"description": "use if you want update locked templates"
},
"associate": {
"type": "string",
"enum": [
"new",
"always",
"never"
],
"description": "determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata"
},
"lock": {
"type": "boolean",
"description": "lock imported templates (false by default)"
},
"default": {
"type": "boolean",
"description": "makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"ptable"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ptables/revision": {
"get": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "get_ptables_revision",
"parameters": [
{
"name": "version",
"type": "string",
"in": "query",
"description": "template version"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ptables/{id}/clone": {
"post": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "post_ptables_id_clone",
"summary": "Clone a template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"ptable": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"ptable"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ptables/{id}/export": {
"get": {
"tags": [
"ptables"
],
"consumes": [
"application/json"
],
"operationId": "get_ptables_id_export",
"summary": "Export a partition template to ERB",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/parameters": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_parameters",
"summary": "List all parameters for a host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"description": "ID of domain"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "post_hosts_host_id_parameters",
"summary": "Create a nested parameter for a host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"value"
]
}
},
"additionalProperties": false,
"required": [
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_hosts_host_id_parameters",
"summary": "Delete all nested parameters for a host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/parameters": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_hostgroup_id_parameters",
"summary": "List all parameters for a host group",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"description": "ID of domain"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "post_hostgroups_hostgroup_id_parameters",
"summary": "Create a nested parameter for a host group",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"value"
]
}
},
"additionalProperties": false,
"required": [
"host_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_hostgroups_hostgroup_id_parameters",
"summary": "Delete all nested parameters for a host group",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false,
"required": [
"host_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/domains/{domain_id}/parameters": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_domains_domain_id_parameters",
"summary": "List all parameters for a domain",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "domain_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of domain"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "post_domains_domain_id_parameters",
"summary": "Create a nested parameter for a domain",
"parameters": [
{
"name": "domain_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of domain"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"value"
]
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_domains_domain_id_parameters",
"summary": "Delete all nested parameters for a domain",
"parameters": [
{
"name": "domain_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of domain"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/parameters": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_parameters",
"summary": "List all parameters for an operating system",
"parameters": [
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of domain"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "post_operatingsystems_operatingsystem_id_parameters",
"summary": "Create a nested parameter for an operating system",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"value"
]
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_operatingsystems_operatingsystem_id_parameters",
"summary": "Delete all nested parameters for an operating system",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/parameters": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_parameters",
"summary": "List all parameters for a location",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of domain"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "location_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "post_locations_location_id_parameters",
"summary": "Create a nested parameter for a location",
"parameters": [
{
"name": "location_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of location"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"value"
]
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_locations_location_id_parameters",
"summary": "Delete all nested parameter for a location",
"parameters": [
{
"name": "location_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of location"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/parameters": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_parameters",
"summary": "List all parameters for an organization",
"parameters": [
{
"name": "location_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of location"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of domain"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "organization_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "post_organizations_organization_id_parameters",
"summary": "Create a nested parameter for an organization",
"parameters": [
{
"name": "organization_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of organization"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"value"
]
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id",
"location_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_organizations_organization_id_parameters",
"summary": "Delete all nested parameter for an organization",
"parameters": [
{
"name": "organization_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of organization"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id",
"location_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/subnets/{subnet_id}/parameters": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_subnets_subnet_id_parameters",
"summary": "List all parameters for a subnet",
"parameters": [
{
"name": "organization_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of organization"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of location"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of domain"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "subnet_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "post_subnets_subnet_id_parameters",
"summary": "Create a nested parameter for a subnet",
"parameters": [
{
"name": "subnet_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of subnet"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"value"
]
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id",
"location_id",
"organization_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_subnets_subnet_id_parameters",
"summary": "Delete all nested parameters for a subnet",
"parameters": [
{
"name": "subnet_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of subnet"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id",
"location_id",
"organization_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/parameters/{id}": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_parameters_id",
"summary": "Show a nested parameter for a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"description": "ID of host group"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"description": "ID of domain"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "put_hosts_host_id_parameters_id",
"summary": "Update a nested parameter for a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_hosts_host_id_parameters_id",
"summary": "Delete a nested parameter for a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/parameters/{id}": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_hostgroup_id_parameters_id",
"summary": "Show a nested parameter for a host group",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"description": "ID of domain"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "put_hostgroups_hostgroup_id_parameters_id",
"summary": "Update a nested parameter for a host group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"host_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_hostgroups_hostgroup_id_parameters_id",
"summary": "Delete a nested parameter for a host group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false,
"required": [
"host_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/domains/{domain_id}/parameters/{id}": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_domains_domain_id_parameters_id",
"summary": "Show a nested parameter for a domain",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "domain_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of domain"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "put_domains_domain_id_parameters_id",
"summary": "Update a nested parameter for a domain",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "domain_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of domain"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_domains_domain_id_parameters_id",
"summary": "Delete a nested parameter for a domain",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "domain_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of domain"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/parameters/{id}": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_parameters_id",
"summary": "Show a nested parameter for an operating system",
"parameters": [
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of domain"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "put_operatingsystems_operatingsystem_id_parameters_id",
"summary": "Update a nested parameter for an operating system",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_operatingsystems_operatingsystem_id_parameters_id",
"summary": "Delete a nested parameter for an operating system",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/parameters/{id}": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_parameters_id",
"summary": "Show a nested parameter for a location",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of domain"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "location_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of location"
},
{
"name": "organization_id",
"type": "string",
"in": "query",
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "put_locations_location_id_parameters_id",
"summary": "Update a nested parameter for a location",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "location_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of location"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_locations_location_id_parameters_id",
"summary": "Delete a nested parameter for a location",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "location_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of location"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/parameters/{id}": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_parameters_id",
"summary": "Show a nested parameter for an organization",
"parameters": [
{
"name": "location_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of location"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of domain"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "organization_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of organization"
},
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "put_organizations_organization_id_parameters_id",
"summary": "Update a nested parameter for an organization",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "organization_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of organization"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id",
"location_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_organizations_organization_id_parameters_id",
"summary": "Delete a nested parameter for an organization",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "organization_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of organization"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"subnet_id": {
"type": "string",
"description": "ID of subnet"
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id",
"location_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/subnets/{subnet_id}/parameters/{id}": {
"get": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "get_subnets_subnet_id_parameters_id",
"summary": "Show a nested parameter for a subnet",
"parameters": [
{
"name": "organization_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of organization"
},
{
"name": "location_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of location"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "domain_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of domain"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host group"
},
{
"name": "host_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of host"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "subnet_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of subnet"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "put_subnets_subnet_id_parameters_id",
"summary": "Update a nested parameter for a subnet",
"parameters": [
{
"name": "subnet_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of subnet"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
},
"parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id",
"location_id",
"organization_id",
"parameter"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"parameters"
],
"consumes": [
"application/json"
],
"operationId": "delete_subnets_subnet_id_parameters_id",
"summary": "Delete a nested parameter for a subnet",
"parameters": [
{
"name": "subnet_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of subnet"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of parameter"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"host_id": {
"type": "string",
"description": "ID of host"
},
"hostgroup_id": {
"type": "string",
"description": "ID of host group"
},
"domain_id": {
"type": "string",
"description": "ID of domain"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"location_id": {
"type": "string",
"description": "ID of location"
},
"organization_id": {
"type": "string",
"description": "ID of organization"
}
},
"additionalProperties": false,
"required": [
"host_id",
"hostgroup_id",
"domain_id",
"operatingsystem_id",
"location_id",
"organization_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/trends": {
"get": {
"tags": [
"trends"
],
"consumes": [
"application/json"
],
"operationId": "get_trends",
"summary": "List of trends counters",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"trends"
],
"consumes": [
"application/json"
],
"operationId": "post_trends",
"summary": "Create a trend counter",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"trendable_type": {
"type": "string"
},
"fact_name": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"trendable_type"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/trends/{id}": {
"get": {
"tags": [
"trends"
],
"consumes": [
"application/json"
],
"operationId": "get_trends_id",
"summary": "Show a trend",
"parameters": [
{
"name": "trend_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "id",
"type": "number",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"trends"
],
"consumes": [
"application/json"
],
"operationId": "delete_trends_id",
"summary": "Delete a trend counter",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/mail_notifications": {
"get": {
"tags": [
"mail_notifications"
],
"consumes": [
"application/json"
],
"operationId": "get_mail_notifications",
"summary": "List of email notifications",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/mail_notifications/{id}": {
"get": {
"tags": [
"mail_notifications"
],
"consumes": [
"application/json"
],
"operationId": "get_mail_notifications_id",
"summary": "Show an email notification",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "Numerical ID or email notification name"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{compute_resource_id}/images": {
"get": {
"tags": [
"images"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_compute_resource_id_images",
"summary": "List all images for a compute resource",
"parameters": [
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of compute resource"
},
{
"name": "architecture_id",
"type": "string",
"in": "query",
"description": "ID of architecture"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"images"
],
"consumes": [
"application/json"
],
"operationId": "post_compute_resources_compute_resource_id_images",
"summary": "Create an image",
"parameters": [
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"image": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"uuid": {
"type": "string"
},
"password": {
"type": "string"
},
"compute_resource_id": {
"type": "string",
"description": "ID of compute resource"
},
"architecture_id": {
"type": "string",
"description": "ID of architecture"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"user_data": {
"type": "boolean",
"description": "Whether or not the image supports user data"
}
},
"additionalProperties": false,
"required": [
"name",
"username",
"uuid"
]
}
},
"additionalProperties": false,
"required": [
"image"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/images": {
"get": {
"tags": [
"images"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_images",
"summary": "List all images for operating system",
"parameters": [
{
"name": "compute_resource_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of compute resource"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "architecture_id",
"type": "string",
"in": "query",
"description": "ID of architecture"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/architectures/{architecture_id}/images": {
"get": {
"tags": [
"images"
],
"consumes": [
"application/json"
],
"operationId": "get_architectures_architecture_id_images",
"summary": "List all images for architecture",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "compute_resource_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of compute resource"
},
{
"name": "architecture_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of architecture"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{compute_resource_id}/images/{id}": {
"get": {
"tags": [
"images"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_compute_resource_id_images_id",
"summary": "Show an image",
"parameters": [
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of compute resource"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "architecture_id",
"type": "string",
"in": "query",
"description": "ID of architecture"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"description": "ID of operating system"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"images"
],
"consumes": [
"application/json"
],
"operationId": "put_compute_resources_compute_resource_id_images_id",
"summary": "Update an image",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"image": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"uuid": {
"type": "string"
},
"password": {
"type": "string"
},
"compute_resource_id": {
"type": "string",
"description": "ID of compute resource"
},
"architecture_id": {
"type": "string",
"description": "ID of architecture"
},
"operatingsystem_id": {
"type": "string",
"description": "ID of operating system"
},
"user_data": {
"type": "boolean",
"description": "Whether or not the image supports user data"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"image"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"images"
],
"consumes": [
"application/json"
],
"operationId": "delete_compute_resources_compute_resource_id_images_id",
"summary": "Delete an image",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{operatingsystem_id}/images/{id}": {
"get": {
"tags": [
"images"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_operatingsystem_id_images_id",
"summary": "Show an image",
"parameters": [
{
"name": "compute_resource_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of compute resource"
},
{
"name": "operatingsystem_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of operating system"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "architecture_id",
"type": "string",
"in": "query",
"description": "ID of architecture"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/architectures/{architecture_id}/images/{id}": {
"get": {
"tags": [
"images"
],
"consumes": [
"application/json"
],
"operationId": "get_architectures_architecture_id_images_id",
"summary": "Show an image",
"parameters": [
{
"name": "operatingsystem_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of operating system"
},
{
"name": "compute_resource_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of compute resource"
},
{
"name": "architecture_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of architecture"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_profiles": {
"get": {
"tags": [
"compute_profiles"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_profiles",
"summary": "List of compute profiles",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"compute_profiles"
],
"consumes": [
"application/json"
],
"operationId": "post_compute_profiles",
"summary": "Create a compute profile",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_profile": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"compute_profile"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_profiles/{id}": {
"get": {
"tags": [
"compute_profiles"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_profiles_id",
"summary": "Show a compute profile",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"compute_profiles"
],
"consumes": [
"application/json"
],
"operationId": "put_compute_profiles_id",
"summary": "Update a compute profile",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_profile": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"compute_profile"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"compute_profiles"
],
"consumes": [
"application/json"
],
"operationId": "delete_compute_profiles_id",
"summary": "Delete a compute profile",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/statistics": {
"get": {
"tags": [
"statistics"
],
"consumes": [
"application/json"
],
"operationId": "get_statistics",
"summary": "Get statistics",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/report_templates": {
"get": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_report_templates",
"summary": "List all report templates",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_report_templates",
"summary": "Create a report template",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"report_template": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"template": {
"type": "string"
},
"snippet": {
"type": "boolean"
},
"audit_comment": {
"type": "string"
},
"locked": {
"type": "boolean",
"description": "Whether or not the template is locked for editing"
},
"default": {
"type": "boolean",
"description": "Whether or not the template is added automatically to new organizations and locations"
}
},
"additionalProperties": false,
"required": [
"name",
"template"
]
}
},
"additionalProperties": false,
"required": [
"report_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/report_templates": {
"get": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_report_templates",
"summary": "List all report templates per location",
"parameters": [
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/report_templates": {
"get": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_report_templates",
"summary": "List all report templates per organization",
"parameters": [
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/report_templates/{id}": {
"get": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_report_templates_id",
"summary": "Show a report template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "put_report_templates_id",
"summary": "Update a report template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"report_template": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"template": {
"type": "string"
},
"snippet": {
"type": "boolean"
},
"audit_comment": {
"type": "string"
},
"locked": {
"type": "boolean",
"description": "Whether or not the template is locked for editing"
},
"default": {
"type": "boolean",
"description": "Whether or not the template is added automatically to new organizations and locations"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"report_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "delete_report_templates_id",
"summary": "Delete a report template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/report_templates/import": {
"post": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_report_templates_import",
"summary": "Import a report template",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"report_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
},
"template": {
"type": "string",
"description": "template contents including metadata"
}
},
"additionalProperties": false
},
"options": {
"type": "object",
"properties": {
"force": {
"type": "boolean",
"description": "use if you want update locked templates"
},
"associate": {
"type": "string",
"enum": [
"new",
"always",
"never"
],
"description": "determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata"
},
"lock": {
"type": "boolean",
"description": "lock imported templates (false by default)"
},
"default": {
"type": "boolean",
"description": "makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"report_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/report_templates/revision": {
"get": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_report_templates_revision",
"parameters": [
{
"name": "version",
"type": "string",
"in": "query",
"description": "template version"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/report_templates/{id}/clone": {
"post": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_report_templates_id_clone",
"summary": "Clone a template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"report_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "template name"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"report_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/report_templates/{id}/export": {
"get": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_report_templates_id_export",
"summary": "Export a report template to ERB",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/report_templates/{id}/generate": {
"post": {
"tags": [
"report_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_report_templates_id_generate",
"summary": "Generate a report template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"input_values": {
"type": "object",
"additionalProperties": true,
"description": "Hash of input values where key is the name of input, value is the value for this input"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/bookmarks": {
"get": {
"tags": [
"bookmarks"
],
"consumes": [
"application/json"
],
"operationId": "get_bookmarks",
"summary": "List all bookmarks",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"bookmarks"
],
"consumes": [
"application/json"
],
"operationId": "post_bookmarks",
"summary": "Create a bookmark",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"bookmark": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"controller": {
"type": "string"
},
"query": {
"type": "string"
},
"public": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"name",
"controller",
"query"
]
}
},
"additionalProperties": false,
"required": [
"bookmark"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/bookmarks/{id}": {
"get": {
"tags": [
"bookmarks"
],
"consumes": [
"application/json"
],
"operationId": "get_bookmarks_id",
"summary": "Show a bookmark",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"bookmarks"
],
"consumes": [
"application/json"
],
"operationId": "put_bookmarks_id",
"summary": "Update a bookmark",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"bookmark": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"controller": {
"type": "string"
},
"query": {
"type": "string"
},
"public": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"bookmark"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"bookmarks"
],
"consumes": [
"application/json"
],
"operationId": "delete_bookmarks_id",
"summary": "Delete a bookmark",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/puppetclass_ids": {
"get": {
"tags": [
"hostgroup_classes"
],
"consumes": [
"application/json"
],
"operationId": "get_hostgroups_hostgroup_id_puppetclass_ids",
"summary": "List all Puppet class IDs for host group",
"parameters": [
{
"name": "hostgroup_id",
"type": "number",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"hostgroup_classes"
],
"consumes": [
"application/json"
],
"operationId": "post_hostgroups_hostgroup_id_puppetclass_ids",
"summary": "Add a Puppet class to host group",
"parameters": [
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"puppetclass_id": {
"type": "string",
"description": "ID of Puppet class"
}
},
"additionalProperties": false,
"required": [
"puppetclass_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hostgroups/{hostgroup_id}/puppetclass_ids/{id}": {
"delete": {
"tags": [
"hostgroup_classes"
],
"consumes": [
"application/json"
],
"operationId": "delete_hostgroups_hostgroup_id_puppetclass_ids_id",
"summary": "Remove a Puppet class from host group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of Puppet class"
},
{
"name": "hostgroup_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host group"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_reports": {
"get": {
"tags": [
"config_reports"
],
"consumes": [
"application/json"
],
"operationId": "get_config_reports",
"summary": "List all reports",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"config_reports"
],
"consumes": [
"application/json"
],
"operationId": "post_config_reports",
"summary": "Create a report",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"config_report": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Hostname or certname"
},
"reported_at": {
"type": "string",
"description": "UTC time of report"
},
"status": {
"type": "object",
"additionalProperties": true,
"description": "Hash of status type totals"
},
"metrics": {
"type": "object",
"additionalProperties": true,
"description": "Hash of report metrics, can be just {}"
},
"logs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional array of log hashes"
}
},
"additionalProperties": false,
"required": [
"host",
"reported_at",
"status",
"metrics"
]
}
},
"additionalProperties": false,
"required": [
"config_report"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_reports/{id}": {
"get": {
"tags": [
"config_reports"
],
"consumes": [
"application/json"
],
"operationId": "get_config_reports_id",
"summary": "Show a report",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"config_reports"
],
"consumes": [
"application/json"
],
"operationId": "delete_config_reports_id",
"summary": "Delete a report",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/config_reports/last": {
"get": {
"tags": [
"config_reports"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_config_reports_last",
"summary": "Show the last report for a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "host_id",
"type": "number",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/realms": {
"get": {
"tags": [
"realms"
],
"consumes": [
"application/json"
],
"operationId": "get_realms",
"summary": "List of realms",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"realms"
],
"consumes": [
"application/json"
],
"operationId": "post_realms",
"summary": "Create a realm",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"realm": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The realm name, e.g. EXAMPLE.COM"
},
"realm_proxy_id": {
"type": "number",
"description": "Proxy ID to use within this realm"
},
"realm_type": {
"type": "string",
"description": "Realm type, e.g. FreeIPA or Active Directory"
}
},
"additionalProperties": false,
"required": [
"name",
"realm_proxy_id",
"realm_type"
]
}
},
"additionalProperties": false,
"required": [
"realm"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": "\n<p>The <strong>name</strong> field is used for the name of the realm.</p>\n"
}
},
"/realms/{id}": {
"get": {
"tags": [
"realms"
],
"consumes": [
"application/json"
],
"operationId": "get_realms_id",
"summary": "Show a realm",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "Numerical ID or realm name"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"realms"
],
"consumes": [
"application/json"
],
"operationId": "put_realms_id",
"summary": "Update a realm",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"realm": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The realm name, e.g. EXAMPLE.COM"
},
"realm_proxy_id": {
"type": "number",
"description": "Proxy ID to use within this realm"
},
"realm_type": {
"type": "string",
"description": "Realm type, e.g. FreeIPA or Active Directory"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"realm"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"realms"
],
"consumes": [
"application/json"
],
"operationId": "delete_realms_id",
"summary": "Delete a realm",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations": {
"get": {
"tags": [
"locations"
],
"consumes": [
"application/json"
],
"operationId": "get_locations",
"summary": "List all locations",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"locations"
],
"consumes": [
"application/json"
],
"operationId": "post_locations",
"summary": "Create a location",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "User IDs"
},
"smart_proxy_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Smart proxy IDs"
},
"compute_resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Compute resource IDs"
},
"medium_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Medium IDs"
},
"config_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provisioning template IDs"
},
"ptable_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Partition template IDs"
},
"provisioning_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provisioning template IDs"
},
"domain_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Domain IDs"
},
"realm_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Realm IDs"
},
"hostgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Host group IDs"
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Environment IDs"
},
"subnet_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Subnet IDs"
},
"parent_id": {
"type": "number",
"description": "Parent ID"
},
"ignore_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of resources types that will be automatically associated"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"location"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{id}": {
"get": {
"tags": [
"locations"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_id",
"summary": "Show a location",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden_parameters",
"type": "boolean",
"in": "query",
"description": "Display hidden parameter values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"locations"
],
"consumes": [
"application/json"
],
"operationId": "put_locations_id",
"summary": "Update a location",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "User IDs"
},
"smart_proxy_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Smart proxy IDs"
},
"compute_resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Compute resource IDs"
},
"medium_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Medium IDs"
},
"config_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provisioning template IDs"
},
"ptable_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Partition template IDs"
},
"provisioning_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provisioning template IDs"
},
"domain_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Domain IDs"
},
"realm_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Realm IDs"
},
"hostgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Host group IDs"
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Environment IDs"
},
"subnet_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Subnet IDs"
},
"parent_id": {
"type": "number",
"description": "Parent ID"
},
"ignore_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of resources types that will be automatically associated"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"location"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"locations"
],
"consumes": [
"application/json"
],
"operationId": "delete_locations_id",
"summary": "Delete a location",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_proxies/smart_proxy_id/autosign": {
"get": {
"tags": [
"autosign"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_proxies_smart_proxy_id_autosign",
"summary": "List all autosign entries",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_proxies/{smart_proxy_id}/autosign": {
"post": {
"tags": [
"autosign"
],
"consumes": [
"application/json"
],
"operationId": "post_smart_proxies_smart_proxy_id_autosign",
"summary": "Create autosign entry",
"parameters": [
{
"name": "smart_proxy_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Autosign entry name"
}
},
"additionalProperties": false,
"required": [
"id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_proxies/{smart_proxy_id}/autosign/{id}": {
"delete": {
"tags": [
"autosign"
],
"consumes": [
"application/json"
],
"operationId": "delete_smart_proxies_smart_proxy_id_autosign_id",
"summary": "Delete autosign entry",
"parameters": [
{
"name": "smart_proxy_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "Autosign entry name"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_variables/{smart_variable_id}/override_values": {
"get": {
"tags": [
"override_values"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_variables_smart_variable_id_override_values",
"summary": "List of override values for a specific smart variable",
"parameters": [
{
"name": "smart_variable_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "smart_class_parameter_id",
"type": "string",
"in": "query"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"override_values"
],
"consumes": [
"application/json"
],
"operationId": "post_smart_variables_smart_variable_id_override_values",
"summary": "Create an override value for a specific smart variable",
"parameters": [
{
"name": "smart_variable_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_class_parameter_id": {
"type": "string"
},
"override_value": {
"type": "object",
"properties": {
"match": {
"type": "string",
"description": "Override match"
},
"value": {
"type": "any_type",
"description": "Override value, required if omit is false"
},
"use_puppet_default": {
"type": "boolean",
"description": "Deprecated, please use omit"
},
"omit": {
"type": "boolean",
"description": "Foreman will not send this parameter in classification output, replaces use_puppet_default"
}
},
"additionalProperties": false,
"required": [
"match"
]
}
},
"additionalProperties": false,
"required": [
"override_value"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_class_parameters/{smart_class_parameter_id}/override_values": {
"get": {
"tags": [
"override_values"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_class_parameters_smart_class_parameter_id_override_values",
"summary": "List of override values for a specific smart class parameter",
"parameters": [
{
"name": "smart_variable_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "smart_class_parameter_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"override_values"
],
"consumes": [
"application/json"
],
"operationId": "post_smart_class_parameters_smart_class_parameter_id_override_values",
"summary": "Create an override value for a specific smart class parameter",
"parameters": [
{
"name": "smart_class_parameter_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_variable_id": {
"type": "string"
},
"override_value": {
"type": "object",
"properties": {
"match": {
"type": "string",
"description": "Override match"
},
"value": {
"type": "any_type",
"description": "Override value, required if omit is false"
},
"use_puppet_default": {
"type": "boolean",
"description": "Deprecated, please use omit"
},
"omit": {
"type": "boolean",
"description": "Foreman will not send this parameter in classification output, replaces use_puppet_default"
}
},
"additionalProperties": false,
"required": [
"match"
]
}
},
"additionalProperties": false,
"required": [
"smart_variable_id",
"override_value"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_variables/{smart_variable_id}/override_values/{id}": {
"get": {
"tags": [
"override_values"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_variables_smart_variable_id_override_values_id",
"summary": "Show an override value for a specific smart variable",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "smart_variable_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "smart_class_parameter_id",
"type": "string",
"in": "query"
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"override_values"
],
"consumes": [
"application/json"
],
"operationId": "put_smart_variables_smart_variable_id_override_values_id",
"summary": "Update an override value for a specific smart variable",
"parameters": [
{
"name": "id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "smart_variable_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_class_parameter_id": {
"type": "string"
},
"override_value": {
"type": "object",
"properties": {
"match": {
"type": "string",
"description": "Override match"
},
"value": {
"type": "any_type",
"description": "Override value, required if omit is false"
},
"use_puppet_default": {
"type": "boolean",
"description": "Deprecated, please use omit"
},
"omit": {
"type": "boolean",
"description": "Foreman will not send this parameter in classification output, replaces use_puppet_default"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"override_value"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"override_values"
],
"consumes": [
"application/json"
],
"operationId": "delete_smart_variables_smart_variable_id_override_values_id",
"summary": "Delete an override value for a specific smart variable",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "smart_variable_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_class_parameter_id": {
"type": "string"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/smart_class_parameters/{smart_class_parameter_id}/override_values/{id}": {
"get": {
"tags": [
"override_values"
],
"consumes": [
"application/json"
],
"operationId": "get_smart_class_parameters_smart_class_parameter_id_override_values_id",
"summary": "Show an override value for a specific smart class parameter",
"parameters": [
{
"name": "smart_variable_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "smart_class_parameter_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden",
"type": "boolean",
"in": "query",
"description": "Display hidden values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"override_values"
],
"consumes": [
"application/json"
],
"operationId": "put_smart_class_parameters_smart_class_parameter_id_override_values_id",
"summary": "Update an override value for a specific smart class parameter",
"parameters": [
{
"name": "id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "smart_class_parameter_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_variable_id": {
"type": "string"
},
"override_value": {
"type": "object",
"properties": {
"match": {
"type": "string",
"description": "Override match"
},
"value": {
"type": "any_type",
"description": "Override value, required if omit is false"
},
"use_puppet_default": {
"type": "boolean",
"description": "Deprecated, please use omit"
},
"omit": {
"type": "boolean",
"description": "Foreman will not send this parameter in classification output, replaces use_puppet_default"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"smart_variable_id",
"override_value"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"override_values"
],
"consumes": [
"application/json"
],
"operationId": "delete_smart_class_parameters_smart_class_parameter_id_override_values_id",
"summary": "Delete an override value for a specific smart class parameter",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "smart_class_parameter_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"smart_variable_id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"smart_variable_id"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems": {
"get": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems",
"summary": "List all operating systems",
"parameters": [
{
"name": "architecture_id",
"type": "string",
"in": "query",
"description": "ID of architecture"
},
{
"name": "medium_id",
"type": "string",
"in": "query",
"description": "ID of medium"
},
{
"name": "ptable_id",
"type": "string",
"in": "query",
"description": "ID of partition table"
},
{
"name": "config_template_id",
"type": "string",
"in": "query",
"description": "ID of template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"description": "ID of template"
},
{
"name": "os_parameters_attributes",
"type": "array",
"items": {
"type": "string"
},
"in": "query",
"description": "Array of parameters"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "post_operatingsystems",
"summary": "Create an operating system",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"operatingsystem": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"major": {
"type": "string"
},
"minor": {
"type": "string"
},
"description": {
"type": "string"
},
"family": {
"type": "string"
},
"release_name": {
"type": "string"
},
"os_parameters_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of parameters"
},
"password_hash": {
"type": "string",
"description": "Root password hash function to use, one of MD5, SHA256, SHA512, Base64"
},
"architecture_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated architectures"
},
"config_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated provisioning templates"
},
"provisioning_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated provisioning templates"
},
"medium_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated media"
},
"ptable_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated partition tables"
}
},
"additionalProperties": false,
"required": [
"name",
"major"
]
}
},
"additionalProperties": false,
"required": [
"operatingsystem"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/architectures/{architecture_id}/operatingsystems": {
"get": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "get_architectures_architecture_id_operatingsystems",
"summary": "List all operating systems for nested architecture",
"parameters": [
{
"name": "architecture_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of architecture"
},
{
"name": "medium_id",
"type": "string",
"in": "query",
"description": "ID of medium"
},
{
"name": "ptable_id",
"type": "string",
"in": "query",
"description": "ID of partition table"
},
{
"name": "config_template_id",
"type": "string",
"in": "query",
"description": "ID of template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"description": "ID of template"
},
{
"name": "os_parameters_attributes",
"type": "array",
"items": {
"type": "string"
},
"in": "query",
"description": "Array of parameters"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/media/{medium_id}/operatingsystems": {
"get": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "get_media_medium_id_operatingsystems",
"summary": "List all operating systems for nested medium",
"parameters": [
{
"name": "architecture_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of architecture"
},
{
"name": "medium_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of medium"
},
{
"name": "ptable_id",
"type": "string",
"in": "query",
"description": "ID of partition table"
},
{
"name": "config_template_id",
"type": "string",
"in": "query",
"description": "ID of template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"description": "ID of template"
},
{
"name": "os_parameters_attributes",
"type": "array",
"items": {
"type": "string"
},
"in": "query",
"description": "Array of parameters"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ptables/{ptable_id}/operatingsystems": {
"get": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "get_ptables_ptable_id_operatingsystems",
"summary": "List all operating systems for nested partition table",
"parameters": [
{
"name": "medium_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of medium"
},
{
"name": "architecture_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of architecture"
},
{
"name": "ptable_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of partition table"
},
{
"name": "config_template_id",
"type": "string",
"in": "query",
"description": "ID of template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"description": "ID of template"
},
{
"name": "os_parameters_attributes",
"type": "array",
"items": {
"type": "string"
},
"in": "query",
"description": "Array of parameters"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/config_templates/{config_template_id}/operatingsystems": {
"get": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "get_config_templates_config_template_id_operatingsystems",
"summary": "List all operating systems for nested provisioning template",
"parameters": [
{
"name": "ptable_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of partition table"
},
{
"name": "medium_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of medium"
},
{
"name": "architecture_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of architecture"
},
{
"name": "config_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of template"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "query",
"description": "ID of template"
},
{
"name": "os_parameters_attributes",
"type": "array",
"items": {
"type": "string"
},
"in": "query",
"description": "Array of parameters"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/provisioning_templates/{provisioning_template_id}/operatingsystems": {
"get": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "get_provisioning_templates_provisioning_template_id_operatingsystems",
"summary": "List all operating systems for nested provisioning template",
"parameters": [
{
"name": "config_template_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of template"
},
{
"name": "ptable_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of partition table"
},
{
"name": "medium_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of medium"
},
{
"name": "architecture_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of architecture"
},
{
"name": "provisioning_template_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of template"
},
{
"name": "os_parameters_attributes",
"type": "array",
"items": {
"type": "string"
},
"in": "query",
"description": "Array of parameters"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{id}": {
"get": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_id",
"summary": "Show an operating system",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden_parameters",
"type": "boolean",
"in": "query",
"description": "Display hidden parameter values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "put_operatingsystems_id",
"summary": "Update an operating system",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"operatingsystem": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"major": {
"type": "string"
},
"minor": {
"type": "string"
},
"description": {
"type": "string"
},
"family": {
"type": "string"
},
"release_name": {
"type": "string"
},
"os_parameters_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of parameters"
},
"password_hash": {
"type": "string",
"description": "Root password hash function to use, one of MD5, SHA256, SHA512, Base64"
},
"architecture_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated architectures"
},
"config_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated provisioning templates"
},
"provisioning_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated provisioning templates"
},
"medium_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated media"
},
"ptable_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of associated partition tables"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"operatingsystem"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "delete_operatingsystems_id",
"summary": "Delete an operating system",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/operatingsystems/{id}/bootfiles": {
"get": {
"tags": [
"operatingsystems"
],
"consumes": [
"application/json"
],
"operationId": "get_operatingsystems_id_bootfiles",
"summary": "List boot files for an operating system",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "medium",
"type": "string",
"in": "query"
},
{
"name": "architecture",
"type": "string",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/users/{user_id}/table_preferences": {
"get": {
"tags": [
"table_preferences"
],
"consumes": [
"application/json"
],
"operationId": "get_users_user_id_table_preferences",
"summary": "List of table preferences for a user",
"parameters": [
{
"name": "user_id",
"type": "number",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"table_preferences"
],
"consumes": [
"application/json"
],
"operationId": "post_users_user_id_table_preferences",
"summary": "Creates a table preference for a given table",
"parameters": [
{
"name": "user_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"table_preferences": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the table"
},
"columns": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user selected columns"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"table_preferences"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/users/{user_id}/table_preferences/{name}": {
"get": {
"tags": [
"table_preferences"
],
"consumes": [
"application/json"
],
"operationId": "get_users_user_id_table_preferences_name",
"summary": "Table preference details of a given table",
"parameters": [
{
"name": "user_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "name",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"table_preferences"
],
"consumes": [
"application/json"
],
"operationId": "put_users_user_id_table_preferences_name",
"summary": "Updates a table preference for a given table",
"parameters": [
{
"name": "name",
"type": "number",
"in": "path",
"required": true
},
{
"name": "user_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"table_preferences": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the table"
},
"columns": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user selected columns"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"table_preferences"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"table_preferences"
],
"consumes": [
"application/json"
],
"operationId": "delete_users_user_id_table_preferences_name",
"summary": "Delete a table preference for a given table",
"parameters": [
{
"name": "user_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "name",
"type": "string",
"in": "path",
"required": true,
"description": "name of the table"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/domains": {
"get": {
"tags": [
"domains"
],
"consumes": [
"application/json"
],
"operationId": "get_domains",
"summary": "List of domains",
"parameters": [
{
"name": "subnet_id",
"type": "string",
"in": "query",
"description": "ID of subnet"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"domains"
],
"consumes": [
"application/json"
],
"operationId": "post_domains",
"summary": "Create a domain",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"domain": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The full DNS domain name"
},
"fullname": {
"type": "string",
"description": "Description of the domain"
},
"dns_id": {
"type": "number",
"description": "DNS proxy ID to use within this domain"
},
"domain_parameters_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of parameters (name, value)"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"domain"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": "\n<p>The <strong>fullname</strong> field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter</p>\n"
}
},
"/subnets/{subnet_id}/domains": {
"get": {
"tags": [
"domains"
],
"consumes": [
"application/json"
],
"operationId": "get_subnets_subnet_id_domains",
"summary": "List of domains per subnet",
"parameters": [
{
"name": "subnet_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of subnet"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/domains": {
"get": {
"tags": [
"domains"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_domains",
"summary": "List of domains per location",
"parameters": [
{
"name": "subnet_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of subnet"
},
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/domains": {
"get": {
"tags": [
"domains"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_domains",
"summary": "List of domains per organization",
"parameters": [
{
"name": "subnet_id",
"type": "string",
"in": "query",
"required": true,
"description": "ID of subnet"
},
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/domains/{id}": {
"get": {
"tags": [
"domains"
],
"consumes": [
"application/json"
],
"operationId": "get_domains_id",
"summary": "Show a domain",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "Numerical ID or domain name"
},
{
"name": "show_hidden_parameters",
"type": "boolean",
"in": "query",
"description": "Display hidden parameter values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"domains"
],
"consumes": [
"application/json"
],
"operationId": "put_domains_id",
"summary": "Update a domain",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"domain": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The full DNS domain name"
},
"fullname": {
"type": "string",
"description": "Description of the domain"
},
"dns_id": {
"type": "number",
"description": "DNS proxy ID to use within this domain"
},
"domain_parameters_attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of parameters (name, value)"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"domain"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"domains"
],
"consumes": [
"application/json"
],
"operationId": "delete_domains_id",
"summary": "Delete a domain",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_source_externals": {
"get": {
"tags": [
"auth_source_externals"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_source_externals",
"summary": "List external authentication sources",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/auth_source_externals": {
"get": {
"tags": [
"auth_source_externals"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_auth_source_externals",
"summary": "List external authentication sources per location",
"parameters": [
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/auth_source_externals": {
"get": {
"tags": [
"auth_source_externals"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_auth_source_externals",
"summary": "List external authentication sources per organization",
"parameters": [
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_source_externals/{id}": {
"get": {
"tags": [
"auth_source_externals"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_source_externals_id",
"summary": "Show an external authentication source",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"auth_source_externals"
],
"consumes": [
"application/json"
],
"operationId": "put_auth_source_externals_id",
"summary": "Update an external authentication source",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"auth_source_external": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"auth_source_external"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations": {
"get": {
"tags": [
"organizations"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations",
"summary": "List all organizations",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"organizations"
],
"consumes": [
"application/json"
],
"operationId": "post_organizations",
"summary": "Create an organization",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "User IDs"
},
"smart_proxy_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Smart proxy IDs"
},
"compute_resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Compute resource IDs"
},
"medium_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Medium IDs"
},
"config_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provisioning template IDs"
},
"ptable_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Partition template IDs"
},
"provisioning_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provisioning template IDs"
},
"domain_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Domain IDs"
},
"realm_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Realm IDs"
},
"hostgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Host group IDs"
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Environment IDs"
},
"subnet_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Subnet IDs"
},
"parent_id": {
"type": "number",
"description": "Parent ID"
},
"ignore_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of resources types that will be automatically associated"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"organization"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{id}": {
"get": {
"tags": [
"organizations"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_id",
"summary": "Show an organization",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "show_hidden_parameters",
"type": "boolean",
"in": "query",
"description": "Display hidden parameter values"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"organizations"
],
"consumes": [
"application/json"
],
"operationId": "put_organizations_id",
"summary": "Update an organization",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "User IDs"
},
"smart_proxy_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Smart proxy IDs"
},
"compute_resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Compute resource IDs"
},
"medium_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Medium IDs"
},
"config_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provisioning template IDs"
},
"ptable_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Partition template IDs"
},
"provisioning_template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provisioning template IDs"
},
"domain_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Domain IDs"
},
"realm_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Realm IDs"
},
"hostgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Host group IDs"
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Environment IDs"
},
"subnet_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Subnet IDs"
},
"parent_id": {
"type": "number",
"description": "Parent ID"
},
"ignore_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of resources types that will be automatically associated"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"organization"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"organizations"
],
"consumes": [
"application/json"
],
"operationId": "delete_organizations_id",
"summary": "Delete an organization",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/audits": {
"get": {
"tags": [
"audits"
],
"consumes": [
"application/json"
],
"operationId": "get_audits",
"summary": "List all audits",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/audits": {
"get": {
"tags": [
"audits"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_audits",
"summary": "List all audits for a given host",
"parameters": [
{
"name": "host_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/audits/{id}": {
"get": {
"tags": [
"audits"
],
"consumes": [
"application/json"
],
"operationId": "get_audits_id",
"summary": "Show an audit",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/reports": {
"get": {
"tags": [
"reports"
],
"consumes": [
"application/json"
],
"operationId": "get_reports",
"summary": "List all reports",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"reports"
],
"consumes": [
"application/json"
],
"operationId": "post_reports",
"summary": "Create a report",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"report": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Hostname or certname"
},
"reported_at": {
"type": "string",
"description": "UTC time of report"
},
"status": {
"type": "object",
"additionalProperties": true,
"description": "Hash of status type totals"
},
"metrics": {
"type": "object",
"additionalProperties": true,
"description": "Hash of report metrics, can be just {}"
},
"logs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional array of log hashes"
}
},
"additionalProperties": false,
"required": [
"host",
"reported_at",
"status",
"metrics"
]
}
},
"additionalProperties": false,
"required": [
"report"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/reports/{id}": {
"get": {
"tags": [
"reports"
],
"consumes": [
"application/json"
],
"operationId": "get_reports_id",
"summary": "Show a report",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"reports"
],
"consumes": [
"application/json"
],
"operationId": "delete_reports_id",
"summary": "Delete a report",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/reports/last": {
"get": {
"tags": [
"reports"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_reports_last",
"summary": "Show the last report for a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "host_id",
"type": "number",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/users/{user_id}/ssh_keys": {
"get": {
"tags": [
"ssh_keys"
],
"consumes": [
"application/json"
],
"operationId": "get_users_user_id_ssh_keys",
"summary": "List all SSH keys for a user",
"parameters": [
{
"name": "user_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the user"
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"ssh_keys"
],
"consumes": [
"application/json"
],
"operationId": "post_users_user_id_ssh_keys",
"summary": "Add an SSH key for a user",
"parameters": [
{
"name": "user_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the user"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"ssh_key": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"key": {
"type": "string",
"description": "Public SSH key"
}
},
"additionalProperties": false,
"required": [
"name",
"key"
]
}
},
"additionalProperties": false,
"required": [
"ssh_key"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/users/{user_id}/ssh_keys/{id}": {
"get": {
"tags": [
"ssh_keys"
],
"consumes": [
"application/json"
],
"operationId": "get_users_user_id_ssh_keys_id",
"summary": "Show an SSH key from a user",
"parameters": [
{
"name": "user_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the user"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"ssh_keys"
],
"consumes": [
"application/json"
],
"operationId": "delete_users_user_id_ssh_keys_id",
"summary": "Delete an SSH key for a user",
"parameters": [
{
"name": "user_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the user"
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_source_internals": {
"get": {
"tags": [
"auth_source_internals"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_source_internals",
"summary": "List internal authentication sources",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_source_internals/{id}": {
"get": {
"tags": [
"auth_source_internals"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_source_internals_id",
"summary": "Show an internal authentication source",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/permissions": {
"get": {
"tags": [
"permissions"
],
"consumes": [
"application/json"
],
"operationId": "get_permissions",
"summary": "List all permissions",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
},
{
"name": "resource_type",
"type": "string",
"in": "query"
},
{
"name": "name",
"type": "string",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/permissions/{id}": {
"get": {
"tags": [
"permissions"
],
"consumes": [
"application/json"
],
"operationId": "get_permissions_id",
"summary": "Show a permission",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/permissions/resource_types": {
"get": {
"tags": [
"permissions"
],
"consumes": [
"application/json"
],
"operationId": "get_permissions_resource_types",
"summary": "List available resource types",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_source_ldaps": {
"get": {
"tags": [
"auth_source_ldaps"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_source_ldaps",
"summary": "List all LDAP authentication sources",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"auth_source_ldaps"
],
"consumes": [
"application/json"
],
"operationId": "post_auth_source_ldaps",
"summary": "Create an LDAP authentication source",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"auth_source_ldap": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "number",
"description": "defaults to 389"
},
"account": {
"type": "string"
},
"base_dn": {
"type": "string"
},
"account_password": {
"type": "string",
"description": "required if onthefly_register is true"
},
"attr_login": {
"type": "string",
"description": "required if onthefly_register is true"
},
"attr_firstname": {
"type": "string",
"description": "required if onthefly_register is true"
},
"attr_lastname": {
"type": "string",
"description": "required if onthefly_register is true"
},
"attr_mail": {
"type": "string",
"description": "required if onthefly_register is true"
},
"attr_photo": {
"type": "string"
},
"onthefly_register": {
"type": "boolean"
},
"usergroup_sync": {
"type": "boolean",
"description": "sync external user groups on login"
},
"tls": {
"type": "boolean"
},
"groups_base": {
"type": "string",
"description": "groups base DN"
},
"use_netgroups": {
"type": "boolean",
"description": "use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa"
},
"server_type": {
"type": "string",
"enum": [
"free_ipa",
"active_directory",
"posix"
],
"description": "type of the LDAP server"
},
"ldap_filter": {
"type": "string",
"description": "LDAP filter"
}
},
"additionalProperties": false,
"required": [
"name",
"host"
]
}
},
"additionalProperties": false,
"required": [
"auth_source_ldap"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/auth_source_ldaps": {
"get": {
"tags": [
"auth_source_ldaps"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_auth_source_ldaps",
"summary": "List LDAP authentication sources per location",
"parameters": [
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/auth_source_ldaps": {
"get": {
"tags": [
"auth_source_ldaps"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_auth_source_ldaps",
"summary": "List LDAP authentication sources per organization",
"parameters": [
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_source_ldaps/{id}": {
"get": {
"tags": [
"auth_source_ldaps"
],
"consumes": [
"application/json"
],
"operationId": "get_auth_source_ldaps_id",
"summary": "Show an LDAP authentication source",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"auth_source_ldaps"
],
"consumes": [
"application/json"
],
"operationId": "put_auth_source_ldaps_id",
"summary": "Update an LDAP authentication source",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"auth_source_ldap": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "number",
"description": "defaults to 389"
},
"account": {
"type": "string"
},
"base_dn": {
"type": "string"
},
"account_password": {
"type": "string",
"description": "required if onthefly_register is true"
},
"attr_login": {
"type": "string",
"description": "required if onthefly_register is true"
},
"attr_firstname": {
"type": "string",
"description": "required if onthefly_register is true"
},
"attr_lastname": {
"type": "string",
"description": "required if onthefly_register is true"
},
"attr_mail": {
"type": "string",
"description": "required if onthefly_register is true"
},
"attr_photo": {
"type": "string"
},
"onthefly_register": {
"type": "boolean"
},
"usergroup_sync": {
"type": "boolean",
"description": "sync external user groups on login"
},
"tls": {
"type": "boolean"
},
"groups_base": {
"type": "string",
"description": "groups base DN"
},
"use_netgroups": {
"type": "boolean",
"description": "use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa"
},
"server_type": {
"type": "string",
"enum": [
"free_ipa",
"active_directory",
"posix"
],
"description": "type of the LDAP server"
},
"ldap_filter": {
"type": "string",
"description": "LDAP filter"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"auth_source_ldap"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"auth_source_ldaps"
],
"consumes": [
"application/json"
],
"operationId": "delete_auth_source_ldaps_id",
"summary": "Delete an LDAP authentication source",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/auth_source_ldaps/{id}/test": {
"put": {
"tags": [
"auth_source_ldaps"
],
"consumes": [
"application/json"
],
"operationId": "put_auth_source_ldaps_id_test",
"summary": "Test LDAP connection",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{compute_resource_id}/compute_profiles/{compute_profile_id}/compute_attributes": {
"post": {
"tags": [
"compute_attributes"
],
"consumes": [
"application/json"
],
"operationId": "post_compute_resources_compute_resource_id_compute_profiles_compute_profile_id_compute_attributes",
"summary": "Create a compute attributes set",
"parameters": [
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "compute_profile_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_attribute": {
"type": "object",
"properties": {
"vm_attrs": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"required": [
"vm_attrs"
]
}
},
"additionalProperties": false,
"required": [
"compute_attribute"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_profiles/{compute_profile_id}/compute_resources/{compute_resource_id}/compute_attributes": {
"post": {
"tags": [
"compute_attributes"
],
"consumes": [
"application/json"
],
"operationId": "post_compute_profiles_compute_profile_id_compute_resources_compute_resource_id_compute_attributes",
"summary": "Create a compute attributes set",
"parameters": [
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "compute_profile_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_attribute": {
"type": "object",
"properties": {
"vm_attrs": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"required": [
"vm_attrs"
]
}
},
"additionalProperties": false,
"required": [
"compute_attribute"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{compute_resource_id}/compute_attributes": {
"post": {
"tags": [
"compute_attributes"
],
"consumes": [
"application/json"
],
"operationId": "post_compute_resources_compute_resource_id_compute_attributes",
"summary": "Create a compute attributes set",
"parameters": [
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_profile_id": {
"type": "string"
},
"compute_attribute": {
"type": "object",
"properties": {
"vm_attrs": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"required": [
"vm_attrs"
]
}
},
"additionalProperties": false,
"required": [
"compute_profile_id",
"compute_attribute"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_profiles/{compute_profile_id}/compute_attributes": {
"post": {
"tags": [
"compute_attributes"
],
"consumes": [
"application/json"
],
"operationId": "post_compute_profiles_compute_profile_id_compute_attributes",
"summary": "Create a compute attributes set",
"parameters": [
{
"name": "compute_profile_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_resource_id": {
"type": "string"
},
"compute_attribute": {
"type": "object",
"properties": {
"vm_attrs": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"required": [
"vm_attrs"
]
}
},
"additionalProperties": false,
"required": [
"compute_resource_id",
"compute_attribute"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_attributes": {
"post": {
"tags": [
"compute_attributes"
],
"consumes": [
"application/json"
],
"operationId": "post_compute_attributes",
"summary": "Create a compute attributes set",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_profile_id": {
"type": "string"
},
"compute_resource_id": {
"type": "string"
},
"compute_attribute": {
"type": "object",
"properties": {
"vm_attrs": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false,
"required": [
"vm_attrs"
]
}
},
"additionalProperties": false,
"required": [
"compute_profile_id",
"compute_resource_id",
"compute_attribute"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{compute_resource_id}/compute_profiles/{compute_profile_id}/compute_attributes/{id}": {
"put": {
"tags": [
"compute_attributes"
],
"consumes": [
"application/json"
],
"operationId": "put_compute_resources_compute_resource_id_compute_profiles_compute_profile_id_compute_attributes_id",
"summary": "Update a compute attributes set",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "compute_profile_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_attribute": {
"type": "object",
"properties": {
"vm_attrs": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"compute_attribute"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_profiles/{compute_profile_id}/compute_resources/{compute_resource_id}/compute_attributes/{id}": {
"put": {
"tags": [
"compute_attributes"
],
"consumes": [
"application/json"
],
"operationId": "put_compute_profiles_compute_profile_id_compute_resources_compute_resource_id_compute_attributes_id",
"summary": "Update a compute attributes set",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "compute_profile_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_attribute": {
"type": "object",
"properties": {
"vm_attrs": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"compute_attribute"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{compute_resource_id}/compute_attributes/{id}": {
"put": {
"tags": [
"compute_attributes"
],
"consumes": [
"application/json"
],
"operationId": "put_compute_resources_compute_resource_id_compute_attributes_id",
"summary": "Update a compute attributes set",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "compute_resource_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_profile_id": {
"type": "string"
},
"compute_attribute": {
"type": "object",
"properties": {
"vm_attrs": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"compute_profile_id",
"compute_attribute"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_profiles/{compute_profile_id}/compute_attributes/{id}": {
"put": {
"tags": [
"compute_attributes"
],
"consumes": [
"application/json"
],
"operationId": "put_compute_profiles_compute_profile_id_compute_attributes_id",
"summary": "Update a compute attributes set",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "compute_profile_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_resource_id": {
"type": "string"
},
"compute_attribute": {
"type": "object",
"properties": {
"vm_attrs": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"compute_resource_id",
"compute_attribute"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_attributes/{id}": {
"put": {
"tags": [
"compute_attributes"
],
"consumes": [
"application/json"
],
"operationId": "put_compute_attributes_id",
"summary": "Update a compute attributes set",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_profile_id": {
"type": "string"
},
"compute_resource_id": {
"type": "string"
},
"compute_attribute": {
"type": "object",
"properties": {
"vm_attrs": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"compute_profile_id",
"compute_resource_id",
"compute_attribute"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources",
"summary": "List all compute resources",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "post_compute_resources",
"summary": "Create a compute resource",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_resource": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"provider": {
"type": "string",
"description": "Providers include Libvirt, Vmware"
},
"url": {
"type": "string",
"description": "URL for Libvirt, oVirt, OpenStack and Rackspace"
},
"description": {
"type": "string"
},
"user": {
"type": "string",
"description": "Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2."
},
"password": {
"type": "string",
"description": "Password for oVirt, EC2, VMware, OpenStack. Secret key for EC2"
},
"uuid": {
"type": "string",
"description": "Deprecated, please use datacenter"
},
"datacenter": {
"type": "string",
"description": "for oVirt, VMware Datacenter"
},
"use_v4": {
"type": "boolean",
"description": "for oVirt only"
},
"ovirt_quota": {
"type": "string",
"description": "for oVirt only"
},
"region": {
"type": "string",
"description": "for EC2 only, use 'us-gov-west-1' for GovCloud region"
},
"tenant": {
"type": "string",
"description": "for OpenStack only"
},
"domain": {
"type": "string",
"description": "for OpenStack only"
},
"server": {
"type": "string",
"description": "for VMware"
},
"set_console_password": {
"type": "boolean",
"description": "for Libvirt and VMware only"
},
"display_type": {
"type": "string",
"enum": [
"VNC",
"SPICE"
],
"description": "for Libvirt only"
},
"caching_enabled": {
"type": "boolean",
"description": "enable caching, for VMware only"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"compute_resource"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id",
"summary": "Show a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "put_compute_resources_id",
"summary": "Update a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"compute_resource": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"provider": {
"type": "string",
"description": "Providers include Libvirt, Vmware"
},
"url": {
"type": "string",
"description": "URL for Libvirt, oVirt, OpenStack and Rackspace"
},
"description": {
"type": "string"
},
"user": {
"type": "string",
"description": "Username for oVirt, EC2, VMware, OpenStack. Access Key for EC2."
},
"password": {
"type": "string",
"description": "Password for oVirt, EC2, VMware, OpenStack. Secret key for EC2"
},
"uuid": {
"type": "string",
"description": "Deprecated, please use datacenter"
},
"datacenter": {
"type": "string",
"description": "for oVirt, VMware Datacenter"
},
"use_v4": {
"type": "boolean",
"description": "for oVirt only"
},
"ovirt_quota": {
"type": "string",
"description": "for oVirt only"
},
"region": {
"type": "string",
"description": "for EC2 only, use 'us-gov-west-1' for GovCloud region"
},
"tenant": {
"type": "string",
"description": "for OpenStack only"
},
"domain": {
"type": "string",
"description": "for OpenStack only"
},
"server": {
"type": "string",
"description": "for VMware"
},
"set_console_password": {
"type": "boolean",
"description": "for Libvirt and VMware only"
},
"display_type": {
"type": "string",
"enum": [
"VNC",
"SPICE"
],
"description": "for Libvirt only"
},
"caching_enabled": {
"type": "boolean",
"description": "enable caching, for VMware only"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"compute_resource"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "delete_compute_resources_id",
"summary": "Delete a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_images": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_images",
"summary": "List available images for a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_clusters": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_clusters",
"summary": "List available clusters for a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_flavors": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_flavors",
"summary": "List available flavors for a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_folders": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_folders",
"summary": "List available folders for a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_zones": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_zones",
"summary": "List available zone for a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_networks": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_networks",
"summary": "List available networks for a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "cluster_id",
"type": "string",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_clusters/{cluster_id}/available_networks": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_clusters_cluster_id_available_networks",
"summary": "List available networks for a compute resource cluster",
"parameters": [
{
"name": "cluster_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_clusters/{cluster_id}/available_resource_pools": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_clusters_cluster_id_available_resource_pools",
"summary": "List resource pools for a compute resource cluster",
"parameters": [
{
"name": "cluster_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_storage_domains": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_storage_domains",
"summary": "List storage domains for a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "storage_domain",
"type": "string",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_storage_domains/{storage_domain}": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_storage_domains_storage_domain",
"summary": "List attributes for a given storage domain",
"parameters": [
{
"name": "storage_domain",
"type": "string",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_storage_pods": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_storage_pods",
"summary": "List storage pods for a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "storage_pod",
"type": "string",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_storage_pods/{storage_pod}": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_storage_pods_storage_pod",
"summary": "List attributes for a given storage pod",
"parameters": [
{
"name": "storage_pod",
"type": "string",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/available_security_groups": {
"get": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "get_compute_resources_id_available_security_groups",
"summary": "List available security groups for a compute resource",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/associate": {
"put": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "put_compute_resources_id_associate",
"summary": "Associate VMs to Hosts",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/compute_resources/{id}/refresh_cache": {
"put": {
"tags": [
"compute_resources"
],
"consumes": [
"application/json"
],
"operationId": "put_compute_resources_id_refresh_cache",
"summary": "Refresh Compute Resource Cache",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/templates/{template_id}/template_inputs": {
"get": {
"tags": [
"template_inputs"
],
"consumes": [
"application/json"
],
"operationId": "get_templates_template_id_template_inputs",
"summary": "List template inputs",
"parameters": [
{
"name": "template_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"template_inputs"
],
"consumes": [
"application/json"
],
"operationId": "post_templates_template_id_template_inputs",
"summary": "Create a template input",
"parameters": [
{
"name": "template_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"template_input": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Input name"
},
"description": {
"type": "string",
"description": "Input description"
},
"required": {
"type": "boolean",
"description": "Input is required"
},
"advanced": {
"type": "boolean",
"description": "Input is advanced"
},
"input_type": {
"type": "string",
"enum": [
"user",
"fact",
"variable",
"puppet_parameter"
],
"description": "Input type"
},
"fact_name": {
"type": "string",
"description": "Fact name, used when input type is fact"
},
"variable_name": {
"type": "string",
"description": "Variable name, used when input type is variable"
},
"puppet_class_name": {
"type": "string",
"description": "Puppet class name, used when input type is puppet_parameter"
},
"puppet_parameter_name": {
"type": "string",
"description": "Puppet parameter name, used when input type is puppet_parameter"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Selectable values for user inputs"
}
},
"additionalProperties": false,
"required": [
"name",
"input_type"
]
}
},
"additionalProperties": false,
"required": [
"template_input"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/templates/{template_id}/template_inputs/{id}": {
"get": {
"tags": [
"template_inputs"
],
"consumes": [
"application/json"
],
"operationId": "get_templates_template_id_template_inputs_id",
"summary": "Show template input details",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "template_id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"template_inputs"
],
"consumes": [
"application/json"
],
"operationId": "delete_templates_template_id_template_inputs_id",
"summary": "Delete a template input",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "template_id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"template_inputs"
],
"consumes": [
"application/json"
],
"operationId": "put_templates_template_id_template_inputs_id",
"summary": "Update a template input",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "template_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"template_input": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Input name"
},
"description": {
"type": "string",
"description": "Input description"
},
"required": {
"type": "boolean",
"description": "Input is required"
},
"advanced": {
"type": "boolean",
"description": "Input is advanced"
},
"input_type": {
"type": "string",
"enum": [
"user",
"fact",
"variable",
"puppet_parameter"
],
"description": "Input type"
},
"fact_name": {
"type": "string",
"description": "Fact name, used when input type is fact"
},
"variable_name": {
"type": "string",
"description": "Variable name, used when input type is variable"
},
"puppet_class_name": {
"type": "string",
"description": "Puppet class name, used when input type is puppet_parameter"
},
"puppet_parameter_name": {
"type": "string",
"description": "Puppet parameter name, used when input type is puppet_parameter"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Selectable values for user inputs"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"template_input"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/recurring_logics": {
"get": {
"tags": [
"recurring_logics"
],
"consumes": [
"application/json"
],
"operationId": "get_recurring_logics",
"summary": "List recurring logics",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/recurring_logics/{id}": {
"get": {
"tags": [
"recurring_logics"
],
"consumes": [
"application/json"
],
"operationId": "get_recurring_logics_id",
"summary": "Show recurring logic details",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the recurring logic"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"recurring_logics"
],
"consumes": [
"application/json"
],
"operationId": "put_recurring_logics_id",
"summary": "Update recurring logic",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the recurring logic"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the recurring logic is enabled or disabled."
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/recurring_logics/{id}/cancel": {
"post": {
"tags": [
"recurring_logics"
],
"consumes": [
"application/json"
],
"operationId": "post_recurring_logics_id_cancel",
"summary": "Cancel recurring logic",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of the recurring logic"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/tasks/summary": {
"get": {
"tags": [
"foreman_tasks"
],
"consumes": [
"application/json"
],
"operationId": "get_tasks_summary",
"summary": "Show task summary",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/tasks/{id}": {
"get": {
"tags": [
"foreman_tasks"
],
"consumes": [
"application/json"
],
"operationId": "get_tasks_id",
"summary": "Show task details",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "UUID of the task"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/tasks/bulk_search": {
"post": {
"tags": [
"foreman_tasks"
],
"consumes": [
"application/json"
],
"operationId": "post_tasks_bulk_search",
"summary": "List dynflow tasks for uuids",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"searches": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of uuids to fetch info about"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": "\n<p>For every search it returns the list of tasks that satisfty the condition.\nThe reason for supporting multiple searches is the UI that might be ending\nneeding periodic updates on task status for various searches at the same\ntime. This way, it is possible to get all the task statuses with one\nrequest.</p>\n"
}
},
"/tasks/bulk_resume": {
"post": {
"tags": [
"foreman_tasks"
],
"consumes": [
"application/json"
],
"operationId": "post_tasks_bulk_resume",
"summary": "Resume all paused error tasks",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"search": {
"type": "string",
"description": "Resume tasks matching search string"
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Resume specific tasks by ID"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/tasks": {
"get": {
"tags": [
"foreman_tasks"
],
"consumes": [
"application/json"
],
"operationId": "get_tasks",
"summary": "List tasks",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "Search string"
},
{
"name": "page",
"type": "number",
"in": "query",
"description": "Page number, starting at 1"
},
{
"name": "per_page",
"type": "number",
"in": "query",
"description": "Number of results per page to return"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, e.g. 'name DESC'"
},
{
"name": "sort[by]",
"type": "string",
"in": "query",
"description": "Field to sort the results on"
},
{
"name": "sort[order]",
"type": "string",
"in": "query",
"description": "How to order the sorted results (e.g. ASC for ascending)"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/tasks/callback": {
"post": {
"tags": [
"foreman_tasks"
],
"consumes": [
"application/json"
],
"operationId": "post_tasks_callback",
"summary": "Send data to the task from external executor (such as smart_proxy_dynflow)",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"callback": {
"type": "object",
"properties": {
"task_id": {
"type": "string",
"description": "UUID of the task"
},
"step_id": {
"type": "string",
"description": "The ID of the step inside the execution plan to send the event to"
}
},
"additionalProperties": false
},
"data": {
"type": "object",
"additionalProperties": true,
"description": "Data to be sent to the action"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/omaha_reports": {
"get": {
"tags": [
"omaha_reports"
],
"consumes": [
"application/json"
],
"operationId": "get_omaha_reports",
"summary": "List all omaha reports",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"omaha_reports"
],
"consumes": [
"application/json"
],
"operationId": "post_omaha_reports",
"summary": "Create a omaha report",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"report": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Hostname or certname"
},
"status": {
"type": "string",
"enum": [
"unknown",
"complete",
"downloading",
"downloaded",
"installed",
"instance_hold",
"error"
],
"description": "Omaha update status"
},
"omaha_version": {
"type": "string",
"description": "Omaha OS version using semantic versioning, e.g. 1590.0.0"
},
"machineid": {
"type": "string",
"description": "Unique machine id of the host"
},
"omaha_group": {
"type": "string",
"description": "The uuid if the channel that the host is attached to. Use alpha, beta or stable for built-in channels."
},
"oem": {
"type": "string",
"description": "OEM identifier"
}
},
"additionalProperties": false,
"required": [
"host",
"status",
"omaha_version",
"machineid",
"omaha_group"
]
}
},
"additionalProperties": false,
"required": [
"report"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/omaha_reports/{id}": {
"get": {
"tags": [
"omaha_reports"
],
"consumes": [
"application/json"
],
"operationId": "get_omaha_reports_id",
"summary": "Show a omaha report",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"omaha_reports"
],
"consumes": [
"application/json"
],
"operationId": "delete_omaha_reports_id",
"summary": "Delete a omaha report",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/hosts/{host_id}/omaha_reports/last": {
"get": {
"tags": [
"omaha_reports"
],
"consumes": [
"application/json"
],
"operationId": "get_hosts_host_id_omaha_reports_last",
"summary": "Show the last report for a host",
"parameters": [
{
"name": "id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true,
"description": "ID of host"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/omaha_groups": {
"get": {
"tags": [
"omaha_groups"
],
"consumes": [
"application/json"
],
"operationId": "get_omaha_groups",
"summary": "List all omaha groups",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/omaha_groups/{id}": {
"get": {
"tags": [
"omaha_groups"
],
"consumes": [
"application/json"
],
"operationId": "get_omaha_groups_id",
"summary": "Show a Omaha Group",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true,
"description": "Id of the Omaha Group"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_templates": {
"get": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_job_templates",
"summary": "List job templates",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_job_templates",
"summary": "Create a job template",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"job_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Template name"
},
"job_category": {
"type": "string",
"description": "Job category"
},
"description_format": {
"type": "string",
"description": "This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}."
},
"template": {
"type": "string"
},
"provider_type": {
"type": "string",
"enum": [
"SSH",
"Ansible"
],
"description": "Provider type"
},
"snippet": {
"type": "boolean"
},
"audit_comment": {
"type": "string"
},
"locked": {
"type": "boolean",
"description": "Whether or not the template is locked for editing"
},
"effective_user_attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "What user should be used to run the script (using sudo-like mechanisms)"
},
"overridable": {
"type": "boolean",
"description": "Whether it should be allowed to override the effective user from the invocation form."
},
"current_user": {
"type": "boolean",
"description": "Whether the current user login should be used as the effective user"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"name",
"job_category",
"template",
"provider_type"
]
}
},
"additionalProperties": false,
"required": [
"job_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/locations/{location_id}/job_templates": {
"get": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_locations_location_id_job_templates",
"summary": "List job templates per location",
"parameters": [
{
"name": "location_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/organizations/{organization_id}/job_templates": {
"get": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_organizations_organization_id_job_templates",
"summary": "List job templates per organization",
"parameters": [
{
"name": "organization_id",
"type": "number",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_templates/import": {
"post": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_job_templates_import",
"summary": "Import a job template from ERB",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"template": {
"type": "string",
"description": "Template ERB"
},
"overwrite": {
"type": "boolean",
"description": "Overwrite template if it already exists"
}
},
"additionalProperties": false,
"required": [
"template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_templates/{id}/export": {
"get": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_job_templates_id_export",
"summary": "Export a job template to ERB",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_templates/{id}": {
"get": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_job_templates_id",
"summary": "Show job template details",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "put_job_templates_id",
"summary": "Update a job template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"job_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Template name"
},
"job_category": {
"type": "string",
"description": "Job category"
},
"description_format": {
"type": "string",
"description": "This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}."
},
"template": {
"type": "string"
},
"provider_type": {
"type": "string",
"enum": [
"SSH",
"Ansible"
],
"description": "Provider type"
},
"snippet": {
"type": "boolean"
},
"audit_comment": {
"type": "string"
},
"locked": {
"type": "boolean",
"description": "Whether or not the template is locked for editing"
},
"effective_user_attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "What user should be used to run the script (using sudo-like mechanisms)"
},
"overridable": {
"type": "boolean",
"description": "Whether it should be allowed to override the effective user from the invocation form."
},
"current_user": {
"type": "boolean",
"description": "Whether the current user login should be used as the effective user"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"job_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "delete_job_templates_id",
"summary": "Delete a job template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_templates/revision": {
"get": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "get_job_templates_revision",
"parameters": [
{
"name": "version",
"type": "string",
"in": "query",
"description": "Template version"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_templates/{id}/clone": {
"post": {
"tags": [
"job_templates"
],
"consumes": [
"application/json"
],
"operationId": "post_job_templates_id_clone",
"summary": "Clone a provision template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"job_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Template name"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"additionalProperties": false,
"required": [
"job_template"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/remote_execution_features": {
"get": {
"tags": [
"remote_execution_features"
],
"consumes": [
"application/json"
],
"operationId": "get_remote_execution_features",
"summary": "List remote execution features",
"parameters": [],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/remote_execution_features/{id}": {
"get": {
"tags": [
"remote_execution_features"
],
"consumes": [
"application/json"
],
"operationId": "get_remote_execution_features_id",
"summary": "Show remote execution feature",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"remote_execution_features"
],
"consumes": [
"application/json"
],
"operationId": "put_remote_execution_features_id",
"summary": "Update a job template",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"remote_execution_feature": {
"type": "object",
"properties": {
"job_template_id": {
"type": "string",
"description": "Job template ID to be used for the feature"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"remote_execution_feature"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_invocations": {
"get": {
"tags": [
"job_invocations"
],
"consumes": [
"application/json"
],
"operationId": "get_job_invocations",
"summary": "List job invocations",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"job_invocations"
],
"consumes": [
"application/json"
],
"operationId": "post_job_invocations",
"summary": "Create a job invocation",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"job_invocation": {
"type": "object",
"properties": {
"job_template_id": {
"type": "string",
"description": "The job template to use, parameter is required unless feature was specified"
},
"targeting_type": {
"type": "string",
"description": "Invocation type, one of {\"static_query\"=>\"Static Query\", \"dynamic_query\"=>\"Dynamic Query\"}"
},
"inputs": {
"type": "object",
"additionalProperties": true,
"description": "Inputs to use"
},
"ssh": {
"type": "object",
"properties": {
"effective_user": {
"type": "string",
"description": "What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting."
}
},
"additionalProperties": false
},
"recurrence": {
"type": "object",
"properties": {
"cron_line": {
"type": "string",
"description": "How often the job should occur, in the cron format"
},
"max_iteration": {
"type": "number",
"description": "Repeat a maximum of N times"
},
"end_time": {
"type": "string",
"description": "Perform no more executions after this time"
}
},
"additionalProperties": false
},
"scheduling": {
"type": "object",
"properties": {
"start_at": {
"type": "string",
"description": "Schedule the job for a future time"
},
"start_before": {
"type": "string",
"description": "Indicates that the action should be cancelled if it cannot be started before this time."
}
},
"additionalProperties": false
},
"concurrency_control": {
"type": "object",
"properties": {
"time_span": {
"type": "number",
"description": "Distribute tasks over N seconds"
},
"concurrency_level": {
"type": "number",
"description": "Run at most N tasks at a time"
}
},
"additionalProperties": false
},
"bookmark_id": {
"type": "number"
},
"search_query": {
"type": "string"
},
"description_format": {
"type": "string",
"description": "Override the description format from the template for this invocation only"
},
"execution_timeout_interval": {
"type": "number",
"description": "Override the timeout interval from the template for this invocation only"
},
"feature": {
"type": "string",
"description": "Remote execution feature label that should be triggered, job template assigned to this feature will be used"
}
},
"additionalProperties": false,
"required": [
"targeting_type"
]
}
},
"additionalProperties": false,
"required": [
"job_invocation"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_invocations/{id}": {
"get": {
"tags": [
"job_invocations"
],
"consumes": [
"application/json"
],
"operationId": "get_job_invocations_id",
"summary": "Show job invocation",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_invocations/{id}/hosts/{host_id}": {
"get": {
"tags": [
"job_invocations"
],
"consumes": [
"application/json"
],
"operationId": "get_job_invocations_id_hosts_host_id",
"summary": "Get output for a host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "since",
"type": "string",
"in": "query"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_invocations/{id}/hosts/{host_id}/raw": {
"get": {
"tags": [
"job_invocations"
],
"consumes": [
"application/json"
],
"operationId": "get_job_invocations_id_hosts_host_id_raw",
"summary": "Get raw output for a host",
"parameters": [
{
"name": "host_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_invocations/{id}/cancel": {
"post": {
"tags": [
"job_invocations"
],
"consumes": [
"application/json"
],
"operationId": "post_job_invocations_id_cancel",
"summary": "Cancel job invocation",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"force": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_invocations/{id}/rerun": {
"post": {
"tags": [
"job_invocations"
],
"consumes": [
"application/json"
],
"operationId": "post_job_invocations_id_rerun",
"summary": "Rerun job on failed hosts",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"failed_only": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/templates/{template_id}/foreign_input_sets": {
"get": {
"tags": [
"foreign_input_sets"
],
"consumes": [
"application/json"
],
"operationId": "get_templates_template_id_foreign_input_sets",
"summary": "List foreign input sets",
"parameters": [
{
"name": "template_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"post": {
"tags": [
"foreign_input_sets"
],
"consumes": [
"application/json"
],
"operationId": "post_templates_template_id_foreign_input_sets",
"summary": "Create a foreign input set",
"parameters": [
{
"name": "template_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"foreign_input_set": {
"type": "object",
"properties": {
"target_template_id": {
"type": "string",
"description": "Target template ID"
},
"include_all": {
"type": "boolean",
"description": "Include all inputs from the foreign template"
},
"include": {
"type": "string",
"description": "A comma separated list of input names to be included from the foreign template."
},
"exclude": {
"type": "string",
"description": "A comma separated list of input names to be included from the foreign template."
},
"description": {
"type": "string",
"description": "Input set description"
}
},
"additionalProperties": false,
"required": [
"target_template_id"
]
}
},
"additionalProperties": false,
"required": [
"foreign_input_set"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/templates/{template_id}/foreign_input_sets/{id}": {
"get": {
"tags": [
"foreign_input_sets"
],
"consumes": [
"application/json"
],
"operationId": "get_templates_template_id_foreign_input_sets_id",
"summary": "Show foreign input set details",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "template_id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"foreign_input_sets"
],
"consumes": [
"application/json"
],
"operationId": "delete_templates_template_id_foreign_input_sets_id",
"summary": "Delete a foreign input set",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "template_id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"put": {
"tags": [
"foreign_input_sets"
],
"consumes": [
"application/json"
],
"operationId": "put_templates_template_id_foreign_input_sets_id",
"summary": "Update a foreign input set",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "template_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"foreign_input_set": {
"type": "object",
"properties": {
"target_template_id": {
"type": "string",
"description": "Target template ID"
},
"include_all": {
"type": "boolean",
"description": "Include all inputs from the foreign template"
},
"include": {
"type": "string",
"description": "A comma separated list of input names to be included from the foreign template."
},
"exclude": {
"type": "string",
"description": "A comma separated list of input names to be included from the foreign template."
},
"description": {
"type": "string",
"description": "Input set description"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"foreign_input_set"
]
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/job_invocations/{job_invocation_id}/template_invocations": {
"get": {
"tags": [
"template_invocations"
],
"consumes": [
"application/json"
],
"operationId": "get_job_invocations_job_invocation_id_template_invocations",
"summary": "List template invocations belonging to job invocation",
"parameters": [
{
"name": "job_invocation_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/templates/import": {
"post": {
"tags": [
"template"
],
"consumes": [
"application/json"
],
"operationId": "post_templates_import",
"summary": "Initiate Import",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"prefix": {
"type": "string",
"description": "The string all imported templates should begin with."
},
"associate": {
"type": "string",
"enum": [
"always",
"new",
"never"
],
"description": "Associate to OS's, Locations & Organizations. Options are: always, new or never."
},
"force": {
"type": "boolean",
"description": "Update templates that are locked"
},
"lock": {
"type": "boolean",
"description": "Lock imported templates"
},
"verbose": {
"type": "boolean",
"description": "Show template diff in response"
},
"branch": {
"type": "string",
"description": "Branch in Git repo."
},
"repo": {
"type": "string",
"description": "Override the default repo from settings."
},
"filter": {
"type": "string",
"description": "Export templates with names matching this regex (case-insensitive; snippets are not filtered)."
},
"negate": {
"type": "boolean",
"description": "Negate the prefix (for purging)."
},
"dirname": {
"type": "string",
"description": "The directory within Git repo containing the templates"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/templates/export": {
"post": {
"tags": [
"template"
],
"consumes": [
"application/json"
],
"operationId": "post_templates_export",
"summary": "Initiate Export",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"metadata_export_mode": {
"type": "string",
"enum": [
"refresh",
"keep",
"remove"
],
"description": "Specify how to handle metadata"
},
"branch": {
"type": "string",
"description": "Branch in Git repo."
},
"repo": {
"type": "string",
"description": "Override the default repo from settings."
},
"filter": {
"type": "string",
"description": "Export templates with names matching this regex (case-insensitive; snippets are not filtered)."
},
"negate": {
"type": "boolean",
"description": "Negate the prefix (for purging)."
},
"dirname": {
"type": "string",
"description": "The directory within Git repo containing the templates"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ansible_roles/{id}": {
"get": {
"tags": [
"ansible_roles"
],
"consumes": [
"application/json"
],
"operationId": "get_ansible_roles_id",
"summary": "Show role",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
},
"delete": {
"tags": [
"ansible_roles"
],
"consumes": [
"application/json"
],
"operationId": "delete_ansible_roles_id",
"summary": "Deletes Ansible role",
"parameters": [
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ansible_roles": {
"get": {
"tags": [
"ansible_roles"
],
"consumes": [
"application/json"
],
"operationId": "get_ansible_roles",
"summary": "List Ansible roles",
"parameters": [
{
"name": "search",
"type": "string",
"in": "query",
"description": "filter results"
},
{
"name": "order",
"type": "string",
"in": "query",
"description": "Sort field and order, eg. ‘id DESC’"
},
{
"name": "page",
"type": "string",
"in": "query",
"description": "paginate results"
},
{
"name": "per_page",
"type": "string",
"in": "query",
"description": "number of entries per request"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ansible_roles/import": {
"put": {
"tags": [
"ansible_roles"
],
"consumes": [
"application/json"
],
"operationId": "put_ansible_roles_import",
"summary": "Import Ansible roles",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"proxy_id": {
"type": "string",
"description": "Smart Proxy to import from"
},
"role_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "Ansible role names to import"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ansible_roles/obsolete": {
"put": {
"tags": [
"ansible_roles"
],
"consumes": [
"application/json"
],
"operationId": "put_ansible_roles_obsolete",
"summary": "Obsolete Ansible roles",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"proxy_id": {
"type": "string",
"description": "Smart Proxy to import from"
}
},
"additionalProperties": false
}
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
},
"/ansible_roles/fetch": {
"get": {
"tags": [
"ansible_roles"
],
"consumes": [
"application/json"
],
"operationId": "get_ansible_roles_fetch",
"summary": "Fetch Ansible roles available to be imported",
"parameters": [
{
"name": "proxy_id",
"type": "string",
"in": "query",
"description": "Smart Proxy to fetch from"
}
],
"responses": {
"200": {
"description": "ok"
}
},
"description": ""
}
}
},
"definitions": {},
"tags": [
{
"name": "ansible_roles",
"description": ""
},
{
"name": "architectures",
"description": ""
},
{
"name": "audits",
"description": ""
},
{
"name": "auth_source_externals",
"description": ""
},
{
"name": "auth_source_internals",
"description": ""
},
{
"name": "auth_source_ldaps",
"description": ""
},
{
"name": "auth_sources",
"description": ""
},
{
"name": "autosign",
"description": ""
},
{
"name": "bookmarks",
"description": ""
},
{
"name": "common_parameters",
"description": ""
},
{
"name": "compute_attributes",
"description": ""
},
{
"name": "compute_profiles",
"description": ""
},
{
"name": "compute_resources",
"description": ""
},
{
"name": "config_groups",
"description": ""
},
{
"name": "config_reports",
"description": ""
},
{
"name": "config_templates",
"description": ""
},
{
"name": "dashboard",
"description": ""
},
{
"name": "domains",
"description": ""
},
{
"name": "environments",
"description": ""
},
{
"name": "external_usergroups",
"description": ""
},
{
"name": "fact_values",
"description": ""
},
{
"name": "filters",
"description": ""
},
{
"name": "foreign_input_sets",
"description": ""
},
{
"name": "foreman_tasks",
"description": ""
},
{
"name": "home",
"description": ""
},
{
"name": "host_classes",
"description": ""
},
{
"name": "hostgroup_classes",
"description": ""
},
{
"name": "hostgroups",
"description": ""
},
{
"name": "hosts",
"description": ""
},
{
"name": "http_proxies",
"description": ""
},
{
"name": "images",
"description": ""
},
{
"name": "interfaces",
"description": ""
},
{
"name": "job_invocations",
"description": ""
},
{
"name": "job_templates",
"description": ""
},
{
"name": "locations",
"description": ""
},
{
"name": "mail_notifications",
"description": ""
},
{
"name": "media",
"description": ""
},
{
"name": "models",
"description": ""
},
{
"name": "omaha_groups",
"description": ""
},
{
"name": "omaha_reports",
"description": ""
},
{
"name": "operatingsystems",
"description": ""
},
{
"name": "organizations",
"description": ""
},
{
"name": "os_default_templates",
"description": ""
},
{
"name": "override_values",
"description": ""
},
{
"name": "parameters",
"description": ""
},
{
"name": "permissions",
"description": ""
},
{
"name": "personal_access_tokens",
"description": ""
},
{
"name": "plugins",
"description": ""
},
{
"name": "provisioning_templates",
"description": ""
},
{
"name": "ptables",
"description": ""
},
{
"name": "puppet_hosts",
"description": ""
},
{
"name": "puppetclasses",
"description": ""
},
{
"name": "realms",
"description": ""
},
{
"name": "recurring_logics",
"description": ""
},
{
"name": "remote_execution_features",
"description": ""
},
{
"name": "report_templates",
"description": ""
},
{
"name": "reports",
"description": ""
},
{
"name": "roles",
"description": ""
},
{
"name": "settings",
"description": ""
},
{
"name": "smart_class_parameters",
"description": ""
},
{
"name": "smart_proxies",
"description": ""
},
{
"name": "smart_variables",
"description": ""
},
{
"name": "ssh_keys",
"description": ""
},
{
"name": "statistics",
"description": ""
},
{
"name": "subnets",
"description": ""
},
{
"name": "table_preferences",
"description": ""
},
{
"name": "tasks",
"description": ""
},
{
"name": "template",
"description": ""
},
{
"name": "template_combinations",
"description": ""
},
{
"name": "template_inputs",
"description": ""
},
{
"name": "template_invocations",
"description": ""
},
{
"name": "template_kinds",
"description": ""
},
{
"name": "trends",
"description": ""
},
{
"name": "usergroups",
"description": ""
},
{
"name": "users",
"description": ""
}
],
"host": "localhost:3000"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment