Config groups

>>>

GET /api/config_groups
Llista dels grups de configuracions

Params

Param Name Description
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
class string
name string
>>>

GET /api/config_groups/:id
Mostra un grup de configuracions

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

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/config_groups
Crea un grup de configuracions

Examples

POST /api/config_groups
{
  "config_group": {
    "name": "config-group",
    "puppetclass_ids": [
      980190962,
      281110143
    ]
  }
}
201
{
  "created_at": "2019-09-11 14:38:32 UTC",
  "updated_at": "2019-09-11 14:38:32 UTC",
  "id": 980190963,
  "name": "config-group",
  "puppetclasses": [
    {
      "id": 980190962,
      "name": "base",
      "module_name": "base"
    },
    {
      "id": 281110143,
      "name": "vim",
      "module_name": "vim"
    }
  ]
}

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
config_group
Required

Validations:

  • Must be a Hash
config_group[name]
Required

Validations:

  • Must be a String
config_group[puppetclass_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
>>>

PUT /api/config_groups/:id
Actualitza un grup de configuracions

Examples

PUT /api/config_groups/980190962-Monitoring
{
  "config_group": {
    "name": "new name",
    "puppetclass_ids": [
      980190962,
      281110143
    ]
  }
}
200
{
  "created_at": "2019-09-11 14:38:12 UTC",
  "updated_at": "2019-09-11 14:38:32 UTC",
  "id": 980190962,
  "name": "new name",
  "puppetclasses": [
    {
      "id": 980190962,
      "name": "base",
      "module_name": "base"
    },
    {
      "id": 281110143,
      "name": "vim",
      "module_name": "vim"
    }
  ]
}

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be a String
config_group
Required

Validations:

  • Must be a Hash
config_group[name]
Optional

Validations:

  • Must be a String
config_group[puppetclass_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
>>>

DELETE /api/config_groups/:id
Suprimeix un grup de configuracions

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be a String