/zones/{zone_identifier}/web3/hostnames
post
Web3 Hostname
web3-hostname-create-web3-hostname
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}null[
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"description": {
"description": "An optional description of the hostname.",
"example": "This is my IPFS gateway.",
"maxLength": 500,
"type": "string"
},
"dnslink": {
"description": "DNSLink value used if the target is ipfs.",
"example": "/ipns/onboarding.ipfs.cloudflare.com",
"type": "string"
},
"name": {
"description": "The hostname that will point to the target gateway via CNAME.",
"example": "gateway.example.com",
"maxLength": 255,
"readOnly": true,
"type": "string"
},
"target": {
"description": "Target gateway of the hostname.",
"enum": [
"ethereum",
"ipfs",
"ipfs_universal_path",
"polygon"
],
"example": "ipfs",
"type": "string"
}
},
"required": [
"name",
"target"
],
"type": "object"
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"nullable": true
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"created_on": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of the hostname.",
"example": "This is my IPFS gateway.",
"maxLength": 500,
"type": "string"
},
"dnslink": {
"description": "DNSLink value used if the target is ipfs.",
"example": "/ipns/onboarding.ipfs.cloudflare.com",
"type": "string"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"modified_on": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The hostname that will point to the target gateway via CNAME.",
"example": "gateway.example.com",
"maxLength": 255,
"readOnly": true,
"type": "string"
},
"status": {
"description": "Status of the hostname's activation.",
"enum": [
"active",
"pending",
"deleting",
"error"
],
"example": "active",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Target gateway of the hostname.",
"enum": [
"ethereum",
"ipfs",
"ipfs_universal_path",
"polygon"
],
"example": "ipfs",
"type": "string"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "Create Web3 Hostname response"
},
"4xx": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"nullable": true
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"created_on": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of the hostname.",
"example": "This is my IPFS gateway.",
"maxLength": 500,
"type": "string"
},
"dnslink": {
"description": "DNSLink value used if the target is ipfs.",
"example": "/ipns/onboarding.ipfs.cloudflare.com",
"type": "string"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"modified_on": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The hostname that will point to the target gateway via CNAME.",
"example": "gateway.example.com",
"maxLength": 255,
"readOnly": true,
"type": "string"
},
"status": {
"description": "Status of the hostname's activation.",
"enum": [
"active",
"pending",
"deleting",
"error"
],
"example": "active",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Target gateway of the hostname.",
"enum": [
"ethereum",
"ipfs",
"ipfs_universal_path",
"polygon"
],
"example": "ipfs",
"type": "string"
}
},
"type": "object"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Create Web3 Hostname response failure"
}
}[
{
"api_email": [],
"api_key": []
},
{
"api_token": []
}
]