GET /api/lookup_keys
List all lookup_keys.

Params

Param name Description
search
optional

filter results

Validations:

  • Must be String

order
optional

sort results

Validations:

  • Must be String

page
optional

paginate results

Validations:

  • Must be String

per_page
optional

number of entries per request

Validations:

  • Must be String


GET /api/lookup_keys/:id
Show a lookup key.

Params

Param name Description
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/lookup_keys
Create a lookup key.

Params

Param name Description
lookup_key
required

Validations:

  • Must be a Hash

lookup_key[key]
required

Validations:

  • Must be String

lookup_key[puppetclass_id]
optional

Validations:

  • Must be a number.

lookup_key[default_value]
optional

Validations:

  • Must be String

lookup_key[path]
optional

Validations:

  • Must be String

lookup_key[description]
optional

Validations:

  • Must be String

lookup_key[lookup_values_count]
optional

Validations:

  • Must be a number.


PUT /api/lookup_keys/:id
Update a lookup key.

Params

Param name Description
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.

lookup_key
required

Validations:

  • Must be a Hash

lookup_key[key]
optional

Validations:

  • Must be String

lookup_key[puppetclass_id]
optional

Validations:

  • Must be a number.

lookup_key[default_value]
optional

Validations:

  • Must be String

lookup_key[path]
optional

Validations:

  • Must be String

lookup_key[description]
optional

Validations:

  • Must be String

lookup_key[lookup_values_count]
optional

Validations:

  • Must be a number.


DELETE /api/lookup_keys/:id
Delete a lookup key.

Params

Param name Description
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.