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": "2020-11-04 13:53:46 UTC",
      "updated_at": "2020-11-04 13:53:46 UTC",
      "name": "global_puppetmaster",
      "id": 153855663
    },
    {
      "created_at": "2020-11-04 13:53:46 UTC",
      "updated_at": "2020-11-04 13:53:46 UTC",
      "name": "production",
      "id": 334344675
    },
    {
      "created_at": "2020-11-04 13:53:46 UTC",
      "updated_at": "2020-11-04 13:53:46 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

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
location string
location_id integer
name string
organization string
organization_id integer