Lets you search for locations, autonomous systems (AS) and reports.
/radar/search/global
get
Radar Search
radar-get-search-global
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
} {
"enum": [
"com.cloudflare.api.user.read"
]
} [
{
"in": "query",
"name": "limit",
"schema": {
"description": "Limit the number of objects in the response.",
"example": 5,
"type": "integer"
}
},
{
"in": "query",
"name": "limitPerGroup",
"schema": {
"description": "Limit the number of objects per search category.",
"type": "number"
}
},
{
"in": "query",
"name": "query",
"required": true,
"schema": {
"description": "Search for locations, AS and reports.",
"example": "United",
"type": "string"
}
},
{
"in": "query",
"name": "include",
"schema": {
"description": "Search types to be included in results.",
"items": {
"enum": [
"SPECIAL_EVENTS",
"NOTEBOOKS",
"LOCATIONS",
"ASNS"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "exclude",
"schema": {
"description": "Search types to be excluded from results.",
"items": {
"enum": [
"SPECIAL_EVENTS",
"NOTEBOOKS",
"LOCATIONS",
"ASNS"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "format",
"schema": {
"description": "Format results are returned in.",
"enum": [
"JSON",
"CSV"
],
"example": "json",
"type": "string"
}
}
] null {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"properties": {
"search": {
"items": {
"properties": {
"code": {
"example": "13335",
"type": "string"
},
"name": {
"example": "Cloudflare",
"type": "string"
},
"type": {
"example": "asn",
"type": "string"
}
},
"required": [
"code",
"name",
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"search"
],
"type": "object"
},
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"result",
"success"
],
"type": "object"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"result": {
"type": "object"
},
"success": {
"example": false,
"type": "boolean"
}
},
"required": [
"result",
"success",
"errors"
],
"type": "object"
}
}
},
"description": "Bad Request"
}
} [
{
"api_email": [],
"api_key": []
}
]