Template combinations

>>>

GET /api/provisioning_templates/:provisioning_template_id/template_combinations
List template combination

GET /api/hostgroups/:hostgroup_id/template_combinations
List template combination

GET /api/environments/:environment_id/template_combinations
List template combination

Examples

GET /api/provisioning_templates/269958254/template_combinations
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2020-05-20 13:33:00 UTC",
      "updated_at": "2020-05-20 13:33:00 UTC",
      "id": 298486374,
      "provisioning_template_id": 269958254,
      "provisioning_template_name": "MyString2",
      "hostgroup_id": null,
      "hostgroup_name": null,
      "environment_id": null,
      "environment_name": null
    },
    {
      "created_at": "2020-05-20 13:33:00 UTC",
      "updated_at": "2020-05-20 13:33:00 UTC",
      "id": 281110143,
      "provisioning_template_id": 269958254,
      "provisioning_template_name": "MyString2",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common",
      "environment_id": 334344675,
      "environment_name": "production"
    }
  ]
}

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

ID of config template

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

POST /api/provisioning_templates/:provisioning_template_id/template_combinations
Add a template combination

POST /api/hostgroups/:hostgroup_id/template_combinations
Add a template combination

POST /api/environments/:environment_id/template_combinations
Add a template combination

Examples

POST /api/provisioning_templates/269958254/template_combinations
{
  "template_combination": {
    "environment_id": 334344675,
    "hostgroup_id": 866317115
  }
}
201
{
  "created_at": "2020-05-20 13:33:55 UTC",
  "updated_at": "2020-05-20 13:33:55 UTC",
  "id": 1018350796,
  "provisioning_template_id": 269958254,
  "provisioning_template_name": "MyString2",
  "hostgroup_id": 866317115,
  "hostgroup_name": "Unusual",
  "environment_id": 334344675,
  "environment_name": "production"
}

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

ID of config template

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

Validations:

  • Must be a Hash
template_combination[environment_id]
optional , nil allowed

environment id

Validations:

  • Must be a number.
template_combination[hostgroup_id]
optional , nil allowed

host group id

Validations:

  • Must be a number.
>>>

GET /api/template_combinations/:id
Show template combination

GET /api/provisioning_templates/:provisioning_template_id/template_combinations/:id
Show template combination

GET /api/hostgroups/:hostgroup_id/template_combinations/:id
Show template combination

GET /api/environments/:environment_id/template_combinations/:id
Show template combination

Examples

GET /api/template_combinations/281110143
200
{
  "created_at": "2020-05-20 13:33:00 UTC",
  "updated_at": "2020-05-20 13:33:00 UTC",
  "id": 281110143,
  "provisioning_template_id": 269958254,
  "provisioning_template_name": "MyString2",
  "hostgroup_id": 636252244,
  "hostgroup_name": "Common",
  "environment_id": 334344675,
  "environment_name": "production"
}

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

ID of config template

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

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

PUT /api/provisioning_templates/:provisioning_template_id/template_combinations/:id
Update template combination

PUT /api/hostgroups/:hostgroup_id/template_combinations/:id
Update template combination

PUT /api/environments/:environment_id/template_combinations/:id
Update template combination

Examples

PUT /api/provisioning_templates/269958254/template_combinations/298486374
{
  "template_combination": {
    "environment_id": 687036937,
    "hostgroup_id": 636252244
  }
}
200
{
  "created_at": "2020-05-20 13:33:00 UTC",
  "updated_at": "2020-05-20 13:33:55 UTC",
  "id": 298486374,
  "provisioning_template_id": 269958254,
  "provisioning_template_name": "MyString2",
  "hostgroup_id": 636252244,
  "hostgroup_name": "Common",
  "environment_id": 687036937,
  "environment_name": "testing"
}

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

ID of config template

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

Validations:

  • Must be a Hash
template_combination[environment_id]
optional , nil allowed

environment id

Validations:

  • Must be a number.
template_combination[hostgroup_id]
optional , nil allowed

host group id

Validations:

  • Must be a number.
>>>

DELETE /api/template_combinations/:id
Delete a template combination

Examples

DELETE /api/template_combinations/281110143
{
  "template_combination": {}
}
200
{
  "id": 281110143,
  "provisioning_template_id": 269958254,
  "hostgroup_id": 636252244,
  "environment_id": 334344675,
  "created_at": "2020-05-20T13:33:00.770Z",
  "updated_at": "2020-05-20T13:33:00.770Z"
}

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.