GET /api/organizations
List all organizations

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

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

paginate results

Validations:

  • Must be a String

per_page
Optional

number of entries per request

Validations:

  • Must be a String


GET /api/organizations/:id
Show an organization

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

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

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

organization
Required

Validations:

  • Must be a Hash

organization[name]
Required

Validations:

  • Must be a String

organization[description]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

organization[user_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

User IDs

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Smart proxy IDs

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Compute resource IDs

Validations:

  • Must be an array of any type

organization[medium_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Medium IDs

Validations:

  • Must be an array of any type

organization[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Partition template IDs

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[domain_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Domain IDs

Validations:

  • Must be an array of any type

organization[realm_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Realm IDs

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Host group IDs

Validations:

  • Must be an array of any type

organization[environment_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Environment IDs

Validations:

  • Must be an array of any type

organization[subnet_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Subnet IDs

Validations:

  • Must be an array of any type

organization[parent_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Parent ID

Validations:

  • Must be a number.

organization[ignore_types]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type


PUT /api/organizations/:id
Update an organization

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

organization
Required

Validations:

  • Must be a Hash

organization[name]
Optional

Validations:

  • Must be a String

organization[description]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

organization[user_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

User IDs

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Smart proxy IDs

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Compute resource IDs

Validations:

  • Must be an array of any type

organization[medium_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Medium IDs

Validations:

  • Must be an array of any type

organization[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Partition template IDs

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

organization[domain_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Domain IDs

Validations:

  • Must be an array of any type

organization[realm_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Realm IDs

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Host group IDs

Validations:

  • Must be an array of any type

organization[environment_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Environment IDs

Validations:

  • Must be an array of any type

organization[subnet_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Subnet IDs

Validations:

  • Must be an array of any type

organization[parent_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Parent ID

Validations:

  • Must be a number.

organization[ignore_types]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

List of resources types that will be automatically associated

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

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

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.