Fetches a list of all categories.
/accounts/{account_id}/gateway/categories
get
Zero Trust Gateway categories
zero-trust-gateway-categories-list-categories
nullnull[
{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]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": {
"items": {
"properties": {
"beta": {
"description": "True if the category is in beta and subject to change.",
"example": false,
"type": "boolean"
},
"class": {
"description": "Which account types are allowed to create policies based on this category. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked.",
"enum": [
"free",
"premium",
"blocked",
"removalPending",
"noBlock"
],
"example": "premium",
"type": "string"
},
"description": {
"description": "A short summary of domains in the category.",
"example": "Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.",
"type": "string"
},
"id": {
"description": "The identifier for this category. There is only one category per ID.",
"type": "integer"
},
"name": {
"description": "The name of the category.",
"example": "Education",
"type": "string"
},
"subcategories": {
"description": "All subcategories for this category.",
"items": {
"properties": {
"beta": {
"description": "True if the category is in beta and subject to change.",
"example": false,
"type": "boolean"
},
"class": {
"description": "Which account types are allowed to create policies based on this category. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked.",
"enum": [
"free",
"premium",
"blocked",
"removalPending",
"noBlock"
],
"example": "premium",
"type": "string"
},
"description": {
"description": "A short summary of domains in the category.",
"example": "Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.",
"type": "string"
},
"id": {
"description": "The identifier for this category. There is only one category per ID.",
"type": "integer"
},
"name": {
"description": "The name of the category.",
"example": "Education",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"readOnly": true,
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "List categories 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": {
"items": {
"properties": {
"beta": {
"description": "True if the category is in beta and subject to change.",
"example": false,
"type": "boolean"
},
"class": {
"description": "Which account types are allowed to create policies based on this category. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked.",
"enum": [
"free",
"premium",
"blocked",
"removalPending",
"noBlock"
],
"example": "premium",
"type": "string"
},
"description": {
"description": "A short summary of domains in the category.",
"example": "Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.",
"type": "string"
},
"id": {
"description": "The identifier for this category. There is only one category per ID.",
"type": "integer"
},
"name": {
"description": "The name of the category.",
"example": "Education",
"type": "string"
},
"subcategories": {
"description": "All subcategories for this category.",
"items": {
"properties": {
"beta": {
"description": "True if the category is in beta and subject to change.",
"example": false,
"type": "boolean"
},
"class": {
"description": "Which account types are allowed to create policies based on this category. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked.",
"enum": [
"free",
"premium",
"blocked",
"removalPending",
"noBlock"
],
"example": "premium",
"type": "string"
},
"description": {
"description": "A short summary of domains in the category.",
"example": "Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.",
"type": "string"
},
"id": {
"description": "The identifier for this category. There is only one category per ID.",
"type": "integer"
},
"name": {
"description": "The name of the category.",
"example": "Education",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"readOnly": true,
"type": "object"
},
"type": "array"
}
}
}
]
},
{
"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": "List categories response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]