GET /api/organizations
List all organizations

Params

Param name Description
search
optional

filter results


Value:

Must be String

order
optional

sort results


Value:

Must be String

page
optional

paginate results


Value:

Must be String

per_page
optional

number of entries per request


Value:

Must be String


GET /api/organizations/:id
Show an organization


POST /api/organizations
Create an organization

Params

Param name Description
organization
required

Value:

Must be a Hash

organization[name]
required

Value:

Must be String

organization[description]
optional , nil allowed

Value:

Must be String

organization[user_ids]
optional , nil allowed

User IDs


Value:

Must be an array of any type

organization[smart_proxy_ids]
optional , nil allowed

Smart proxy IDs


Value:

Must be an array of any type

organization[compute_resource_ids]
optional , nil allowed

Compute resource IDs


Value:

Must be an array of any type

organization[media_ids]
optional , nil allowed

Media IDs


Value:

Must be an array of any type

organization[config_template_ids]
optional , nil allowed

Provisioning template IDs


Value:

Must be an array of any type

organization[ptable_ids]
optional , nil allowed

Partition template IDs


Value:

Must be an array of any type

organization[provisioning_template_ids]
optional , nil allowed

Provisioning template IDs


Value:

Must be an array of any type

organization[domain_ids]
optional , nil allowed

Domain IDs


Value:

Must be an array of any type

organization[realm_ids]
optional , nil allowed

Realm IDs


Value:

Must be an array of any type

organization[hostgroup_ids]
optional , nil allowed

Host group IDs


Value:

Must be an array of any type

organization[environment_ids]
optional , nil allowed

Environment IDs


Value:

Must be an array of any type

organization[subnet_ids]
optional , nil allowed

Subnet IDs


Value:

Must be an array of any type

organization[parent_id]
optional , nil allowed

Parent ID


Value:

Must be a number.


PUT /api/organizations/:id
Update an organization

Params

Param name Description
organization
required

Value:

Must be a Hash

organization[name]
optional

Value:

Must be String

organization[description]
optional , nil allowed

Value:

Must be String

organization[user_ids]
optional , nil allowed

User IDs


Value:

Must be an array of any type

organization[smart_proxy_ids]
optional , nil allowed

Smart proxy IDs


Value:

Must be an array of any type

organization[compute_resource_ids]
optional , nil allowed

Compute resource IDs


Value:

Must be an array of any type

organization[media_ids]
optional , nil allowed

Media IDs


Value:

Must be an array of any type

organization[config_template_ids]
optional , nil allowed

Provisioning template IDs


Value:

Must be an array of any type

organization[ptable_ids]
optional , nil allowed

Partition template IDs


Value:

Must be an array of any type

organization[provisioning_template_ids]
optional , nil allowed

Provisioning template IDs


Value:

Must be an array of any type

organization[domain_ids]
optional , nil allowed

Domain IDs


Value:

Must be an array of any type

organization[realm_ids]
optional , nil allowed

Realm IDs


Value:

Must be an array of any type

organization[hostgroup_ids]
optional , nil allowed

Host group IDs


Value:

Must be an array of any type

organization[environment_ids]
optional , nil allowed

Environment IDs


Value:

Must be an array of any type

organization[subnet_ids]
optional , nil allowed

Subnet IDs


Value:

Must be an array of any type

organization[parent_id]
optional , nil allowed

Parent ID


Value:

Must be a number.


DELETE /api/organizations/:id
Delete an organization