ContentApi
All URIs are relative to https://api.estuary.tech
Method | HTTP request | Description |
---|---|---|
contentAddCarPost | POST /content/add-car | Add Car object |
contentAddIpfsPost | POST /content/add-ipfs | Add IPFS object |
contentAddPost | POST /content/add | Add new content |
contentAggregatedContentGet | GET /content/aggregated/{content} | Get aggregated content stats |
contentAllDealsGet | GET /content/all-deals | Get all deals for a user |
contentBwUsageContentGet | GET /content/bw-usage/{content} | Get content bandwidth |
contentCreatePost | POST /content/create | Add a new content |
contentDealsGet | GET /content/deals | Content with deals |
contentEnsureReplicationDatacidGet | GET /content/ensure-replication/{datacid} | Ensure Replication |
contentFailuresContentGet | GET /content/failures/{content} | List all failures for a content |
contentIdGet | GET /content/{id} | Content |
contentImportdealPost | POST /content/importdeal | Import a deal |
contentListGet | GET /content/list | List all pinned content |
contentReadContGet | GET /content/read/{cont} | Read content |
contentStagingZonesGet | GET /content/staging-zones | Get staging zone for user |
contentStatsGet | GET /content/stats | Get content statistics |
contentStatusIdGet | GET /content/status/{id} | Content Status |
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
Name | Type | Description | Notes |
---|---|---|---|
body | String | Car | |
ignoreDupes | String | Ignore Dupes | [optional] |
filename | String | Filename | [optional] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
body | UtilContentAddIpfsBody | IPFS Body | |
ignoreDupes | String | Ignore Dupes | [optional] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
data | File | File to upload | |
filename | String | Filenam to use for upload | [optional] |
coluuid | String | Collection UUID | [optional] |
replication | Integer | Replication value | [optional] |
ignoreDupes | String | Ignore Dupes true/false | [optional] |
lazyProvide | String | Lazy Provide true/false | [optional] |
dir | String | Directory | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
content | String | Content ID |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
begin | String | Begin | |
duration | String | Duration | |
all | String | All |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
content | String | Content ID |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
req | UtilContentCreateBody | Content | |
ignoreDupes | String | Ignore Dupes | [optional] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
limit | Integer | Limit | [optional] |
offset | Integer | Offset | [optional] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
datacid | String | Data CID |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
content | String | Content ID |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | Content ID |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
body | MainImportDealBody | Import a deal |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
cont | String | CID |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
limit | String | limit | |
offset | String | offset |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
Name | Type | Description | Notes |
---|---|---|---|
id | Integer | Content ID |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json