Class: Scaled::Resources::Keys

Inherits:

Object

• Object
• Scaled::Resources::Keys

Defined in:

lib/scaled/resources/keys.rb

Overview

API wrapper for tailnet keys metadata. API-обгортка для метаданих ключів tailnet.

Instance Method Summary

• #get(key_id) ⇒ Hash, ...

  Parsed response.

• #initialize(client) ⇒ void constructor
• #list(query: nil) ⇒ Hash, ...

  Note: returns all visible key records for current scope.

Constructor Details

#initialize(client) ⇒ void

Parameters:

• client (Scaled::Client) —

  configured API client

# File 'lib/scaled/resources/keys.rb', line 10

def initialize(client)
  @client = client
end

Instance Method Details

#get(key_id) ⇒ Hash, ...

Returns parsed response.

Parameters:

• key_id (String) —

  Tailscale key identifier

Returns:

• (Hash, Array, String, nil) —

  parsed response

# File 'lib/scaled/resources/keys.rb', line 24

def get(key_id)
  @client.get("/tailnet/#{@client.tailnet}/keys/#{key_id}")
end

#list(query: nil) ⇒ Hash, ...

Note: returns all visible key records for current scope. Нотатка: повертає всі доступні записи ключів у поточному scope.

Parameters:

• query (Hash, nil) (defaults to: nil) —

  optional query params

Returns:

• (Hash, Array, String, nil) —

  parsed response

# File 'lib/scaled/resources/keys.rb', line 18

def list(query: nil)
  @client.get("/tailnet/#{@client.tailnet}/keys", query: query)
end