grafana 0.10.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d62ca27f8f2d01a27309e9b947fa2f633caf75d2bcc94443a9208c36416ff5e3
-  data.tar.gz: 30f9a883ac3b492ea294a090960f733c7a163d59c39975c3efb12391410387af
+  metadata.gz: 8e73fd657e1a344d3cb67b5bf01cd33f8e227447e92e6e93b575a51a0091a253
+  data.tar.gz: c9f41ad884326c341d9c25746bfb80967206c5d0f94ef2bf94a4de6dd7e74435
 SHA512:
-  metadata.gz: 81a9b8b26d5de44f741045268ce8fc4eb0581414cecba178abea7e8c614be0c2586256ace00669719b87eee37c47c90e1fb9a0c5d23171a236ff49938caf3934
-  data.tar.gz: f680c1a86f1aa778eb00e440fc00d290683bafc0eb245c67215c071079ad8ca43b6499e54ee9aeee2bd6dd15f7c89eff9a86b6ebfd70604a831f1717169b528c
+  metadata.gz: 4aa2e43dbde3b105b5f85c74ac84a4269cd67d2de6b327cc597854ef1e6e4d66ce52628e9564785a0f1729527e90514e2577c83a651d8fe6c82c765c73a8ecbc
+  data.tar.gz: 50df29f0e9ad79c5dd7586dd1190585badb8ae3e09b82847433721cded33a6aa562ccba34be65c12356ca00cde64a45a18bf9dde1592af614a52263d71bca2f4

data/README.md

@@ -26,9 +26,14 @@ TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake rake` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version,
+push git commits and tags and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/grafana/client.rb

@@ -27,6 +27,7 @@ require_relative 'alerts'
 require_relative 'folder'
 require_relative 'folder_permissions'
 require_relative 'folder_and_dashboard_search'
+require_relative 'playlist'
 
 # -------------------------------------------------------------------------------------------------------------------
 #
@@ -68,6 +69,7 @@ module Grafana
     include Grafana::Folder
     include Grafana::FolderPermissions
     include Grafana::FolderSearch
+    include Grafana::Playlist
 
     attr_accessor :debug
 

data/lib/grafana/dashboard.rb

@@ -78,7 +78,7 @@ module Grafana
       raise ArgumentError.new('missing \'uid\'') if( uid.size.zero? )
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has uid support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'uid has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       return { 'status' => 404, 'message' => format( 'The uid can have a maximum length of 40 characters, but it is %s characters long', uid.length) } if( uid.length > 40 )
 
@@ -148,7 +148,7 @@ module Grafana
       title = db.dig('dashboard','title')
       uid   = db.dig('dashboard','uid')
 
-      return { 'status' => 404, 'message' => format( 'the template \'%s\' can\'t be create. The uid can have a maximum length of 40 characters, but it is %s characters long', title, uid.length) } if( ! uid.nil? && uid.length > 40 )
+      return { 'status' => 404, 'message' => format( 'The template \'%s\' can\'t be create. The uid can have a maximum length of 40 characters, but it is %s characters long', title, uid.length) } if( ! uid.nil? && uid.length > 40 )
 
       endpoint = '/api/dashboards/db'
 

data/lib/grafana/dashboard_permissions.rb

@@ -51,7 +51,7 @@ module Grafana
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       dashboard_id = validate( params, required: true, var: 'dashboard_id', type: Integer )
       permissions  = validate( params, required: true, var: 'permissions' , type: Hash )

data/lib/grafana/dashboard_versions.rb

@@ -20,7 +20,7 @@ module Grafana
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
 #      v, mv = version.values
-#      return { 'status' => 404, 'message' => format( 'only Grafana 5 has dashboard version support. you use version %s', v) } if(mv != 5)
+#      return { 'status' => 404, 'message' => format( 'dashboard has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       dashboard_id  = validate( params, required: true , var: 'dashboard_id', type: Integer )
       start         = validate( params, required: false, var: 'start'       , type: Integer )
@@ -44,7 +44,7 @@ module Grafana
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       dashboard_id  = validate( params, required: true, var: 'dashboard_id', type: Integer )
       version       = validate( params, required: true, var: 'version'     , type: Integer )
@@ -67,7 +67,7 @@ module Grafana
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
 #      v, mv = version.values
-#      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+#      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       dashboard_id  = validate( params, required: true, var: 'dashboard_id', type: Integer )
       version       = validate( params, required: true, var: 'version'    , type: Integer )

data/lib/grafana/folder.rb

@@ -16,7 +16,7 @@ module Grafana
     def folders
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       endpoint = '/api/folders'
       @logger.debug("Getting all folders (GET #{endpoint})") if @debug
@@ -39,7 +39,7 @@ module Grafana
       raise ArgumentError.new('missing \'folder_uid\'') if( folder_uid.size.zero? )
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       if(folder_uid.is_a?(Integer))
 
@@ -58,7 +58,7 @@ module Grafana
         return { 'status' => 404, 'message' => format( 'No Folder \'%s\' found', folder_uid) } if( folder_uid.is_a?(Integer) )
       end
 
-      return { 'status' => 404, 'message' => format( 'The uid can have a maximum length of 40 characters. \'%s\' given', folder_uid.length) } \
+      return { 'status' => 404, 'message' => format( 'The uid can have a maximum length of 40 characters, but it is %s characters long', folder_uid.length) } \
           if( folder_uid.is_a?(String) && folder_uid.length > 40 )
       return { 'status' => 404, 'message' => format( 'No Folder \'%s\' found', folder_uid) } if( folder_uid.nil? )
 
@@ -82,7 +82,7 @@ module Grafana
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       title = validate( params, required: false, var: 'title', type: String )
       uid   = validate( params, required: true , var: 'uid'  , type: String )
@@ -124,7 +124,7 @@ module Grafana
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       uid       = validate( params, required: true , var: 'uid'      , type: String )
       title     = validate( params, required: true , var: 'title'    , type: String )
@@ -168,7 +168,7 @@ module Grafana
       raise ArgumentError.new('missing \'folder_uid\'') if( folder_uid.size.zero? )
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       if(folder_uid.is_a?(Integer))
 

data/lib/grafana/folder_and_dashboard_search.rb

@@ -21,7 +21,7 @@ module Grafana
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has team support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'team has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       query         = validate( params, required: false, var: 'query'       , type: String )
       tag           = validate( params, required: false, var: 'tag '        , type: String )

data/lib/grafana/folder_permissions.rb

@@ -23,7 +23,7 @@ module Grafana
     def folder_permissions( folder_id )
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       f = folder( folder_id )
 
@@ -53,7 +53,7 @@ module Grafana
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
       v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
 
       folder      = validate( params, required: true, var: 'folder'     , type: String )
       permissions = validate( params, required: true, var: 'permissions', type: Hash )

data/lib/grafana/login.rb

@@ -131,8 +131,8 @@ module Grafana
     # @return [Hash]
     #
     def ping_session
-      endpoint = '/api/login/ping'
       logger.debug( "Pinging current session (GET #{endpoint})" ) if @debug
+      endpoint = '/api/login/ping'
       get( endpoint )
     end
 

data/lib/grafana/network.rb

@@ -60,7 +60,7 @@ module Grafana
     # @return [Hash]
     #
     def request( method_type = 'GET', endpoint = '/', data = {} )
-#       logger.debug( "request( #{method_type}, #{endpoint}, data )" )
+
       raise 'try first login()' if @api_instance.nil?
 
       login( username: @username, password: @password )
@@ -78,13 +78,18 @@ module Grafana
         when 'PATCH'
           response = @api_instance[endpoint].patch( data, headers )
         when 'PUT'
+
           # response = @api_instance[endpoint].put( data, headers )
           @api_instance[endpoint].put( data, headers ) do |resp, _request, _result|
-            response_body = resp.body
+
             response_code = resp.code.to_i
+            response_body = resp.body
             response_body = JSON.parse(response_body) if response_body.is_a?(String)
 
-            case response_code
+            #logger.debug( "code   : #{response_code}" )
+            #logger.debug( "message: #{response_body}" )
+
+            case response_code.to_i
             when 200
               return { 'status' => response_code, 'message' => response_body.dig('message').nil? ? 'Successful' : response_body.dig('message') }
             when 400
@@ -95,19 +100,54 @@ module Grafana
               message += " (#{status})"  unless(status.nil?)
               return { 'status'  => response_code, 'message' => message }
             when 422
-              raise RestClient::UnprocessableEntity
+              logger.error('422')
+
+              response_body = response_body.first if(response_body.is_a?(Array))
+              message_field_name = response_body.dig('fieldNames')
+
+              #status   = response_code # response_body.dig('status')
+              message  = response_body # .dig('message')
+              #message += " (#{status})"  unless(status.nil?)
+
+              # [{fieldNames"=>["Id"], "classification"=>"RequiredError", "message"=>"Required"}]
+
+              logger.error(message)
+              return { 'status'  => response_code, 'message' => message }
+#              #raise RestClient::UnprocessableEntity
             else
-#               logger.error( response_code )
-#               logger.error( response_body )
+#              logger.error( response_code )
+#              logger.error( response_body )
               return { 'status' => response_code, 'message' => response_body.dig('message') }
               # response.return! # (request, result)
             end
           end
 
         when 'DELETE'
-          response = @api_instance[endpoint].delete( headers )
+
+          @api_instance[endpoint].delete( headers ) do |resp, _request, _result|
+
+            response_code = resp.code.to_i
+            response_body = resp.body
+            response_body = JSON.parse(response_body) if response_body.is_a?(String)
+
+            #logger.debug( "code   : #{response_code}" )
+            #logger.debug( "message: #{response_body}" )
+
+            case response_code.to_i
+            when 200
+              return { 'status' => response_code, 'message' => response_body.dig('message').nil? ? 'Successful' : response_body.dig('message') }
+            when 404
+              return { 'status' => response_code, 'message' => response_body.dig('message').nil? ? 'Successful' : response_body.dig('message') }
+            else
+#              logger.error( response_code )
+#              logger.error( response_body )
+              return { 'status' => response_code, 'message' => response_body.dig('message') }
+            end
+
+          end
+
         else
-          @logger.error( "Error: #{__method__} is not a valid request method." )
+          logger.error( "Error: #{__method__} is not a valid request method." )
           return false
         end
 
@@ -115,16 +155,14 @@ module Grafana
         response_body    = response.body
         response_headers = response.headers
 
-#         if( @debug )
-#           logger.debug("response_code : #{response_code}" )
-#           logger.debug("response_body : #{response_body}" )
-#           logger.debug("response_headers : #{response_headers}" )
-#         end
-
         if( ( response_code >= 200 && response_code <= 299 ) || ( response_code >= 400 && response_code <= 499 ) )
 
-          result = JSON.parse( response_body )
-          return { 'status' => response_code, 'message' => result } if( result.is_a?(Array) )
+          if( response_body =~ /^\[.*\]$/ || response_body =~ /^\{.*\}$/ )
+            result = JSON.parse( response_body )
+            return { 'status' => response_code, 'message' => result } if( result.is_a?(Array) )
+          else
+            return { 'status' => response_code, 'message' => response_body }
+          end
 
           result_status     = result.dig('status') if( result.is_a?( Hash ) )
           result['message'] = result_status unless( result_status.nil? )
@@ -132,9 +170,9 @@ module Grafana
 
           return result
         else
-          @logger.error( "#{__method__} #{method_type.upcase} on #{endpoint} failed: HTTP #{response.code} - #{response_body}" )
-          @logger.error( headers )
-          @logger.error( JSON.pretty_generate( response_headers ) )
+          logger.error( "#{__method__} #{method_type.upcase} on #{endpoint} failed: HTTP #{response.code} - #{response_body}" )
+          logger.error( headers )
+          logger.error( JSON.pretty_generate( response_headers ) )
 
           return JSON.parse( response_body )
         end
@@ -155,12 +193,12 @@ module Grafana
       rescue RestClient::PreconditionFailed
         return { 'status' => 412, 'message' => 'Precondition failed. The Object probably already exists.' }
       rescue RestClient::ExceptionWithResponse => error
-#        logger.error( "Error: #{__method__} #{method_type.upcase} on #{endpoint} error: '#{error}'" )
-#        logger.error( "query: #{data}" )
+        #logger.error( "Error: (RestClient::ExceptionWithResponse) #{__method__} #{method_type.upcase} on #{endpoint} error: '#{error}'" )
+        #logger.error( "query: #{data}" )
         return { 'status' => 500, 'message' => "Internal Server Error: #{error}" }
       rescue => error
-#        logger.error( "Error: #{__method__} #{method_type.upcase} on #{endpoint} error: '#{error}'" )
-#        logger.error( "query: #{data}" )
+        #logger.error( "Error: #{__method__} #{method_type.upcase} on #{endpoint} error: '#{error}'" )
+        #logger.error( "query: #{data}" )
         return { 'status' => 500, 'message' => "Internal Server Error: #{error}" }
       end
     end

data/lib/grafana/organizations.rb

@@ -30,7 +30,7 @@ module Grafana
       raise ArgumentError.new('missing \'organisation_id\'') if( organisation_id.size.zero? )
 
       endpoint = format( '/api/orgs/%d', organisation_id ) if(organisation_id.is_a?(Integer))
-      endpoint = format( '/api/orgs/name/%s', URI.escape( organisation_id ) ) if(organisation_id.is_a?(String))
+      endpoint = format( '/api/orgs/name/%s', ERB::Util.url_encode( organisation_id ) ) if(organisation_id.is_a?(String))
 
       @logger.debug("Attempting to get existing data source Id #{organisation_id} (GET #{endpoint})") if  @debug
 

data/lib/grafana/playlist.rb

@@ -0,0 +1,599 @@
+
+module Grafana
+
+  # +++
+  # title = "Playlist HTTP API "
+  # description = "Playlist Admin HTTP API"
+  # keywords = ["grafana", "http", "documentation", "api", "playlist"]
+  # aliases = ["/http_api/playlist/"]
+  # type = "docs"
+  # [menu.docs]
+  # name = "Playlist"
+  # parent = "http_api"
+  # +++
+
+  # https://github.com/grafana/grafana/blob/1165d098b0d0ae705955f9d2ea104beea98ca6eb/pkg/api/dtos/playlist.go
+
+  module Playlist
+
+    ## Playlist API
+    #
+    ### Search Playlist
+    #
+    #`GET /api/playlists`
+    #
+    #Get all existing playlist for the current organization using pagination
+    #
+    #**Example Request**:
+    #
+    #```bash
+    #GET /api/playlists HTTP/1.1
+    #Accept: application/json
+    #Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+    #```
+    #
+    #  Querystring Parameters:
+    #
+    #  These parameters are used as querystring parameters.
+    #
+    #  - **query** - Limit response to playlist having a name like this value.
+    #  - **limit** - Limit response to *X* number of playlist.
+    #
+    #**Example Response**:
+    #
+    #```json
+    #HTTP/1.1 200
+    #Content-Type: application/json
+    #[
+    #  {
+    #    "id": 1,
+    #    "name": "my playlist",
+    #    "interval": "5m"
+    #  }
+    #]
+    #```
+    def playlists
+
+      endpoint = '/api/playlists'
+
+      @logger.debug("Attempting to get all existing playlists (GET #{endpoint})") if @debug
+
+      playlists = get( endpoint )
+
+      return { 'status' => 404, 'message' => 'No Playlists found' } if( playlists.nil? || playlists == false || playlists.dig('status').to_i != 200 )
+
+      playlists
+    end
+
+    ### Get one playlist
+    #
+    #`GET /api/playlists/:id`
+    #
+    #**Example Request**:
+    #
+    #```bash
+    #GET /api/playlists/1 HTTP/1.1
+    #Accept: application/json
+    #Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+    #```
+    #
+    #**Example Response**:
+    #
+    #```json
+    #HTTP/1.1 200
+    #Content-Type: application/json
+    #{
+    #  "id" : 1,
+    #  "name": "my playlist",
+    #  "interval": "5m",
+    #  "orgId": "my org",
+    #  "items": [
+    #    {
+    #      "id": 1,
+    #      "playlistId": 1,
+    #      "type": "dashboard_by_id",
+    #      "value": "3",
+    #      "order": 1,
+    #      "title":"my third dasboard"
+    #    },
+    #    {
+    #      "id": 2,
+    #      "playlistId": 1,
+    #      "type": "dashboard_by_tag",
+    #      "value": "myTag",
+    #      "order": 2,
+    #      "title":"my other dasboard"
+    #    }
+    #  ]
+    #}
+    #```
+
+    def playlist( playlist_id )
+
+      if( playlist_id.is_a?(String) && playlist_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'playlist_id\' must be an String (for an Playlist name) or an Integer (for an Playlist Id), given \'%s\'', playlist_id.class.to_s))
+      end
+      raise ArgumentError.new('missing \'playlist_id\'') if( playlist_id.size.zero? )
+
+      if(playlist_id.is_a?(String))
+
+        data = playlists
+        status = data.dig('status')
+        d = data.dig('message')
+        data = d.select { |k| k['name'] == playlist_id }
+
+        return { 'status' => 404, 'message' => format( 'No Playlist \'%s\' found', playlist_id) } if( data.size == 0 )
+
+        if( data.size != 0 )
+
+          _d = []
+          data.each do |k,v|
+            _d << playlist( k['id'] )
+          end
+          return { 'status' => status, 'playlists' => _d }
+        end
+#        return { 'status' => 200, 'message' => data } if( data.size != 0 )
+      end
+
+      raise format('playlist id can not be 0') if( playlist_id.zero? )
+
+      endpoint = format('/api/playlists/%d', playlist_id )
+
+      @logger.debug("Attempting to get existing playlist id #{playlist_id} (GET #{endpoint})") if  @debug
+
+      result = get(endpoint)
+
+      return { 'status' => 404, 'message' => 'playlist is empty', 'items' => [] } if( result.dig('status') == 404 )
+
+      return result
+    end
+
+    ### Get Playlist items
+
+    #`GET /api/playlists/:id/items`
+    #
+    #**Example Request**:
+    #
+    #```bash
+    #GET /api/playlists/1/items HTTP/1.1
+    #Accept: application/json
+    #Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+    #```
+    #
+    #**Example Response**:
+    #
+    #```json
+    #HTTP/1.1 200
+    #Content-Type: application/json
+    #[
+    #  {
+    #    "id": 1,
+    #    "playlistId": 1,
+    #    "type": "dashboard_by_id",
+    #    "value": "3",
+    #    "order": 1,
+    #    "title":"my third dasboard"
+    #  },
+    #  {
+    #    "id": 2,
+    #    "playlistId": 1,
+    #    "type": "dashboard_by_tag",
+    #    "value": "myTag",
+    #    "order": 2,
+    #    "title":"my other dasboard"
+    #  }
+    #]
+    #```
+
+    def playlist_items( playlist_id, multi_result = false )
+
+      if( playlist_id.is_a?(String) && playlist_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'playlist_id\' must be an String (for an playlist name) or an Integer (for an playlist Id), given \'%s\'', playlist_id.class.to_s))
+      end
+      raise ArgumentError.new('missing \'playlist_id\'') if( playlist_id.size.zero? )
+
+      _playlists = playlists
+
+      begin
+        status  = _playlists.dig('status')
+        message = _playlists.dig('message')
+
+        if( status == 200 )
+
+          data = message.select { |k| k['id'] == playlist_id } if( playlist_id.is_a?(Integer) )
+          data = message.select { |k| k['name'] == playlist_id } if( playlist_id.is_a?(String) )
+
+          return { 'status' => 404, 'message' => 'No Playlist found' } if( !data.is_a?(Array) || data.count == 0 || status.to_i != 200 )
+          return { 'status' => 404, 'message' => format('found %d playlists with name %s', data.count, playlist_id ) } if( data.count > 1 && multi_result == false )
+
+          id = data.first.dig('id')
+        else
+          return _playlists
+        end
+      rescue
+        return { 'status' => 404, 'message' => 'No Playlists found' } if( playlists.nil? || playlists == false || playlists.dig('status').to_i != 200 )
+      end
+
+      endpoint = "/api/playlists/#{id}/items"
+
+      result = get( endpoint )
+
+      return { 'status' => 404, 'message' => 'playlist is empty' } if( result.dig('status') == 404 )
+
+      return result
+    end
+
+    ### Get Playlist dashboards
+    #
+    #`GET /api/playlists/:id/dashboards`
+    #
+    #**Example Request**:
+    #
+    #```bash
+    #GET /api/playlists/1/dashboards HTTP/1.1
+    #Accept: application/json
+    #Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+    #```
+    #
+    #**Example Response**:
+    #
+    #```json
+    #HTTP/1.1 200
+    #Content-Type: application/json
+    #[
+    #  {
+    #    "id": 3,
+    #    "title": "my third dasboard",
+    #    "order": 1,
+    #  },
+    #  {
+    #    "id": 5,
+    #    "title":"my other dasboard"
+    #    "order": 2,
+    #
+    #  }
+    #]
+    #```
+
+    def playlist_dashboards( playlist_id )
+
+      raise ArgumentError.new(format('wrong type. \'playlist_id\' must be an Integer, given \'%s\'', playlist_id.class)) unless( playlist_id.is_a?(Integer) )
+      raise ArgumentError.new('missing \'playlist_id\'') if( playlist_id.size.zero? )
+
+      endpoint = format('/api/playlists/%s/dashboards', playlist_id)
+
+      @logger.debug( "Attempting to get playlist (GET #{endpoint})" ) if @debug
+      get(endpoint)
+    end
+
+    # Create a playlist
+
+    # `POST /api/playlists/`
+    #
+    #**Example Request**:
+    #
+    #```bash
+    #PUT /api/playlists/1 HTTP/1.1
+    #Accept: application/json
+    #Content-Type: application/json
+    #Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+    #  {
+    #    "name": "my playlist",
+    #    "interval": "5m",
+    #    "items": [
+    #      {
+    #        "type": "dashboard_by_id",
+    #        "value": "3",
+    #        "order": 1,
+    #        "title":"my third dasboard"
+    #      },
+    #      {
+    #        "type": "dashboard_by_tag",
+    #        "value": "myTag",
+    #        "order": 2,
+    #        "title":"my other dasboard"
+    #      }
+    #    ]
+    #  }
+    #```
+    #
+    #**Example Response**:
+    #
+    #```json
+    #HTTP/1.1 200
+    #Content-Type: application/json
+    #  {
+    #    "id": 1,
+    #    "name": "my playlist",
+    #    "interval": "5m"
+    #  }
+    #```
+
+    def create_playlist( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+#      v, mv = version.values
+#      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
+
+      name     = validate( params, required: true , var: 'name'      , type: String )
+      interval = validate( params, required: true , var: 'interval'  , type: String )
+      items    = validate( params, required: true , var: 'items'     , type: Array )
+
+      return { 'status' => 404, 'message' => 'There are no elements for a playlist' } if(items.count == 0)
+
+      payload_items = create_playlist_items(items)
+
+      payload = {
+        name:     name,
+        interval: interval,
+        items:    payload_items
+      }
+      payload.reject!{ |_k, v| v.nil? }
+
+      endpoint = '/api/playlists'
+
+      post(endpoint, payload.to_json)
+    end
+
+    ### Update a playlist
+    #
+    #`PUT /api/playlists/:id`
+    #
+    #**Example Request**:
+    #
+    #```bash
+    #PUT /api/playlists/1 HTTP/1.1
+    #Accept: application/json
+    #Content-Type: application/json
+    #Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+    #  {
+    #    "name": "my playlist",
+    #    "interval": "5m",
+    #    "items": [
+    #      {
+    #        "playlistId": 1,
+    #        "type": "dashboard_by_id",
+    #        "value": "3",
+    #        "order": 1,
+    #        "title":"my third dasboard"
+    #      },
+    #      {
+    #        "playlistId": 1,
+    #        "type": "dashboard_by_tag",
+    #        "value": "myTag",
+    #        "order": 2,
+    #        "title":"my other dasboard"
+    #      }
+    #    ]
+    #  }
+    #```
+    #
+    #**Example Response**:
+    #
+    #```json
+    #HTTP/1.1 200
+    #Content-Type: application/json
+    #{
+    #  "id" : 1,
+    #  "name": "my playlist",
+    #  "interval": "5m",
+    #  "orgId": "my org",
+    #  "items": [
+    #    {
+    #      "id": 1,
+    #      "playlistId": 1,
+    #      "type": "dashboard_by_id",
+    #      "value": "3",
+    #      "order": 1,
+    #      "title":"my third dasboard"
+    #    },
+    #    {
+    #      "id": 2,
+    #      "playlistId": 1,
+    #      "type": "dashboard_by_tag",
+    #      "value": "myTag",
+    #      "order": 2,
+    #      "title":"my other dasboard"
+    #    }
+    #  ]
+    #}
+    #```
+
+    def update_playlist( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+      playlist_id   = validate( params, required: true , var: 'playlist' )
+      name          = validate( params, required: false, var: 'name' )
+      interval      = validate( params, required: false, var: 'interval', type: String )
+      # organisation = validate( params, required: false, var: 'organisation' )
+      items         = validate( params, required: false, var: 'items', type: Array )
+
+      _playlists    = playlists
+
+      data = []
+
+      begin
+        status  = _playlists.dig('status')
+        message = _playlists.dig('message')
+
+        if( status == 200 )
+          data = message.select { |k| k['id'] == playlist_id } if( playlist_id.is_a?(Integer) )
+          data = message.select { |k| k['name'] == playlist_id } if( playlist_id.is_a?(String) )
+
+          return { 'status' => 404, 'message' => 'no playlist found' } if( !data.is_a?(Array) || data.count == 0 || status.to_i != 200 )
+          return { 'status' => 404, 'message' => format('found %d playlists with name %s', data.count, playlist_id ) } if( data.count > 1 && multi_result == false )
+        else
+          return _playlists
+        end
+      rescue
+        return { 'status' => 404, 'message' => 'no playlists found' } if( playlists.nil? || playlists == false || playlists.dig('status').to_i != 200 )
+      end
+
+      playlist_id   = data.first.dig('id')
+      playlist_name = data.first.dig('name')
+      payload_items = create_playlist_items(items, playlist_id)
+
+      payload = {
+        id:       playlist_id,
+        name:     name,
+        interval: interval,
+        items:    payload_items
+      }
+      payload.reject!{ |_k, v| v.nil? }
+
+      endpoint = format( '/api/playlists/%d', playlist_id )
+
+      put( endpoint, payload.to_json )
+
+    end
+
+
+    ### Delete a playlist
+    #
+    #`DELETE /api/playlists/:id`
+    #
+    #**Example Request**:
+    #
+    #```bash
+    #DELETE /api/playlists/1 HTTP/1.1
+    #Accept: application/json
+    #Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+    #```
+    #
+    #**Example Response**:
+    #
+    #```json
+    #HTTP/1.1 200
+    #Content-Type: application/json
+    #{}
+    #```
+
+    def delete_playlist(playlist_id, multi_result = false )
+
+      if( playlist_id.is_a?(String) && playlist_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'playlist_id\' must be an String (for an Playlist name) or an Integer (for an Playlist Id), given \'%s\'', playlist_id.class.to_s))
+      end
+      raise ArgumentError.new('missing \'playlist_id\'') if( playlist_id.size.zero? )
+
+      _playlists = playlists
+
+      data = []
+
+      begin
+        status  = _playlists.dig('status')
+        message = _playlists.dig('message')
+
+        if( status == 200 )
+
+          data = message.select { |k| k['id'] == playlist_id } if( playlist_id.is_a?(Integer) )
+          data = message.select { |k| k['name'] == playlist_id } if( playlist_id.is_a?(String) )
+
+          return { 'status' => 404, 'message' => 'no playlist found' } if( !data.is_a?(Array) || data.count == 0 || status.to_i != 200 )
+          return { 'status' => 404, 'message' => format('found %d playlists with name %s', data.count, playlist_id ) } if( data.count > 1 && multi_result == false )
+        else
+          return _playlists
+        end
+      rescue
+        return { 'status' => 404, 'message' => 'no playlists found' } if( playlists.nil? || playlists == false || playlists.dig('status').to_i != 200 )
+      end
+
+      if( multi_result == true )
+
+        result = { 'status' => 0, 'message' => 'under development' }
+        data.each do |x|
+
+          endpoint = format( '/api/playlists/%d', x.dig('id') )
+
+          begin
+            result = delete( endpoint )
+          rescue => error
+            logger.error( "error: #{error}" )
+          end
+        end
+
+        return result
+      else
+
+        playlist_id = data.first.dig('id')
+
+        endpoint = format( '/api/playlists/%d', playlist_id )
+
+        result = delete( endpoint )
+
+        if(result.dig('status').to_i == 500)
+          # check if the playlist exists
+          r = playlist( playlist_id )
+          return { 'status' => 200, 'message' => 'playlist deleted' } if(r.dig('status').to_i == 404)
+        end
+
+        return result
+      end
+
+    end
+
+
+    private
+    def create_playlist_items( items, playlistId = nil)
+
+      _items   = []
+
+      items.each do |r|
+        _element = {}
+
+        if( r['name'] )
+
+          _name = search_dashboards( query: r['name'] )
+          _name_status = _name.dig('status')
+
+          next unless( _name_status == 200 )
+
+          _name       = _name.dig('message')
+          _name_id    = _name.first.dig('id')
+          _name_title = _name.first.dig('title')
+
+          _element[:type]  = 'dashboard_by_id'
+          _element[:value] = _name_id.to_s
+          _element[:title] = _name_title
+          _element[:playlistId] = playlistId unless(playlistId.nil?)
+
+        elsif( r['id'] )
+
+          _uid = dashboard_by_uid(r['id'])
+          _uid_status = _uid.dig('status')
+
+          next unless( _uid_status == 200 )
+
+          _element[:type]  = 'dashboard_by_id'
+          _element[:value] = r['id']
+          _element[:playlistId] = playlistId unless(playlistId.nil?)
+
+        elsif( r['tag'] )
+
+          _tags = search_dashboards( tags: r['tag'] )
+          _tags_status = _tags.dig('status')
+
+          next unless( _tags_status == 200 )
+
+          _element[:type]  = 'dashboard_by_tag'
+          _element[:value] = r['tag']
+          _element[:title] = r['tag']
+          _element[:playlistId] = playlistId unless(playlistId.nil?)
+
+        else
+          next
+        end
+
+        _element[:order] = r['order'] if(r['order'])
+
+        _items << _element if(_element.count >= 4)
+      end
+
+      _items
+    end
+
+  end
+end