Options
All
  • Public
  • Public/Protected
  • All
Menu

Allowable query parameters for settings index endpoint

Hierarchy

Index

Properties

Optional _poll

_poll: undefined | false | true

Whether the request is a API poll request

Optional cache

cache: undefined | number

Number of milliseconds to cache the query response

Optional limit

limit: undefined | number

Number of results to return. Defaults to 20. Max 500

Optional offset

offset: undefined | number

Offsets of the results to return. Max 10000

Optional parent_id

parent_id: undefined | string

ID of the parent zone, system, module or driver to grab settings for

Optional q

q: undefined | string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc