ApiEndpoint
A single API operation identified by an HTTP method on a path template. Defines validation parameters, request/response body schemas, and endpoint-level label overrides.
{
"active_api_labels": {
"enabled": false,
"labels": [
"string"
]
},
"deactivated": false,
"description": "string",
"failed_validation_header_parameter_action": "string",
"failed_validation_path_parameter_action": "string",
"failed_validation_query_parameter_action": "string",
"header_parameters": [
{
"allow_empty_value": false,
"deprecated": false,
"name": "string",
"required": false,
"schema": {
"max_value": "number",
"min_value": "number",
"schema_ref": "string",
"string_enum_values": [
"string"
],
"string_format": "string",
"string_max_length": 0,
"string_min_length": 0,
"string_pattern": "string",
"type": "string"
}
}
],
"http_method": "string",
"override_global_active_api_labels": false,
"path_parameters": [
{
"allow_empty_value": false,
"deprecated": false,
"name": "string",
"required": false,
"schema": {
"max_value": "number",
"min_value": "number",
"schema_ref": "string",
"string_enum_values": [
"string"
],
"string_format": "string",
"string_max_length": 0,
"string_min_length": 0,
"string_pattern": "string",
"type": "string"
}
}
],
"query_parameters": [
{
"allow_empty_value": false,
"deprecated": false,
"name": "string",
"required": false,
"schema": {
"max_value": "number",
"min_value": "number",
"schema_ref": "string",
"string_enum_values": [
"string"
],
"string_format": "string",
"string_max_length": 0,
"string_min_length": 0,
"string_pattern": "string",
"type": "string"
}
}
],
"request_body": {
"description": "string",
"failed_validation_request_body_action": "string",
"mappings": [
{
"content_type": "string",
"schema": {
"max_value": "number",
"min_value": "number",
"schema_ref": "string",
"string_enum_values": [
"string"
],
"string_format": "string",
"string_max_length": 0,
"string_min_length": 0,
"string_pattern": "string",
"type": "string"
}
}
],
"required": false,
"unknown_content_type_action": "string"
},
"responses": [
{
"content_type_mappings": [
{
"content_type": "string",
"schema": {
"max_value": "number",
"min_value": "number",
"schema_ref": "string",
"string_enum_values": [
"string"
],
"string_format": "string",
"string_max_length": 0,
"string_min_length": 0,
"string_pattern": "string",
"type": "string"
}
}
],
"description": "string",
"response_header_parameters": [
{
"allow_empty_value": false,
"deprecated": false,
"name": "string",
"required": false,
"schema": {
"max_value": "number",
"min_value": "number",
"schema_ref": "string",
"string_enum_values": [
"string"
],
"string_format": "string",
"string_max_length": 0,
"string_min_length": 0,
"string_pattern": "string",
"type": "string"
}
}
],
"status_code": {
"match_criteria": "string",
"ranges": [
{
"begin": 0,
"end": 0
}
],
"status_codes": [
0
]
},
"unknown_content_type_action": "string"
}
],
"type": "string",
"unknown_status_code_action": "string"
}Configuration of labels applied to endpoints belonging to a specific classification category, such as active or orphan.
Endpoint definition is deactivated. When true, this endpoint will not be validated, learned, or labeled. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Describes the functionality of the API endpoint. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Action on header parameter schema validation failures. Overrides the policy-level failed_validation_header_parameter_action when not INHERIT. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Action on path parameter value validation failures (e.g., type mismatch). Path parameters are value-only (key is defined by the path template), so this covers schema violations, not unknown keys. Overrides the policy-level failed_validation_path_parameter_action when not INHERIT. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Action on query parameter schema validation failures. Overrides the policy-level failed_validation_query_argument_action when not INHERIT. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Request header parameter definitions for this endpoint, used to validate incoming request headers. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
HTTP method for this API endpoint. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
When true, only the endpoint-level active_api_labels are applied to this endpoint, ignoring the global active_api_labels defined in ApiPolicy. When false (default), endpoint-level and global active_api_labels are applied in conjunction. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Path parameter definitions for this endpoint, used for schema validation. Names must match the placeholders in the path template. Example for path /pets/{petId}, a path parameter named 'petId' would be listed here. Field introduced in 32.1.4. Maximum of 32 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Query string parameter definitions for this endpoint, used to validate query arguments. Example for GET /pets?limit=10, a query parameter named 'limit' would be listed here. Field introduced in 32.1.4. Maximum of 128 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Specification of the expected request body format, accepted content types, associated schemas, and requirement status for an operation.
Expected response definitions for this endpoint, each associated with an HTTP status code or status code range. Field introduced in 32.1.4. Maximum of 32 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Configured lifecycle type of this endpoint. Active endpoints are expected to receive traffic; orphan endpoints have not been seen for a predefined duration; zombie endpoints receive only drip-traffic from legacy clients. Defaults to active. Enum options - API_TYPE_ACTIVE, API_TYPE_ORPHAN, API_TYPE_ZOMBIE. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Action to take on an unknown status code. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.