Skip to content

Retrieves a search resource.

GET
/api/search

Retrieves a search resource.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Query Parameters

q*
Type
string
Required
Min Length
2

Responses

search resource

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"organizations": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"organizationId": 0,
  
  
  
"organizationName": "string",
  
  
  
"zoneId": 0,
  
  
  
"zoneName": "string"
  
  
}
  
],
  
"zones": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"organizationId": 0,
  
  
  
"organizationName": "string",
  
  
  
"zoneId": 0,
  
  
  
"zoneName": "string"
  
  
}
  
],
  
"domains": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"organizationId": 0,
  
  
  
"organizationName": "string",
  
  
  
"zoneId": 0,
  
  
  
"zoneName": "string"
  
  
}
  
],
  
"certificates": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"organizationId": 0,
  
  
  
"organizationName": "string",
  
  
  
"zoneId": 0,
  
  
  
"zoneName": "string"
  
  
}
  
],
  
"hostnames": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"organizationId": 0,
  
  
  
"organizationName": "string",
  
  
  
"zoneId": 0,
  
  
  
"zoneName": "string"
  
  
}
  
],
  
"origins": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"organizationId": 0,
  
  
  
"organizationName": "string",
  
  
  
"zoneId": 0,
  
  
  
"zoneName": "string"
  
  
}
  
],
  
"loadBalancers": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"organizationId": 0,
  
  
  
"organizationName": "string",
  
  
  
"zoneId": 0,
  
  
  
"zoneName": "string"
  
  
}
  
],
  
"configurationRules": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"organizationId": 0,
  
  
  
"organizationName": "string",
  
  
  
"zoneId": 0,
  
  
  
"zoneName": "string"
  
  
}
  
],
  
"rewriteRules": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"organizationId": 0,
  
  
  
"organizationName": "string",
  
  
  
"zoneId": 0,
  
  
  
"zoneName": "string"
  
  
}
  
],
  
"accessRules": [
  
  
{
  
  
  
"id": 0,
  
  
  
"name": "string",
  
  
  
"organizationId": 0,
  
  
  
"organizationName": "string",
  
  
  
"zoneId": 0,
  
  
  
"zoneName": "string"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI