Params

Param name Description
organization_id
required

organization identifier

Validations:

  • Must be a number.

environment_id
optional

environment identifier

Validations:

  • Must be a number.

content_view_id
optional

content view identifier

Validations:

  • Must be a number.

name
optional

activation key name to filter by

Validations:

  • String

content_view_environments
optional

Comma-separated list of content view environment labels associated with the activation key, in the format of 'lifecycle_environment_label/content_view_label'. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on.

Validations:

  • Must be an array of any type

content_view_environment_ids
optional

Array of content view environment ids associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified.Requires allow_multiple_content_views setting to be on.

Validations:

  • Must be an array of any type

search
optional

Search string

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

order
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
optional

Whether or not to show all results

Validations:

  • Must be one of: true, false, 1, 0.

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

Search fields

Field name Type Possible values
addon string
content_view string
content_view_id integer
description text
environment string
lifecycle_environment_id integer
name string
organization_id integer
role string
subscription_id string
subscription_name string
usage string