Params

Param name Description
organization_id
optional

organization identifier

Validations:

  • number.

library
optional

set true if you want to see only library environments

Validations:

  • Must be one of: true, false.

name
optional

filter only environments containing this name

Validations:

  • String

search
optional

Search string

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • number.

per_page
optional

Number of results per page to return

Validations:

  • number.

order
optional

Sort field and order, eg. ‘name DESC’

Validations:

  • String

full_result
optional

Whether or not to show all results

Validations:

  • boolean

sort
optional

Hash version of ‘order’ param

Validations:

  • Hash

sort[by]
optional

Field to sort the results on

Validations:

  • String

sort[order]
optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String