Gets a Worker domain.
/accounts/{account_identifier}/workers/domains/{domain_identifier}
get
Worker Domain
worker-domain-get-a-domain
null{
"enum": [
"com.cloudflare.edge.worker.domain.read"
]
}[
{
"in": "path",
"name": "domain_identifier",
"required": true,
"schema": {
"description": "Identifer of the Worker Domain.",
"example": "dbe10b4bc17c295377eabd600e1787fd"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"example": "9a7806061c88ada191ed06f989cc3dac"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"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": {
"properties": {
"environment": {
"description": "Worker environment associated with the zone and hostname.",
"example": "production",
"type": "string"
},
"hostname": {
"description": "Hostname of the Worker Domain.",
"example": "foo.example.com",
"type": "string"
},
"id": {
"description": "Identifer of the Worker Domain.",
"example": "dbe10b4bc17c295377eabd600e1787fd"
},
"service": {
"description": "Worker service associated with the zone and hostname.",
"example": "foo",
"type": "string"
},
"zone_id": {
"description": "Identifier of the zone.",
"example": "593c9c94de529bbbfaac7c53ced0447d"
},
"zone_name": {
"description": "Name of the zone.",
"example": "example.com",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Get a Domain response"
},
"4XX": {
"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": {
"properties": {
"environment": {
"description": "Worker environment associated with the zone and hostname.",
"example": "production",
"type": "string"
},
"hostname": {
"description": "Hostname of the Worker Domain.",
"example": "foo.example.com",
"type": "string"
},
"id": {
"description": "Identifer of the Worker Domain.",
"example": "dbe10b4bc17c295377eabd600e1787fd"
},
"service": {
"description": "Worker service associated with the zone and hostname.",
"example": "foo",
"type": "string"
},
"zone_id": {
"description": "Identifier of the zone.",
"example": "593c9c94de529bbbfaac7c53ced0447d"
},
"zone_name": {
"description": "Name of the zone.",
"example": "example.com",
"type": "string"
}
},
"type": "object"
}
},
"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": "Get a Domain response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]