Environments

>>>

POST /api/smart_proxies/:id/import_puppetclasses
Import puppet classes from puppet proxy

POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses
Import puppet classes from puppet proxy for an environment

POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses
Import puppet classes from puppet proxy for an environment

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.
smart_proxy_id
optional

Validations:

  • Must be a String
environment_id
optional

Validations:

  • Must be a String
dryrun
optional

Validations:

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

Optional comma-delimited string containing either 'new', 'updated', or 'obsolete' that is used to limit the imported Puppet classes

Validations:

  • Must be a String
>>>

GET /api/environments
Llista tots els entorns

GET /api/puppetclasses/:puppetclass_id/environments
Llista tots els entorns de la classe Puppet

GET /api/locations/:location_id/environments
Llista tots els entorns per ubicació

GET /api/organizations/:organization_id/environments
Llista tots els entorns per organització

Params

Param name Description
puppetclass_id
optional

ID de classe de Puppet

Validations:

  • Must be a String
location_id
optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
optional

Abast per organitzacions

Validations:

  • Must be a Integer
search
optional

filtra els resultats

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

Nombre de resultats per pàgina a retornar

Validations:

  • Must be a number.

Search fields

Field name Tipus Possible values
location
location_id
name
organization
organization_id
>>>

GET /api/environments/:id
Mostra un entorn

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.
>>>

POST /api/environments
Crea un entorn

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
environment
required

Validations:

  • Must be a Hash
environment[name]
required

Validations:

  • Must be a String
environment[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
environment[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
>>>

PUT /api/environments/:id
Actualitza un entorn

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.
environment
required

Validations:

  • Must be a Hash
environment[name]
optional

Validations:

  • Must be a String
environment[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
environment[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
>>>

DELETE /api/environments/:id
Suprimeix un entorn

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.