class

PlaceOS::Client::APIWrapper::APIKeys

Inherits PlaceOS::Client::APIWrapper::Endpoint::Destroy < PlaceOS::Client::APIWrapper::Endpoint::Fetch < PlaceOS::Client::APIWrapper::Endpoint < Reference < Object

Constructors

new(client : APIWrapper)
Source

Instance methods

base

The base route for the endpoint

Source
create(name : String, user_id : String, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil)

Creates a new zone.

Source
inspect_jwt

Get a clear text version of the JWT token

Source
search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, authority_id : String | Nil = nil)

List or search for zones.

Results maybe filtered by specifying a query - q - to search across zone attributes. A small query language is supported within this:

OperatorAction
+Matches both terms
``
-Negates a single token
"Wraps tokens to form a phrase
( )Provides precedence
~NSpecifies edit distance (fuzziness) after a word
~NSpecifies slop amount (deviation) after a phrase

Up to limit zones will be returned, with a paging based on offset.

Results my also also be limited to those associated with specific tags.

Source
update(id : String, name : String | Nil = nil, user_id : String | Nil = nil, description : String | Nil = nil, scopes : Array(String) | Nil = nil, permissions : PlaceOS::Model::UserJWT::Permissions | Nil = nil)

Updates zone attributes or configuration.

Source