Offchain Manager
Last updated
Last updated
The Offchain Manager is a backend service that provides a RESTful API for managing offchain ENS subnames. It allows clients to create, update, delete, and retrieve subnames and their associated records.
The full subname to retrieve (e.g., subname.eth)
GET /api/v1/subnames/{fullSubname} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"fullName": "text",
"parentName": "text",
"label": "text",
"texts": {},
"addresses": {},
"metadata": {},
"contenthash": "text",
"namehash": "text"
}DELETE /api/v1/subnames/{fullSubname} HTTP/1.1
Host:
x-auth-token: YOUR_API_KEY
Accept: */*
No content
Subname parent name
Search subnames by label
Current page. Defaults to 1
Page size. Defaults to 25
Search by subname ownership
Search by metadata properties
POST /api/v1/subnames/search HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"parentName": "text",
"labelSearch": "text",
"page": 1,
"size": 1,
"owner": "text",
"metadata": {}
}Returns a paged response of subnames
{
"size": 1,
"page": 1,
"totalItems": 1,
"items": [
{
"id": "text",
"fullName": "text",
"parentName": "text",
"label": "text",
"texts": {},
"addresses": {},
"metadata": {},
"contenthash": "text",
"namehash": "text"
}
]
}Parent ENS name (e.g., oppunk.eth)
Subname label (e.g., alice if full name is alice.oppunk.eth)
Address of the new subname owner (must be a valid Ethereum address)
0x1234...abcdContenthash (e.g., for IPFS/IPNS/Skynet)
ipfs://0xe30101701220eec561a728cb61c29cfae...TTL value in seconds
POST /api/v1/subnames HTTP/1.1
Host:
x-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 253
{
"parentName": "text",
"label": "text",
"texts": [
{
"key": "text",
"value": "text"
}
],
"addresses": [
{
"coin": 1,
"value": "text"
}
],
"metadata": [
{
"key": "text",
"value": "text"
}
],
"owner": "0x1234...abcd",
"contenthash": "ipfs://0xe30101701220eec561a728cb61c29cfae...",
"ttl": 1
}No content