Download OpenAPI specification:Download
A list of the currently provided Interfaces to interact with the swarm, implementing file operations and sending messages
swarm-tag | integer Associate upload with an existing Tag UID |
swarm-pin | boolean Represents the pinning state of the chunk |
swarm-encrypt | boolean Represents the encrypting state of the file |
{- "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}
swarm-tag | integer Associate upload with an existing Tag UID |
swarm-pin | boolean Represents the pinning state of the chunk |
{- "status": "string"
}
name | string Filename |
swarm-tag | integer Associate upload with an existing Tag UID |
swarm-pin | boolean Represents the pinning state of the chunk |
swarm-encrypt | boolean Represents the encrypting state of the file |
Content-Type | string The specified content-type is preserved for download of the asset |
file | Array of strings <binary> |
{- "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}
swarm-tag | integer Associate upload with an existing Tag UID |
swarm-pin | boolean Represents the pinning state of the chunk |
swarm-encrypt | boolean Represents the encrypting state of the file |
swarm-index-document | string Example: index.html Default file to be referenced on path, if exists under that path |
swarm-error-document | string Example: error.html Configure custom error document to be returned when a specified path can not be found in collection |
Content-Type | string The specified content-type is preserved for download of the asset |
{- "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}
required | string or string or string Swarm address of content |
path required | string Path to the file in the collection. |
targets | string Global pinning targets prefix |
"string"
address required | string ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f Swarm address of chunk |
{- "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
- "pinCounter": 0
}
address required | string ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f Swarm address of chunk |
{- "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
- "pinCounter": 0
}
offset | integer >= 0 Default: 0 The number of items to skip before starting to collect the result set. |
limit | integer [ 1 .. 1000 ] Default: 100 The numbers of items to return. |
{- "chunks": [
- {
- "address": "string",
- "pinCounter": 0
}
]
}
address required | string ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f Swarm address of the bytes |
{- "message": "string",
- "code": 0
}
address required | string ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f Swarm address of the bytes |
{- "message": "string",
- "code": 0
}
address required | string ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f Swarm address of the file |
{- "message": "string",
- "code": 0
}
address required | string ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f Swarm address of the collection |
{- "message": "string",
- "code": 0
}
address required | string ^[A-Fa-f0-9]{64}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f Swarm address of the collection |
{- "message": "string",
- "code": 0
}
topic required | string Topic name |
targets required | string Target message address prefix. If multiple targets are specified, only one would be matched. |
recipient | string Recipient publickey |
"string"
owner required | string ^[A-Fa-f0-9]{40}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906 Owner |
id required | string ^([A-Fa-f0-9]+)$ Example: cf880b8eeac5093fa27b0825906c600685 Id |
sig required | string ^([A-Fa-f0-9]+)$ Example: sig=cf880b8eeac5093fa27b0825906c600685 Signature |
swarm-pin | boolean Represents the pinning state of the chunk |
{- "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}
owner required | string ^[A-Fa-f0-9]{40}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906 Owner |
topic required | string ^([A-Fa-f0-9]+)$ Example: cf880b8eeac5093fa27b0825906c600685 Topic |
type | string ^(sequence|epoch)$ Feed indexing scheme (default: sequence) |
swarm-pin | boolean Represents the pinning state of the chunk |
{- "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}
owner required | string ^[A-Fa-f0-9]{40}$ Example: 36b7efd913ca4cf880b8eeac5093fa27b0825906 Owner |
topic required | string ^([A-Fa-f0-9]+)$ Example: cf880b8eeac5093fa27b0825906c600685 Topic |
at | integer Timestamp of the update (default: now) |
type | string ^(sequence|epoch)$ Feed indexing scheme (default: sequence) |
{- "reference": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"
}