Module: TagApi

Defined in:
lib/pnap_tag_api/api_error.rb,
lib/pnap_tag_api.rb,
lib/pnap_tag_api/version.rb,
lib/pnap_tag_api/api_client.rb,
lib/pnap_tag_api/models/tag.rb,
lib/pnap_tag_api/api/tags_api.rb,
lib/pnap_tag_api/models/error.rb,
lib/pnap_tag_api/configuration.rb,
lib/pnap_tag_api/models/tag_create.rb,
lib/pnap_tag_api/models/tag_update.rb,
lib/pnap_tag_api/models/delete_result.rb,
lib/pnap_tag_api/models/resource_assignment.rb

Overview

#Tags API

#Tags are case-sensitive key-value pairs that simplify resource management. The Tag Manager API allows you to create and manage such tags to later assign them to related resources in your Bare Metal Cloud (through the respective resource apis) in order to group and categorize them.

<span class=‘pnap-api-knowledge-base-link’> Knowledge base articles to help you can be found <a href=‘phoenixnap.com/kb/bmc-server-management-via-api#server-tag-manager-api’ target=‘_blank’>here</a> </span>

All URLs are relative to (https://api.phoenixnap.com/tag-manager/v1/)

The version of the OpenAPI document: 1.0 Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 7.2.0

Defined Under Namespace

Classes: ApiClient, ApiError, Configuration, DeleteResult, Error, ResourceAssignment, Tag, TagCreate, TagUpdate, TagsApi

Constant Summary collapse

VERSION = 
get_version()

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

TagApi.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



38
39
40
41
42
43
44
 
# File 'lib/pnap_tag_api.rb', line 38

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end