Download OpenAPI specification:Download
A list of the currently provided Interfaces to interact with the boson, implementing file operations and sending messages
| Role | string |
| Expiry | integer |
{- "Role": "string",
- "Expiry": 0
}{- "Key": "string"
}| pin | boolean Represents the pinning state of the chunk |
| encrypt | boolean Represents the encrypting state of the file |
{- "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}| pin | boolean Represents the pinning state of the chunk |
{- "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
} required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of chunk |
| targets | string Global pinning targets prefix |
"string"In order to upload a collection, user can send a multipart request with all the files populated in the form data with appropriate headers.
User can also upload a tar file along with the collection header. This will upload the tar file after extracting the entire directory structure.
If the collection header is absent, all requests (including tar files) are considered as single file uploads.
A multipart request is treated as a collection regardless of whether the collection header is present. This means in order to serve single files uploaded as a multipart request, the index-document header should be used with the name of the file.
| pin | boolean Represents the pinning state of the chunk |
| encrypt | boolean Represents the encrypting state of the file |
| content-type | string The specified content-type is preserved for download of the asset |
| collection | boolean Upload file/files as a collection |
| index-document | string Example: index.html Default file to be referenced on path, if exists under that path |
| error-document | string Example: error.html Configure custom error document to be returned when a specified path can not be found in collection |
| reference-link | string Example: xxx://xxx Configure third-party storage reference links |
| file | Array of strings <binary> |
{- "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}| filter | string Example: filter=[ { "key": "FieldName","term": "eq","value": "false" } ] |
| page required | string Example: page={ "pageNum": 1, "pageSize": 10 } |
| sort | string Example: sort={ "key": "FieldName", "order": "desc" } |
{- "total": 0,
- "list": [
- {
- "rootCid": "string",
- "size": 0,
- "fileSize": 0,
- "pinState": true,
- "bitVector": {
- "len": 0,
- "b": "string"
}, - "register": true,
- "manifest": {
- "type": "string",
- "hash": {
- "hash": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}, - "name": "string",
- "size": 0,
- "ext": "string",
- "mime": "string",
- "sub": { }
}
}
]
} required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
| targets | string Global pinning targets prefix |
"string" required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
| path | string An exist path in the collection. If the path point to a directory, path must end with slash. |
{- "type": "string",
- "hash": {
- "hash": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}, - "name": "string",
- "size": 0,
- "ext": "string",
- "mime": "string",
- "sub": { }
} required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
{- "hash": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
} required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
{- "hash": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}In order to upload a collection, user can send a multipart request with all the files populated in the form data with appropriate headers.
User can also upload a tar file along with the collection header. This will upload the tar file after extracting the entire directory structure.
If the collection header is absent, all requests (including tar files) are considered as single file uploads.
A multipart request is treated as a collection regardless of whether the collection header is present. This means in order to serve single files uploaded as a multipart request, the index-document header should be used with the name of the file.
| pin | boolean Represents the pinning state of the chunk |
| encrypt | boolean Represents the encrypting state of the file |
| content-type | string The specified content-type is preserved for download of the asset |
| collection | boolean Upload file/files as a collection |
| index-document | string Example: index.html Default file to be referenced on path, if exists under that path |
| error-document | string Example: error.html Configure custom error document to be returned when a specified path can not be found in collection |
| reference-link | string Example: xxx://xxx Configure third-party storage reference links |
| file | Array of strings <binary> |
{- "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
} required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
| targets | string Global pinning targets prefix |
"string" required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
| path required | string Path to the file in the collection. |
| targets | string Global pinning targets prefix |
"string" required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
| path | string An exist path in the collection. If the path point to a directory, path must end with slash. |
{- "type": "string",
- "hash": {
- "hash": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}, - "name": "string",
- "size": 0,
- "ext": "string",
- "mime": "string",
- "sub": { }
} required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
{- "hash": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
} required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
{- "hash": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
} required | BosonAddress (string) or BosonEncryptedReference (string) (BosonOnlyReference) Boson reference of the root hash |
{- "message": "string",
- "code": 0
} required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
{- "message": "string",
- "code": 0
} required | BosonAddress (string) or BosonEncryptedReference (string) (BosonOnlyReference) Boson reference of the root hash |
"36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"{- "peer": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
- "outstandingTraffic": 0,
- "sendTraffic": 0,
- "receivedTraffic": 0,
- "total": 0,
- "unCashed": 0
} required | BosonAddress (string) or BosonEncryptedReference (string) or DomainName (string) (BosonReference) Boson address of content |
{- "hash": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}| gid required | string (BosonAddress) ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f group address or name |
| name | string group name |
| type | number 0 join group, 1 observe group |
| keep-connected-peers | number the param must |
| keep-ping-peers | number the param must |
| nodes | Array of any |
{- "name": "string",
- "type": 0,
- "keep-connected-peers": 0,
- "keep-ping-peers": 0,
- "nodes": [
- "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
]
}{- "message": "string",
- "code": 0
}| gid required | string (BosonAddress) ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f group address |
{- "message": "string",
- "code": 0
}| gid required | string (BosonAddress) ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f group address or name |
| name | string group name |
| type | number 0 join group, 1 observe group |
| keep-connected-peers | number the param must |
| keep-ping-peers | number the param must |
| nodes | Array of any |
{- "name": "string",
- "type": 0,
- "keep-connected-peers": 0,
- "keep-ping-peers": 0,
- "nodes": [
- "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
]
}{- "message": "string",
- "code": 0
}| gid required | string (BosonAddress) ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f group address |
{- "message": "string",
- "code": 0
}| gid required | string (BosonAddress) ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f group address |
{ }{- "message": "string",
- "code": 0
}| gid required | string (BosonAddress) ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f group address |
| target required | string (BosonAddress) ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f target address |
{ }{- "data": "string"
}| gid required | string (BosonAddress) ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f group address |
| target required | string (BosonAddress) ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f target address |
{ }{- "message": "string",
- "code": 0
}| gid required | string (BosonAddress) ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f group address |
{- "connected": [
- "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
], - "keep": [
- "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
]
}