Skip to main content

\PinningApi

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

MethodHTTP requestDescription
PinningPinsGetGet /pinning/pinsList all pin status objects
PinningPinsPinidDeleteDelete /pinning/pins/{pinid}Delete a pinned object
PinningPinsPinidGetGet /pinning/pins/{pinid}Get a pin status object
PinningPinsPinidPostPost /pinning/pins/{pinid}Replace a pinned object
PinningPinsPostPost /pinning/pinsAdd and pin object

PinningPinsGet

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

(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]

PinningPinsPinidDelete

PinningPinsPinidDelete(ctx, pinid) Delete a pinned object

This endpoint deletes a pinned object.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
pinidstringPin 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

PinningPinsPinidGet(ctx, pinid) Get a pin status object

This endpoint returns a pin status object.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
pinidstringcid

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]

PinningPinsPinidPost

PinningPinsPinidPost(ctx, pinid) Replace a pinned object

This endpoint replaces a pinned object.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
pinidstringPin 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]

PinningPinsPost

PinningPinsPost(ctx, cid, name) Add and pin object

This endpoint adds a pin to the IPFS daemon.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
cidstringcid
namestringname

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]