Puppetclasses

>>>

GET /api/puppetclasses
List all Puppet classes

GET /api/hosts/:host_id/puppetclasses
List all Puppet classes for a host

GET /api/hostgroups/:hostgroup_id/puppetclasses
List all Puppet classes for a host group

GET /api/environments/:environment_id/puppetclasses
List all Puppet classes for an environment

Examples

GET /api/puppetclasses
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": {
    "class39": [
      {
        "id": 1018350796,
        "name": "class39",
        "created_at": "2021-05-19T07:26:32.331Z",
        "updated_at": "2021-05-19T07:26:32.331Z"
      }
    ]
  }
}

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
host_id
optional

ID of host

Validations:

  • Must be a String
hostgroup_id
optional

ID of host group

Validations:

  • Must be a String
environment_id
optional

ID of environment

Validations:

  • Must be a String
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, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
config_group string
environment string
host string
hostgroup string
key string
location string
name string
organization string
>>>

GET /api/puppetclasses/:id
Show a Puppet class

GET /api/hosts/:host_id/puppetclasses/:id
Show a Puppet class for host

GET /api/hostgroups/:hostgroup_id/puppetclasses/:id
Show a Puppet class for a host group

GET /api/environments/:environment_id/puppetclasses/:id
Show a Puppet class for an environment

Examples

GET /api/environments/production/puppetclasses/980190962
200
{
  "created_at": "2021-05-19 08:00:34 UTC",
  "updated_at": "2021-05-19 08:00:34 UTC",
  "id": 980190962,
  "name": "base",
  "module_name": "base",
  "environments": [
    {
      "name": "production",
      "id": 334344675
    }
  ],
  "hostgroups": [
    {
      "id": 636252244,
      "name": "Common",
      "title": "Common",
      "description": null
    }
  ],
  "smart_class_parameters": [
    {
      "parameter": "cluster",
      "id": 328495940
    }
  ]
}

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
host_id
optional

ID of host

Validations:

  • Must be a String
hostgroup_id
optional

ID of host group

Validations:

  • Must be a String
environment_id
optional

ID of environment

Validations:

  • Must be a String
id
required

ID of Puppet class

Validations:

  • Must be a String
>>>

POST /api/puppetclasses
Create a Puppet class

Examples

POST /api/puppetclasses
{
  "puppetclass": {
    "name": "test_puppetclass"
  }
}
201
{
  "created_at": "2021-05-19 08:00:42 UTC",
  "updated_at": "2021-05-19 08:00:42 UTC",
  "id": 1018350798,
  "name": "test_puppetclass",
  "module_name": "test_puppetclass",
  "environments": [],
  "hostgroups": [],
  "smart_class_parameters": []
}

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

Validations:

  • Must be a Hash
puppetclass[name]
required

Validations:

  • Must be a String
>>>

PUT /api/puppetclasses/:id
Update a Puppet class

Examples

PUT /api/puppetclasses/980190962-base
{
  "puppetclass": {
    "name": "test_puppetclass"
  }
}
200
{
  "created_at": "2021-05-19 08:00:34 UTC",
  "updated_at": "2021-05-19 08:00:42 UTC",
  "id": 980190962,
  "name": "test_puppetclass",
  "module_name": "test_puppetclass",
  "environments": [
    {
      "name": "production",
      "id": 334344675
    }
  ],
  "hostgroups": [
    {
      "id": 636252244,
      "name": "Common",
      "title": "Common",
      "description": null
    }
  ],
  "smart_class_parameters": [
    {
      "parameter": "cluster",
      "id": 328495940
    }
  ]
}

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 a String
puppetclass
required

Validations:

  • Must be a Hash
puppetclass[name]
optional

Validations:

  • Must be a String
>>>

DELETE /api/puppetclasses/:id
Delete a Puppet class

Examples

DELETE /api/puppetclasses/980190962-base
{
  "puppetclass": {}
}
200
{
  "id": 980190962,
  "name": "base",
  "created_at": "2021-05-19T08:00:34.611Z",
  "updated_at": "2021-05-19T08:00:34.611Z"
}

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 a String