Offchain Manager
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.
Path parameters
fullSubnamestringRequired
The full subname to retrieve (e.g., subname.eth)
Responses
200
Returns the subname details
application/json
400
Bad request - Invalid subname format or length
get
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"
}
Authorizations
Path parameters
fullSubnamestringRequired
Responses
201
Subname deleted successfully
401
Api key not present or invalid
404
Not Found - Subname not found
delete
DELETE /api/v1/subnames/{fullSubname} HTTP/1.1
Host:
x-auth-token: YOUR_API_KEY
Accept: */*
No content
Body
parentNamestringRequired
Subname parent name
labelSearchstringOptional
Search subnames by label
pagenumberOptional
Current page. Defaults to 1
sizenumberOptional
Page size. Defaults to 25
ownerstringOptional
Search by subname ownership
metadataobjectOptional
Search by metadata properties
Responses
200
Returns a paged response of subnames
application/json
post
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": {}
}
200
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"
}
]
}
Authorizations
Body
parentNamestring · min: 7 · max: 255Required
Parent ENS name (e.g., oppunk.eth)
labelstring · min: 1 · max: 255Required
Subname label (e.g., alice if full name is alice.oppunk.eth)
ownerstringOptionalExample:
Address of the new subname owner (must be a valid Ethereum address)
0x1234...abcd
contenthashstringOptionalExample:
Contenthash (e.g., for IPFS/IPNS/Skynet)
ipfs://0xe30101701220eec561a728cb61c29cfae...
ttlnumberOptional
TTL value in seconds
Responses
200
Subname/Updated created successfully
401
Api key not present or invalid
post
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
Last updated