EstuaryClient.PinningApi

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

Method	HTTP request	Description
pinningPinsGet	GET /pinning/pins	List all pin status objects
pinningPinsPinidDelete	DELETE /pinning/pins/{pinid}	Delete a pinned object
pinningPinsPinidGet	GET /pinning/pins/{pinid}	Get a pin status object
pinningPinsPinidPost	POST /pinning/pins/{pinid}	Replace a pinned object
pinningPinsPost	POST /pinning/pins	Add and pin object

# **pinningPinsGet** > pinningPinsGet()

List all pin status objects

This endpoint lists all pin status objects

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.PinningApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.pinningPinsGet(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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

# **pinningPinsPinidDelete** > pinningPinsPinidDelete(pinid)

Delete a pinned object

This endpoint deletes a pinned object.

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.PinningApi();

var pinid = "pinid_example"; // String | Pin ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.pinningPinsPinidDelete(pinid, callback);

Parameters

Name	Type	Description	Notes
pinid	String	Pin ID

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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

# **pinningPinsPinidGet** > pinningPinsPinidGet(pinid)

Get a pin status object

This endpoint returns a pin status object.

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.PinningApi();

var pinid = "pinid_example"; // String | cid


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.pinningPinsPinidGet(pinid, callback);

Parameters

Name	Type	Description	Notes
pinid	String	cid

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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

# **pinningPinsPinidPost** > pinningPinsPinidPost(pinid)

Replace a pinned object

This endpoint replaces a pinned object.

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.PinningApi();

var pinid = "pinid_example"; // String | Pin ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.pinningPinsPinidPost(pinid, callback);

Parameters

Name	Type	Description	Notes
pinid	String	Pin ID

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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

# **pinningPinsPost** > pinningPinsPost(cid, name)

Add and pin object

This endpoint adds a pin to the IPFS daemon.

Example

var EstuaryClient = require('estuary-client');
var defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

var apiInstance = new EstuaryClient.PinningApi();

var cid = "cid_example"; // String | cid

var name = "name_example"; // String | name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.pinningPinsPost(cid, name, callback);

Parameters

Name	Type	Description	Notes
cid	String	cid
name	String	name

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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