GenerateKeyApi.md

MergeCRMClient::GenerateKeyApi

All URIs are relative to https://api.merge.dev/api/crm/v1

Method	HTTP request	Description
generate_key_create	POST /generate-key

generate_key_create

generate_key_create(generate_remote_key_request)

Create a remote key.

Examples

require 'time'
require 'merge_crm_client'
# setup authorization
MergeCRMClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeCRMClient::GenerateKeyApi.new
generate_remote_key_request = MergeCRMClient::GenerateRemoteKeyRequest.new({name: 'Remote Deployment Key 1'}) # GenerateRemoteKeyRequest | 

begin
  
  result = api_instance.generate_key_create(generate_remote_key_request)
  p result
rescue MergeCRMClient::ApiError => e
  puts "Error when calling GenerateKeyApi->generate_key_create: #{e}"
end

Using the generate_key_create_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> generate_key_create_with_http_info(generate_remote_key_request)

begin
  
  data, status_code, headers = api_instance.generate_key_create_with_http_info(generate_remote_key_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RemoteKey>
rescue MergeCRMClient::ApiError => e
  puts "Error when calling GenerateKeyApi->generate_key_create_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
generate_remote_key_request	GenerateRemoteKeyRequest

Return type

RemoteKey

Authorization

tokenAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json