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

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.

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
List all environments

GET /api/puppetclasses/:puppetclass_id/environments
List environments of Puppet class

GET /api/locations/:location_id/environments
List environments per location

GET /api/organizations/:organization_id/environments
List environments per organization

Examples

GET /api/environments
200
{
  "total": 3,
  "subtotal": 3,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "name": "global_puppetmaster",
      "id": 153855663
    },
    {
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "name": "production",
      "id": 334344675
    },
    {
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "name": "testing",
      "id": 687036937
    }
  ]
}

Params

Param name Description
puppetclass_id
optional

ID of Puppet class

Validations:

  • Must be a String

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

Search fields

Field name Type Possible values
location string
location_id integer
name string
organization string
organization_id integer

GET /api/environments/:id
Show an environment

Examples

GET /api/environments/production
200
{
  "created_at": "2018-11-15 19:01:27 UTC",
  "updated_at": "2018-11-15 19:01:27 UTC",
  "name": "production",
  "id": 334344675,
  "template_combinations": [
    {
      "id": 113629430,
      "provisioning_template_id": 104314179,
      "provisioning_template_name": "MyFinish",
      "hostgroup_id": null,
      "hostgroup_name": null,
      "environment_id": 334344675,
      "environment_name": "production",
      "config_template_id": 104314179,
      "config_template_name": "MyFinish"
    },
    {
      "id": 281110143,
      "provisioning_template_id": 269958254,
      "provisioning_template_name": "MyString2",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common",
      "environment_id": 334344675,
      "environment_name": "production",
      "config_template_id": 269958254,
      "config_template_name": "MyString2"
    },
    {
      "id": 980190962,
      "provisioning_template_id": 943779058,
      "provisioning_template_name": "MyString",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common",
      "environment_id": 334344675,
      "environment_name": "production",
      "config_template_id": 943779058,
      "config_template_name": "MyString"
    },
    {
      "id": 1018350795,
      "provisioning_template_id": 981457253,
      "provisioning_template_name": "MyScript",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common",
      "environment_id": 334344675,
      "environment_name": "production",
      "config_template_id": 981457253,
      "config_template_name": "MyScript"
    }
  ],
  "puppetclasses": [
    {
      "id": 298486374,
      "name": "apache",
      "module_name": "apache"
    },
    {
      "id": 638205575,
      "name": "auth",
      "module_name": "auth"
    },
    {
      "id": 980190962,
      "name": "base",
      "module_name": "base"
    },
    {
      "id": 51848956,
      "name": "chkmk",
      "module_name": "chkmk"
    },
    {
      "id": 1018350795,
      "name": "nagios",
      "module_name": "nagios"
    },
    {
      "id": 374648174,
      "name": "pam",
      "module_name": "pam"
    },
    {
      "id": 281110143,
      "name": "vim",
      "module_name": "vim"
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

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.


POST /api/environments
Create an environment

Examples

POST /api/environments
{
  "environment": {
    "name": "some_environment",
    "location_ids": [
      255093256
    ]
  }
}
201
{
  "created_at": "2018-11-15 19:01:57 UTC",
  "updated_at": "2018-11-15 19:01:57 UTC",
  "name": "some_environment",
  "id": 687036938,
  "template_combinations": [],
  "puppetclasses": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "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

environment
required

Validations:

  • Must be a Hash

environment[name]
required

Validations:

  • Must be a String

environment[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

environment[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


PUT /api/environments/:id
Update an environment

Examples

POST /api/environments/687036938
{
  "environment": {
    "name": "Z6QAANhXBK"
  }
}
201
{
  "created_at": "2018-11-15 19:01:58 UTC",
  "updated_at": "2018-11-15 19:01:58 UTC",
  "name": "Z6QAANhXBK",
  "id": 687036938,
  "template_combinations": [],
  "puppetclasses": [],
  "locations": [],
  "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

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

REPLACE locations with given ids

Validations:

  • Must be an array of any type

environment[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


DELETE /api/environments/:id
Delete an environment

Examples

DELETE /api/environments/testing
{
  "environment": {}
}
200
{
  "id": 687036937,
  "name": "testing",
  "created_at": "2018-11-15T19:01:27.706Z",
  "updated_at": "2018-11-15T19:01:27.706Z"
}

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.