Class: BrickFTP::RESTfulAPI::DeleteAPIKey

Inherits:

Object

Object
BrickFTP::RESTfulAPI::DeleteAPIKey

Includes:: Command

Defined in:: lib/brick_ftp/restful_api/delete_api_key.rb

Overview

Delete an API key

See Also:

Delete an API key

Instance Method Summary collapse

#call(id) ⇒ Object
Deletes the specified API key.

Methods included from Command

included, #initialize

Instance Method Details

#call(id) ⇒ `Object`

Deletes the specified API key.

Parameters:

id (Integer) —
Globally unique identifier of each user API key. Each user API key is given an ID automatically upon creation.

# File 'lib/brick_ftp/restful_api/delete_api_key.rb', line 17

def call(id)
  client.delete("/api/rest/v1/api_keys/#{id}.json")
  true
end