ApiPath
A URI path template defining available operations and endpoints for an API. Paths can be manually defined or imported and synchronized from an OpenAPI specification.
{
"_last_modified": "string",
"description": "string",
"endpoints": [
{
"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"
}
],
"name": "string",
"path_template": "string",
"source": "string",
"tenant_ref": "string",
"unknown_http_method_action": "string",
"url": "string",
"uuid": "string"
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
Description of this API path. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
List of API endpoints for this path. Field introduced in 32.1.4. Maximum of 10 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Name of this object, unique per Tenant. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
The URI path template for the object. Parameters can be defined in curly braces, for example /pet/{pet_id}. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Indicates whether this path was user-defined or imported from an OpenAPI specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
It is a reference to an object of type Tenant. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Action to take when a request matches this path but uses an HTTP method not defined for this path. Overrides the policy-level unknown_http_method_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.
url
The object UUID. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.