API documentation

Params

Param name	Description
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
organization_id required	Organization ID Validations: Must be a number.
host_id optional	id of a host Validations: String
activation_key_id optional	Activation key ID Validations: String
name optional	name of the subscription Validations: String
available_for optional	Object to show subscriptions available for, either ‘host’ or ‘activation_key’ Validations: String
match_host optional	Ignore subscriptions that are unavailable to the specified host Validations: Must be one of: `true`, `false`, `1`, `0`.
match_installed optional	Return subscriptions that match installed products of the specified host Validations: Must be one of: `true`, `false`, `1`, `0`.
no_overlap optional	Return subscriptions which do not overlap with a currently-attached subscription Validations: Must be one of: `true`, `false`, `1`, `0`.