Resource Attributes
This page lists the available attributes when creating resources with the REST API
Arbitration Profile Attributes
POST /api/arbitration_profiles
Arbitration Rule Attributes
POST /api/arbitration_rules
Chargeback Rate Attributes
POST /api/rates
Required attributes:
Attribute | Type | Description |
---|---|---|
chargeback_rate_id |
integer |
Reference to parent Chargeback |
group |
string |
Group rate belongs to, i.e. cpu, memory, net_io, disk_io, etc. |
source |
string |
The input value for calculation, i.e. allocated, used, etc. |
Optional attributes:
Attribute | Type | Description |
---|---|---|
description |
string |
Description of the chargeback rate |
enabled |
boolean |
Rate enabled flag |
friendly_rate |
string |
Friendly name of the rate |
metric |
string |
Metrics, i.e. derived_memory_available, etc. |
per_time |
string |
Measured per time, hourly, daily, weekly, monthly or yearly |
per_unit |
string |
Measured per unit, i.e. megabytes, gigabytes, etc. |
Group Attributes
POST /api/groups
Provider Attributes
POST /api/providers
Required attributes:
Attribute | Type | Description |
---|---|---|
name |
string |
Name of the provider |
type |
string |
Provider class |
hostname |
string |
Hostname of the Provider |
Optional attributes:
Attribute | Type | Description |
---|---|---|
api_version |
string |
API Version for communicating with the Provider |
credentials |
hash |
Credentials to use for communicating with the Provider, see Provider Support for examples |
host_default_vnc_port_start |
integer |
Starting VNC port |
host_default_vnc_port_end |
integer |
Ending VNC port |
ipaddress |
string |
IP Address of the Provider |
realm |
string |
Realm of the Provider |
zone |
hash |
In which zone to add provider to, hash needs to include an href or id attribute. |
Credentials hash specification attributes are:
Type | Auth Types | Auth Attributes |
---|---|---|
ManageIQ::Providers::Amazon::CloudManager |
default |
userid, password |
ManageIQ::Providers::Atomic::ContainerManager |
default, password, bearer |
userid, password |
ManageIQ::Providers::Azure::CloudManager |
default |
userid, password |
ManageIQ::Providers::Kubernetes::ContainerManager |
default, password, bearer |
userid, password |
ManageIQ::Providers::Microsoft::InfraManager |
default |
userid, password |
ManageIQ::Providers::Openshift::ContainerManager |
default, password, bearer |
userid, password, auth_key |
ManageIQ::Providers::Openstack::InfraManager |
default, amqp, ssh_keypair |
userid, password, auth_key |
ManageIQ::Providers::Openstack::CloudManager |
default, amqp |
userid, password |
ManageIQ::Providers::Redhat::InfraManager |
default, metrics |
userid, password |
ManageIQ::Providers::Vmware::InfraManager |
default |
userid, password |
ManageIQ::Providers::Foreman::Provider |
default |
userid, password |
ManageIQ::Providers::Openstack::Provider |
default |
userid, password |
Service Catalog Attributes
POST /api/service_catalogs
Attribute | Type | Description |
---|---|---|
name |
string |
Name of service catalog |
description |
string |
Description of service catalog |
Tag Attributes
POST /api/tags
Required attributes:
Attribute | Type | Description |
---|---|---|
name |
string |
Name of tag |
description |
string |
Description of tag |
category |
hash |
Category identifier for which the tag is getting added to, requires an href, id or name attribute in the hash |
When adding with a create action on the tags subcollection of the category via /api/categories/:id/tags, the category should not be specified in the resource. |
Tenant Attributes
POST /api/tenants
Required attributes:
Attribute | Type | Description |
---|---|---|
name |
string |
Name of Tenant |
parent |
hash |
Parent tenant identifier for which the sub-tenant is getting added to, requires an href or id attribute in the hash |
Optional attributes:
Attribute | Type | Description |
---|---|---|
description |
string |
Description of Tenant |
domain |
string |
Domain |
logo_file_name |
string |
Logo file name, must be available via /uploads/logo_file_name |
login_logo_file_name |
string |
Login Logo file name, must be available via /uploads/login_logo_file_name |
login_text |
string |
Login text |
subdomain |
string |
Subdomain |