Skip to main content

ContentApi

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

MethodHTTP requestDescription
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
# **contentAddCarPost** > contentAddCarPost(body, ignoreDupes, filename)

Add Car object

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
String body = "body_example"; // String | Car
String ignoreDupes = "ignoreDupes_example"; // String | Ignore Dupes
String filename = "filename_example"; // String | Filename
try {
apiInstance.contentAddCarPost(body, ignoreDupes, filename);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentAddCarPost");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
bodyStringCar
ignoreDupesStringIgnore Dupes[optional]
filenameStringFilename[optional]

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentAddIpfsPost** > contentAddIpfsPost(body, ignoreDupes)

Add IPFS object

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
UtilContentAddIpfsBody body = new UtilContentAddIpfsBody(); // UtilContentAddIpfsBody | IPFS Body
String ignoreDupes = "ignoreDupes_example"; // String | Ignore Dupes
try {
apiInstance.contentAddIpfsPost(body, ignoreDupes);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentAddIpfsPost");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
bodyUtilContentAddIpfsBodyIPFS Body
ignoreDupesStringIgnore Dupes[optional]

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentAddPost** > UtilContentAddResponse contentAddPost(data, filename, coluuid, replication, ignoreDupes, lazyProvide, dir)

Add new content

This endpoint is used to upload new content.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
File data = new File("/path/to/file.txt"); // File | File to upload
String filename = "filename_example"; // String | Filenam to use for upload
String coluuid = "coluuid_example"; // String | Collection UUID
Integer replication = 56; // Integer | Replication value
String ignoreDupes = "ignoreDupes_example"; // String | Ignore Dupes true/false
String lazyProvide = "lazyProvide_example"; // String | Lazy Provide true/false
String dir = "dir_example"; // String | Directory
try {
UtilContentAddResponse result = apiInstance.contentAddPost(data, filename, coluuid, replication, ignoreDupes, lazyProvide, dir);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentAddPost");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
dataFileFile to upload
filenameStringFilenam to use for upload[optional]
coluuidStringCollection UUID[optional]
replicationIntegerReplication value[optional]
ignoreDupesStringIgnore Dupes true/false[optional]
lazyProvideStringLazy Provide true/false[optional]
dirStringDirectory[optional]

Return type

UtilContentAddResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json
# **contentAggregatedContentGet** > String contentAggregatedContentGet(content)

Get aggregated content stats

This endpoint returns aggregated content stats

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
String content = "content_example"; // String | Content ID
try {
String result = apiInstance.contentAggregatedContentGet(content);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentAggregatedContentGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
contentStringContent ID

Return type

String

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentAllDealsGet** > contentAllDealsGet(begin, duration, all)

Get all deals for a user

This endpoint is used to get all deals for a user

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
String begin = "begin_example"; // String | Begin
String duration = "duration_example"; // String | Duration
String all = "all_example"; // String | All
try {
apiInstance.contentAllDealsGet(begin, duration, all);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentAllDealsGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
beginStringBegin
durationStringDuration
allStringAll

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentBwUsageContentGet** > contentBwUsageContentGet(content)

Get content bandwidth

This endpoint returns content bandwidth

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
String content = "content_example"; // String | Content ID
try {
apiInstance.contentBwUsageContentGet(content);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentBwUsageContentGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
contentStringContent ID

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentCreatePost** > contentCreatePost(req, ignoreDupes)

Add a new content

This endpoint adds a new content

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
UtilContentCreateBody req = new UtilContentCreateBody(); // UtilContentCreateBody | Content
String ignoreDupes = "ignoreDupes_example"; // String | Ignore Dupes
try {
apiInstance.contentCreatePost(req, ignoreDupes);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentCreatePost");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
reqUtilContentCreateBodyContent
ignoreDupesStringIgnore Dupes[optional]

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentDealsGet** > contentDealsGet(limit, offset)

Content with deals

This endpoint lists all content with deals

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
Integer limit = 56; // Integer | Limit
Integer offset = 56; // Integer | Offset
try {
apiInstance.contentDealsGet(limit, offset);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentDealsGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
limitIntegerLimit[optional]
offsetIntegerOffset[optional]

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentEnsureReplicationDatacidGet** > contentEnsureReplicationDatacidGet(datacid)

Ensure Replication

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
String datacid = "datacid_example"; // String | Data CID
try {
apiInstance.contentEnsureReplicationDatacidGet(datacid);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentEnsureReplicationDatacidGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
datacidStringData CID

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentFailuresContentGet** > String contentFailuresContentGet(content)

List all failures for a content

This endpoint returns all failures for a content

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
String content = "content_example"; // String | Content ID
try {
String result = apiInstance.contentFailuresContentGet(content);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentFailuresContentGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
contentStringContent ID

Return type

String

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentIdGet** > contentIdGet(id)

Content

This endpoint returns a content by its ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
Integer id = 56; // Integer | Content ID
try {
apiInstance.contentIdGet(id);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentIdGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idIntegerContent ID

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentImportdealPost** > contentImportdealPost(body)

Import a deal

This endpoint imports a deal into the shuttle.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
MainImportDealBody body = new MainImportDealBody(); // MainImportDealBody | Import a deal
try {
apiInstance.contentImportdealPost(body);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentImportdealPost");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
bodyMainImportDealBodyImport a deal

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentListGet** > List<String> contentListGet()

List all pinned content

This endpoint lists all content

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
try {
List<String> result = apiInstance.contentListGet();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentListGet");
e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<String>

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentReadContGet** > contentReadContGet(cont)

Read content

This endpoint reads content from the blockstore

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
String cont = "cont_example"; // String | CID
try {
apiInstance.contentReadContGet(cont);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentReadContGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
contStringCID

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentStagingZonesGet** > contentStagingZonesGet()

Get staging zone for user

This endpoint is used to get staging zone for user.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
try {
apiInstance.contentStagingZonesGet();
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentStagingZonesGet");
e.printStackTrace();
}

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
# **contentStatsGet** > contentStatsGet(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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
String limit = "limit_example"; // String | limit
String offset = "offset_example"; // String | offset
try {
apiInstance.contentStatsGet(limit, offset);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentStatsGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
limitStringlimit
offsetStringoffset

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **contentStatusIdGet** > contentStatusIdGet(id)

Content Status

This endpoint returns the status of a content

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ContentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

ContentApi apiInstance = new ContentApi();
Integer id = 56; // Integer | Content ID
try {
apiInstance.contentStatusIdGet(id);
} catch (ApiException e) {
System.err.println("Exception when calling ContentApi#contentStatusIdGet");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idIntegerContent ID

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

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