PinningApi

All URIs are relative to //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

TypesIpfsListPinStatusResponse PinningPinsGet(ctx, ) List all pin status objects

This endpoint lists all pin status objects

Required Parameters

This endpoint does not need any parameter.

Return type

TypesIpfsListPinStatusResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PinningPinsPinidDelete

PinningPinsPinidDelete(ctx, pinid) Delete a pinned object

This endpoint deletes a pinned object.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pinid	string	Pin ID

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PinningPinsPinidGet

TypesIpfsPinStatusResponse PinningPinsPinidGet(ctx, pinid) Get a pin status object

This endpoint returns a pin status object.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pinid	string	cid

Return type

TypesIpfsPinStatusResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PinningPinsPinidPost

TypesIpfsPinStatusResponse PinningPinsPinidPost(ctx, pinid, optional) Replace a pinned object

This endpoint replaces a pinned object.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pinid	string	Pin ID
optional	*PinningApiPinningPinsPinidPostOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PinningApiPinningPinsPinidPostOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------

body | optional.Interface of string| Meta information of new pin |

Return type

TypesIpfsPinStatusResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PinningPinsPost

TypesIpfsPinStatusResponse PinningPinsPost(ctx, body) Add and pin object

This endpoint adds a pin to the IPFS daemon.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	TypesIpfsPin	Pin Body {cid:cid, name:name}

Return type

TypesIpfsPinStatusResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]