Search for Load Balancing resources.
/accounts/{account_identifier}/load_balancers/search
get
Account Load Balancer Search
account-load-balancer-search-search-resources
nullnull[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "search_params",
"schema": {
"properties": {
"query": {
"default": "",
"description": "Search query term.",
"example": "primary",
"type": "string"
},
"references": {
"default": "",
"description": "The type of references to include (\"*\" for all).",
"enum": [
"",
"*",
"referral",
"referrer"
],
"example": "*",
"type": "string"
}
},
"type": "object"
}
},
{
"in": "query",
"name": "page",
"schema": {
"minimum": 1
}
},
{
"in": "query",
"name": "per_page",
"schema": {
"default": 25,
"maximum": 1000,
"minimum": 1
}
}
]null{
"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": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"resources": {
"description": "A list of resources matching the search query.",
"items": {
"description": "A reference to a load balancer resource.",
"properties": {
"reference_type": {
"description": "When listed as a reference, the type (direction) of the reference.",
"enum": [
"referral",
"referrer"
],
"type": "string"
},
"references": {
"description": "A list of references to (referrer) or from (referral) this resource.",
"example": [
{
"reference_type": "referrer",
"resource_id": "699d98642c564d2e855e9661899b7252",
"resource_name": "www.example.com",
"resource_type": "load_balancer"
},
{
"reference_type": "referral",
"resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"resource_name": "Login page monitor",
"resource_type": "monitor"
}
],
"items": {
"description": "A reference to a load balancer resource.",
"type": "object"
},
"type": "array"
},
"resource_id": {
"example": "17b5962d775c646f3f9725cbc7a53df4"
},
"resource_name": {
"description": "The human-identifiable name of the resource.",
"example": "primary-dc-1",
"type": "string"
},
"resource_type": {
"description": "The type of the resource.",
"enum": [
"load_balancer",
"monitor",
"pool"
],
"example": "pool",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Search Resources 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": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"resources": {
"description": "A list of resources matching the search query.",
"items": {
"description": "A reference to a load balancer resource.",
"properties": {
"reference_type": {
"description": "When listed as a reference, the type (direction) of the reference.",
"enum": [
"referral",
"referrer"
],
"type": "string"
},
"references": {
"description": "A list of references to (referrer) or from (referral) this resource.",
"example": [
{
"reference_type": "referrer",
"resource_id": "699d98642c564d2e855e9661899b7252",
"resource_name": "www.example.com",
"resource_type": "load_balancer"
},
{
"reference_type": "referral",
"resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"resource_name": "Login page monitor",
"resource_type": "monitor"
}
],
"items": {
"description": "A reference to a load balancer resource.",
"type": "object"
},
"type": "array"
},
"resource_id": {
"example": "17b5962d775c646f3f9725cbc7a53df4"
},
"resource_name": {
"description": "The human-identifiable name of the resource.",
"example": "primary-dc-1",
"type": "string"
},
"resource_type": {
"description": "The type of the resource.",
"enum": [
"load_balancer",
"monitor",
"pool"
],
"example": "pool",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"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": "Search Resources response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]