Skip to main content

SwaggerClient::PinningApi

All URIs are relative to //api.estuary.tech/

MethodHTTP requestDescription
pinning_pins_getGET /pinning/pinsList all pin status objects
pinning_pins_pinid_deleteDELETE /pinning/pins/{pinid}Delete a pinned object
pinning_pins_pinid_getGET /pinning/pins/{pinid}Get a pin status object
pinning_pins_pinid_postPOST /pinning/pins/{pinid}Replace a pinned object
pinning_pins_postPOST /pinning/pinsAdd and pin object

pinning_pins_get

TypesIpfsListPinStatusResponse pinning_pins_get

List all pin status objects

This endpoint lists all pin status objects

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PinningApi.new

begin
#List all pin status objects
result = api_instance.pinning_pins_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PinningApi->pinning_pins_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

TypesIpfsListPinStatusResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

pinning_pins_pinid_delete

pinning_pins_pinid_delete(pinid)

Delete a pinned object

This endpoint deletes a pinned object.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PinningApi.new
pinid = 'pinid_example' # String | Pin ID


begin
#Delete a pinned object
api_instance.pinning_pins_pinid_delete(pinid)
rescue SwaggerClient::ApiError => e
puts "Exception when calling PinningApi->pinning_pins_pinid_delete: #{e}"
end

Parameters

NameTypeDescriptionNotes
pinidStringPin ID

Return type

nil (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

pinning_pins_pinid_get

TypesIpfsPinStatusResponse pinning_pins_pinid_get(pinid)

Get a pin status object

This endpoint returns a pin status object.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PinningApi.new
pinid = 'pinid_example' # String | cid


begin
#Get a pin status object
result = api_instance.pinning_pins_pinid_get(pinid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PinningApi->pinning_pins_pinid_get: #{e}"
end

Parameters

NameTypeDescriptionNotes
pinidStringcid

Return type

TypesIpfsPinStatusResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

pinning_pins_pinid_post

TypesIpfsPinStatusResponse pinning_pins_pinid_post(pinid, opts)

Replace a pinned object

This endpoint replaces a pinned object.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PinningApi.new
pinid = 'pinid_example' # String | Pin ID
opts = {
body: 'body_example' # String | Meta information of new pin
}

begin
#Replace a pinned object
result = api_instance.pinning_pins_pinid_post(pinid, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PinningApi->pinning_pins_pinid_post: #{e}"
end

Parameters

NameTypeDescriptionNotes
pinidStringPin ID
bodyStringMeta information of new pin[optional]

Return type

TypesIpfsPinStatusResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

pinning_pins_post

TypesIpfsPinStatusResponse pinning_pins_post(body)

Add and pin object

This endpoint adds a pin to the IPFS daemon.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PinningApi.new
body = SwaggerClient::TypesIpfsPin.new # TypesIpfsPin | Pin Body {cid:cid, name:name}


begin
#Add and pin object
result = api_instance.pinning_pins_post(body)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PinningApi->pinning_pins_post: #{e}"
end

Parameters

NameTypeDescriptionNotes
bodyTypesIpfsPinPin Body {cid:cid, name:name}

Return type

TypesIpfsPinStatusResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json