×
Home
Stats
Documentation
API Reference
What is Shoggoth?

Shoggoth Node API Reference

Endpoint

GET /api/download/{shoggoth_id}

Description

download a shoggoth resource

Required Headers

Body

NONE


Responses

200 OK

Description

a response containing the resource

Headers

Body

a binary blob containing the resource

302 Found

Description

The resource is not pinned by the current node, but a peer has pinned it so redirect to the peer.

Headers

Location
URL of peer that has pinned the resource

Body

NONE

406 Not Acceptable

Description

a response indicating that the resource was not found

Headers

Body

NONE

Endpoint

GET /api/download/{shoggoth_id}/{label}

Description

download a shoggoth resource with a specified label

Required Headers

Body

NONE


Responses

200 OK

Description

a response containing the resource

Headers

Body

a binary blob containing the resource

302 Found

Description

The resource is not pinned by the current node, but a peer has pinned it so redirect to the peer.

Headers

Location
URL of peer that has pinned the resource

Body

NONE

406 Not Acceptable

Description

a response indicating that the resource was not found

Headers

Body

NONE

Endpoint

GET /api/get_dht

Description

Get the DHT of the node

Required Headers

Body

NONE


Responses

200 OK

Description

response containing the DHT

Headers

Body

the DHT as a JSON string

406 Not Acceptable

Description

an error occured

Headers

Body

the error

Endpoint

GET /api/get_manifest

Description

Get the manifest of the node

Required Headers

Body

NONE


Responses

200 OK

Description

response containing the manifest

Headers

Body

the manifest as a JSON string

406 Not Acceptable

Description

an error occured

Headers

Body

the error

Endpoint

GET /api/get_pins

Description

Get a list of all the pins of the node

Required Headers

Body

NONE


Responses

200 OK

Description

response containing the pins

Headers

Body

the array of pins as a JSON string

406 Not Acceptable

Description

an error occured

Headers

Body

the error