/zones/{zone_id}/api_gateway/schemas
get
API Shield Endpoint Management
api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas
nullnull[
{
"in": "path",
"name": "zone_id",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "host",
"schema": {
"description": "Receive schema only for the given host(s).",
"items": {
"example": "www.example.com",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
{
"description": "Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.",
"in": "query",
"name": "feature",
"schema": {
"example": [
"thresholds"
],
"items": {
"enum": [
"thresholds",
"parameter_schemas",
"schema_info"
],
"example": "thresholds",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
}
]null{
"200": {
"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",
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
}
]
},
{
"properties": {
"result": {
"properties": {
"schemas": {
"items": {
"description": "A OpenAPI 3.0.0 compliant schema.",
"example": {
"info": {
"title": "OpenAPI JSON schema for www.example.com",
"version": "1.0"
},
"openapi": "3.0.0",
"paths": {
"... Further paths ...": {},
"/api/v1/users/{var1}": {
"get": {
"parameters": [
{
"in": "path",
"name": "var1",
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
},
"servers": [
{
"url": "www.example.com"
}
]
},
"type": "object"
},
"type": "array"
},
"timestamp": {
"type": "string"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "Retrieve operations and features as OpenAPI schemas response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"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",
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
}
]
},
{
"properties": {
"result": {
"properties": {
"schemas": {
"items": {
"description": "A OpenAPI 3.0.0 compliant schema.",
"example": {
"info": {
"title": "OpenAPI JSON schema for www.example.com",
"version": "1.0"
},
"openapi": "3.0.0",
"paths": {
"... Further paths ...": {},
"/api/v1/users/{var1}": {
"get": {
"parameters": [
{
"in": "path",
"name": "var1",
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
},
"servers": [
{
"url": "www.example.com"
}
]
},
"type": "object"
},
"type": "array"
},
"timestamp": {
"type": "string"
}
},
"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": {
"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 operations and features as OpenAPI schemas response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]