Skip to main content

ContentApi

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

MethodHTTP requestDescription
AdminInvitesGetGet /admin/invitesGet Estuary invites
AdminInvitesPostPost /admin/invitesCreate an Estuary invite
ContentAddCarPostPost /content/add-carAdd Car object
ContentAddIpfsPostPost /content/add-ipfsAdd IPFS object
ContentAddPostPost /content/addAdd new content
ContentAggregatedContentGetGet /content/aggregated/{content}Get aggregated content stats
ContentAllDealsGetGet /content/all-dealsGet all deals for a user
ContentBwUsageContentGetGet /content/bw-usage/{content}Get content bandwidth
ContentCreatePostPost /content/createAdd a new content
ContentDealsGetGet /content/dealsContent with deals
ContentEnsureReplicationDatacidGetGet /content/ensure-replication/{datacid}Ensure Replication
ContentFailuresContentGetGet /content/failures/{content}List all failures for a content
ContentIdGetGet /content/{id}Content
ContentImportdealPostPost /content/importdealImport a deal
ContentListGetGet /content/listList all pinned content
ContentReadContGetGet /content/read/{cont}Read content
ContentStagingZonesGetGet /content/staging-zonesGet staging zone for user
ContentStatsGetGet /content/statsGet content statistics
ContentStatusIdGetGet /content/status/{id}Content Status

AdminInvitesGet

string AdminInvitesGet(ctx, ) Get Estuary invites

This endpoint is used to list all estuary invites.

Required Parameters

This endpoint does not need any parameter.

Return type

string

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]

AdminInvitesPost

string AdminInvitesPost(ctx, code) Create an Estuary invite

This endpoint is used to create an estuary invite.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
codestringInvite code to be created

Return type

string

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]

ContentAddCarPost

UtilContentAddResponse ContentAddCarPost(ctx, body, optional) Add Car object

This endpoint is used to add a car object to the network. The object can be a file or a directory.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
bodystringCar
optional*ContentApiContentAddCarPostOptsoptional parametersnil if no parameters

Optional Parameters

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

ignoreDupes | optional.| Ignore Dupes | filename | optional.| Filename |

Return type

UtilContentAddResponse

Authorization

bearerAuth

HTTP request headers

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

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

ContentAddIpfsPost

string ContentAddIpfsPost(ctx, body, optional) Add IPFS object

This endpoint is used to add an IPFS object to the network. The object can be a file or a directory.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
bodyUtilContentAddIpfsBodyIPFS Body
optional*ContentApiContentAddIpfsPostOptsoptional parametersnil if no parameters

Optional Parameters

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

ignoreDupes | optional.| Ignore Dupes |

Return type

string

Authorization

bearerAuth

HTTP request headers

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

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

ContentAddPost

UtilContentAddResponse ContentAddPost(ctx, data, filename, optional) Add new content

This endpoint is used to upload new content.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
data*os.File***os.File**
filenamestring
optional*ContentApiContentAddPostOptsoptional parametersnil if no parameters

Optional Parameters

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

coluuid | optional.| Collection UUID | replication | optional.| Replication value | ignoreDupes | optional.| Ignore Dupes true/false | lazyProvide | optional.| Lazy Provide true/false | dir | optional.| Directory |

Return type

UtilContentAddResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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

ContentAggregatedContentGet

string ContentAggregatedContentGet(ctx, content) Get aggregated content stats

This endpoint returns aggregated content stats

Required Parameters

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

Return type

string

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]

ContentAllDealsGet

string ContentAllDealsGet(ctx, begin, duration, all) Get all deals for a user

This endpoint is used to get all deals for a user

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
beginstringBegin
durationstringDuration
allstringAll

Return type

string

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]

ContentBwUsageContentGet

string ContentBwUsageContentGet(ctx, content) Get content bandwidth

This endpoint returns content bandwidth

Required Parameters

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

Return type

string

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]

ContentCreatePost

string ContentCreatePost(ctx, body, optional) Add a new content

This endpoint adds a new content

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
bodyUtilContentCreateBodyContent
optional*ContentApiContentCreatePostOptsoptional parametersnil if no parameters

Optional Parameters

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

ignoreDupes | optional.| Ignore Dupes |

Return type

string

Authorization

bearerAuth

HTTP request headers

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

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

ContentDealsGet

string ContentDealsGet(ctx, optional) Content with deals

This endpoint lists all content with deals

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*ContentApiContentDealsGetOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ContentApiContentDealsGetOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- limit | optional.Int32| Limit | offset | optional.Int32| Offset |

Return type

string

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]

ContentEnsureReplicationDatacidGet

string ContentEnsureReplicationDatacidGet(ctx, datacid) Ensure Replication

This endpoint ensures that the content is replicated to the specified number of providers

Required Parameters

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

Return type

string

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]

ContentFailuresContentGet

string ContentFailuresContentGet(ctx, content) List all failures for a content

This endpoint returns all failures for a content

Required Parameters

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

Return type

string

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]

ContentIdGet

string ContentIdGet(ctx, id) Content

This endpoint returns a content by its ID

Required Parameters

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

Return type

string

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]

ContentImportdealPost

string ContentImportdealPost(ctx, body) Import a deal

This endpoint imports a deal into the shuttle.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
bodyMainImportDealBodyImport a deal

Return type

string

Authorization

bearerAuth

HTTP request headers

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

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

ContentListGet

string ContentListGet(ctx, ) List all pinned content

This endpoint lists all content

Required Parameters

This endpoint does not need any parameter.

Return type

string

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]

ContentReadContGet

string ContentReadContGet(ctx, cont) Read content

This endpoint reads content from the blockstore

Required Parameters

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

Return type

string

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]

ContentStagingZonesGet

string ContentStagingZonesGet(ctx, ) Get staging zone for user

This endpoint is used to get staging zone for user.

Required Parameters

This endpoint does not need any parameter.

Return type

string

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]

ContentStatsGet

string ContentStatsGet(ctx, limit, offset) Get content statistics

This endpoint is used to get content statistics. Every content stored in the network (estuary) is tracked by a unique ID which can be used to get information about the content. This endpoint will allow the consumer to get the collected stats of a conten

Required Parameters

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

Return type

string

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]

ContentStatusIdGet

string ContentStatusIdGet(ctx, id) Content Status

This endpoint returns the status of a content

Required Parameters

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

Return type

string

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]