GET /api/organizations
List all organizations

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
optional

filter results

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
description
id
name
organization_id
title

GET /api/organizations/:id
Show an organization

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

show_hidden_parameters
optional

Display hidden parameter values

Validations:

  • Must be one of: true, false, 1, 0.

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/organizations
Create an organization

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

organization
required

Validations:

  • Must be a Hash

organization[name]
required

Validations:

  • Must be a String

organization[description]
optional , nil allowed

Validations:

  • Must be a String

organization[user_ids]
optional , nil allowed

User IDs

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
optional , nil allowed

Smart proxy IDs

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
optional , nil allowed

Compute resource IDs

Validations:

  • Must be an array of any type

organization[medium_ids]
optional , nil allowed

Medium IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
optional , nil allowed

Partition template IDs

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
optional , nil allowed

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[domain_ids]
optional , nil allowed

Domain IDs

Validations:

  • Must be an array of any type

organization[realm_ids]
optional , nil allowed

Realm IDs

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
optional , nil allowed

Host group IDs

Validations:

  • Must be an array of any type

organization[environment_ids]
optional , nil allowed

Environment IDs

Validations:

  • Must be an array of any type

organization[subnet_ids]
optional , nil allowed

Subnet IDs

Validations:

  • Must be an array of any type

organization[parent_id]
optional , nil allowed

Parent ID

Validations:

  • Must be a number.

organization[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

organization[location_ids]
optional , nil allowed

Associated location IDs

Validations:

  • Must be an array of any type


PUT /api/organizations/:id
Update an organization

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

organization
required

Validations:

  • Must be a Hash

organization[name]
optional

Validations:

  • Must be a String

organization[description]
optional , nil allowed

Validations:

  • Must be a String

organization[user_ids]
optional , nil allowed

User IDs

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
optional , nil allowed

Smart proxy IDs

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
optional , nil allowed

Compute resource IDs

Validations:

  • Must be an array of any type

organization[medium_ids]
optional , nil allowed

Medium IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
optional , nil allowed

Partition template IDs

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
optional , nil allowed

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[domain_ids]
optional , nil allowed

Domain IDs

Validations:

  • Must be an array of any type

organization[realm_ids]
optional , nil allowed

Realm IDs

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
optional , nil allowed

Host group IDs

Validations:

  • Must be an array of any type

organization[environment_ids]
optional , nil allowed

Environment IDs

Validations:

  • Must be an array of any type

organization[subnet_ids]
optional , nil allowed

Subnet IDs

Validations:

  • Must be an array of any type

organization[parent_id]
optional , nil allowed

Parent ID

Validations:

  • Must be a number.

organization[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

organization[location_ids]
optional , nil allowed

Associated location IDs

Validations:

  • Must be an array of any type

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


DELETE /api/organizations/:id
Delete an organization

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.