Retrieve the most up to date view of discovered operations
/zones/{zone_id}/api_gateway/discovery/operations
get
API Shield API Discovery
api-shield-api-discovery-retrieve-discovered-operations-on-a-zone
nullnull[
{
"in": "path",
"name": "zone_id",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"description": "Page number of paginated results.",
"in": "query",
"name": "page",
"schema": {
"default": 1,
"minimum": 1
}
},
{
"description": "Maximum number of results per page.",
"in": "query",
"name": "per_page",
"schema": {
"default": 20,
"maximum": 50,
"minimum": 5
}
},
{
"in": "query",
"name": "host",
"schema": {
"description": "Filter results to only include the specified hosts.",
"items": {
"example": "api.cloudflare.com",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
{
"in": "query",
"name": "method",
"schema": {
"description": "Filter results to only include the specified HTTP methods.",
"items": {
"example": "GET",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
{
"in": "query",
"name": "endpoint",
"schema": {
"description": "Filter results to only include endpoints containing this pattern.",
"example": "/api/v1",
"type": "string"
}
},
{
"in": "query",
"name": "direction",
"schema": {
"description": "Direction to order results.",
"enum": [
"asc",
"desc"
],
"example": "desc",
"type": "string"
}
},
{
"in": "query",
"name": "order",
"schema": {
"description": "Field to order by",
"enum": [
"host",
"method",
"endpoint",
"traffic_stats.requests",
"traffic_stats.last_updated"
],
"example": "method",
"type": "string"
}
},
{
"in": "query",
"name": "diff",
"schema": {
"description": "When `true`, only return API Discovery results that are not saved into API Shield Endpoint Management",
"type": "boolean"
}
},
{
"description": "Filter results to only include discovery results sourced from a particular discovery engine\n * `ML` - Discovered operations that were sourced using ML API Discovery\n * `SessionIdentifier` - Discovered operations that were sourced using Session Identifier API Discovery\n",
"in": "query",
"name": "origin",
"schema": {
"description": "* `ML` - Discovered operation was sourced using ML API Discovery * `SessionIdentifier` - Discovered operation was sourced using Session Identifier API Discovery\n",
"enum": [
"ML",
"SessionIdentifier"
],
"type": "string"
}
},
{
"description": "Filter results to only include discovery results in a particular state. States are as follows\n * `review` - Discovered operations that are not saved into API Shield Endpoint Management\n * `saved` - Discovered operations that are already saved into API Shield Endpoint Management\n * `ignored` - Discovered operations that have been marked as ignored\n",
"in": "query",
"name": "state",
"schema": {
"description": "State of operation in API Discovery\n * `review` - Operation is not saved into API Shield Endpoint Management\n * `saved` - Operation is saved into API Shield Endpoint Management\n * `ignored` - Operation is marked as ignored\n",
"enum": [
"review",
"saved",
"ignored"
],
"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",
"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": {
"anyOf": [
{
"allOf": [
{
"properties": {
"features": {
"anyOf": [
{
"properties": {
"traffic_stats": {
"properties": {
"last_updated": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"period_seconds": {
"description": "The period in seconds these statistics were computed over",
"example": 3600,
"readOnly": true,
"type": "integer"
},
"requests": {
"description": "The average number of requests seen during this period",
"example": 1987.06,
"format": "float",
"readOnly": true,
"type": "number"
}
},
"required": [
"period_seconds",
"requests",
"last_updated"
],
"type": "object"
}
},
"readOnly": true,
"type": "object"
}
],
"type": "object"
},
"id": {
"description": "UUID identifier",
"example": "0d9bf70c-92e1-4bb3-9411-34a3bcc59003",
"format": "uuid",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"last_updated": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"origin": {
"description": "API discovery engine(s) that discovered this operation",
"items": {
"description": "* `ML` - Discovered operation was sourced using ML API Discovery * `SessionIdentifier` - Discovered operation was sourced using Session Identifier API Discovery\n",
"enum": [
"ML",
"SessionIdentifier"
],
"type": "string"
},
"type": "array"
},
"state": {
"description": "State of operation in API Discovery\n * `review` - Operation is not saved into API Shield Endpoint Management\n * `saved` - Operation is saved into API Shield Endpoint Management\n * `ignored` - Operation is marked as ignored\n",
"enum": [
"review",
"saved",
"ignored"
],
"type": "string"
}
},
"required": [
"id",
"last_updated",
"state",
"origin"
]
},
{
"properties": {
"endpoint": {
"description": "The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.",
"example": "/api/v1/users/{var1}",
"format": "uri-template",
"maxLength": 4096,
"pattern": "^/.*$",
"type": "string"
},
"host": {
"description": "RFC3986-compliant host.",
"example": "www.example.com",
"format": "hostname",
"maxLength": 255,
"type": "string"
},
"method": {
"description": "The HTTP method used to access the endpoint.",
"enum": [
"GET",
"POST",
"HEAD",
"OPTIONS",
"PUT",
"DELETE",
"CONNECT",
"PATCH",
"TRACE"
],
"example": "GET",
"type": "string"
}
},
"required": [
"method",
"host",
"endpoint"
],
"type": "object"
}
],
"type": "object"
}
]
},
"type": "array"
}
}
}
]
}
}
},
"description": "Retrieve discovered operations on a zone response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"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": {
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Retrieve discovered operations on a zone response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]