ContentApi
All URIs are relative to **
| 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 |
contentAddCarPost
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
contentAddCarPost ignore-dupes=value filename=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | string | Car | |
| ignoreDupes | string | Ignore Dupes | [optional] |
| filename | string | Filename | [optional] |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentAddIpfsPost
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
contentAddIpfsPost ignore-dupes=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Util.ContentAddIpfsBody | IPFS Body | |
| ignoreDupes | string | Ignore Dupes | [optional] |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentAddPost
Add new content
This endpoint is used to upload new content.
Example
contentAddPost coluuid=value replication=value ignore-dupes=value lazy-provide=value dir=value
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
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentAggregatedContentGet
Get aggregated content stats
This endpoint returns aggregated content stats
Example
contentAggregatedContentGet content=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| content | string | Content ID |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentAllDealsGet
Get all deals for a user
This endpoint is used to get all deals for a user
Example
contentAllDealsGet begin=value duration=value all=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| begin | string | Begin | |
| duration | string | Duration | |
| all | string | All |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentBwUsageContentGet
Get content bandwidth
This endpoint returns content bandwidth
Example
contentBwUsageContentGet content=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| content | string | Content ID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentCreatePost
Add a new content
This endpoint adds a new content
Example
contentCreatePost ignore-dupes=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | Util.ContentCreateBody | Content | |
| ignoreDupes | string | Ignore Dupes | [optional] |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentDealsGet
Content with deals
This endpoint lists all content with deals
Example
contentDealsGet limit=value offset=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | integer | Limit | [optional] |
| offset | integer | Offset | [optional] |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentEnsureReplicationDatacidGet
Ensure Replication
This endpoint ensures that the content is replicated to the specified number of providers
Example
contentEnsureReplicationDatacidGet datacid=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| datacid | string | Data CID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentFailuresContentGet
List all failures for a content
This endpoint returns all failures for a content
Example
contentFailuresContentGet content=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| content | string | Content ID |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentIdGet
Content
This endpoint returns a content by its ID
Example
contentIdGet id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | Content ID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentImportdealPost
Import a deal
This endpoint imports a deal into the shuttle.
Example
contentImportdealPost
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Main.importDealBody | Import a deal |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentListGet
List all pinned content
This endpoint lists all content
Example
contentListGet
Parameters
This endpoint does not need any parameter.
Return type
array[string]
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentReadContGet
Read content
This endpoint reads content from the blockstore
Example
contentReadContGet cont=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cont | string | CID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentStagingZonesGet
Get staging zone for user
This endpoint is used to get staging zone for user.
Example
contentStagingZonesGet
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentStatsGet
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
contentStatsGet limit=value offset=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | string | limit | |
| offset | string | offset |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
contentStatusIdGet
Content Status
This endpoint returns the status of a content
Example
contentStatusIdGet id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | Content ID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]